debian man page for tm::analysis

TM::Analysis(3pm)					User Contributed Perl Documentation					 TM::Analysis(3pm)

NAME
       TM::Analysis - Topic Maps, analysis functions

SYNOPSIS
	 use TM::Materialized::AsTMa;
	 my $tm = new TM::Materialized::AsTMa (file => 'test.atm');
	 $tm->sync_in;

	 Class::Trait->apply ($tm, 'TM::Analysis');

	 print Dumper $tm->statistics;

	 print Dumper $tm->orphanage;

DESCRIPTION
       This package contains some topic map analysis functionality.

INTERFACE
       statistics
	   This (currently quite limited) function computes a reference to hash containing the following fields:

	   "nr_toplets"
	       Nr of midlets in the map. This includes ALL midlets for topics and also those for assertions.

	   "nr_asserts"
	       Nr of assertions in the map.

	   "nr_clusters"
	       Nr of clusters according to the "cluster" function elsewhere in this document.

       orphanage
	   This computes all topics which have either no supertype and also those which have no type. Without further parameters, it returns a
	   hash reference with the following fields:

	   "untyped"
	       Holds a list reference to all topic ids which have no type.

	   "empty"
	       Holds a list reference to all topic ids which have no instance.

	   "unclassified"
	       Holds a list reference to all topic ids which have no superclass.

	   "unspecified"
	       Holds a list reference to all topic ids which have no subclass.

	   Optionally, a list of the identifiers above can be passed in so that only that particular information is actually returned (some
	   speedup):

	      my $o = TM::Analysis::orphanage ($tm, 'untyped');

       entropy
	   This method returns a hash (reference) where the keys are the assertion types and the values are the individual entropies of these
	   assertion types. More frequently used (inflationary) types will have a lower value, very seldomly used ones too. Only those in the
	   middle count most.

SEE ALSO
       TM

COPYRIGHT AND LICENSE
       Copyright 20(0[3-68]|10) by Robert Barta, <drrho@cpan.org>

       This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

perl v5.10.1							    2010-06-06							 TM::Analysis(3pm)