Ken Williams > AI-Categorizer-0.09 > AI::Categorizer::Category

Download:
AI-Categorizer-0.09.tar.gz

Dependencies

Annotate this POD (1)

CPAN RT

New  3
Open  4
View/Report Bugs
Source  

NAME ^

AI::Categorizer::Category - A named category of documents

SYNOPSIS ^

  my $category = AI::Categorizer::Category->by_name("sports");
  my $name = $category->name;
  
  my @docs = $category->documents;
  my $num_docs = $category->documents;
  my $features = $category->features;
  
  $category->add_document($doc);
  if ($category->contains_document($doc)) { ...

DESCRIPTION ^

This simple class represents a named category which may contain zero or more documents. Each category is a "singleton" by name, so two Category objects with the same name should not be created at once.

METHODS ^

new()

Creates a new Category object and returns it. Accepts the following parameters:

name

The name of this category

documents

A reference to an array of Document objects that should belong to this category.

by_name(name => $string)

Returns the Category object with the given name, or creates one if no such object exists.

documents()

Returns a list of the Document objects in this category in a list context, or the number of such objects in a scalar context.

features()

Returns a FeatureVector object representing the sum of all the FeatureVectors of the Documents in this Category.

add_document($document)

Informs the Category that the given Document belongs to it.

contains_document($document)

Returns true if the given document belongs to this category, or false otherwise.

AUTHOR ^

Ken Williams, ken@mathforum.org

COPYRIGHT ^

Copyright 2000-2003 Ken Williams. All rights reserved.

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

SEE ALSO ^

AI::Categorizer(3), Storable(3)

syntax highlighting: