gov.sandia.cognition.learning.function.categorization
Class AbstractCategorizer<InputType,CategoryType>

java.lang.Object
  extended by gov.sandia.cognition.util.AbstractCloneableSerializable
      extended by gov.sandia.cognition.learning.function.categorization.AbstractCategorizer<InputType,CategoryType>
Type Parameters:
InputType - The type of the input the categorizer can use.
CategoryType - The type of category output by the categorizer.
All Implemented Interfaces:
Evaluator<InputType,CategoryType>, Categorizer<InputType,CategoryType>, CloneableSerializable, Serializable, Cloneable
Direct Known Subclasses:
AbstractDiscriminantCategorizer, EvaluatorToCategorizerAdapter, WeightedVotingCategorizerEnsemble

public abstract class AbstractCategorizer<InputType,CategoryType>
extends AbstractCloneableSerializable
implements Categorizer<InputType,CategoryType>

An abstract implementation of the Categorizer interface. Keeps track of the set of categories.

Since:
3.0
Author:
Justin Basilico
See Also:
Serialized Form

Field Summary
protected  Set<CategoryType> categories
          The set of categories that are the possible output values of the categorizer.
 
Constructor Summary
AbstractCategorizer()
          Creates a new AbstractCategorizer with an empty category set.
AbstractCategorizer(Set<CategoryType> categories)
          Creates a new AbstractCategorizer with the given category set.
 
Method Summary
 AbstractCategorizer<InputType,CategoryType> clone()
          This makes public the clone method on the Object class and removes the exception that it throws.
 Set<CategoryType> getCategories()
          Gets the list of possible categories that the categorizer can produce.
protected  void setCategories(Set<CategoryType> categories)
          Sets the Set of possible categories, which are the output values.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface gov.sandia.cognition.evaluator.Evaluator
evaluate
 

Field Detail

categories

protected Set<CategoryType> categories
The set of categories that are the possible output values of the categorizer.

Constructor Detail

AbstractCategorizer

public AbstractCategorizer()
Creates a new AbstractCategorizer with an empty category set.


AbstractCategorizer

public AbstractCategorizer(Set<CategoryType> categories)
Creates a new AbstractCategorizer with the given category set.

Parameters:
categories - The categories.
Method Detail

clone

public AbstractCategorizer<InputType,CategoryType> clone()
Description copied from class: AbstractCloneableSerializable
This makes public the clone method on the Object class and removes the exception that it throws. Its default behavior is to automatically create a clone of the exact type of object that the clone is called on and to copy all primitives but to keep all references, which means it is a shallow copy. Extensions of this class may want to override this method (but call super.clone() to implement a "smart copy". That is, to target the most common use case for creating a copy of the object. Because of the default behavior being a shallow copy, extending classes only need to handle fields that need to have a deeper copy (or those that need to be reset). Some of the methods in ObjectUtil may be helpful in implementing a custom clone method. Note: The contract of this method is that you must use super.clone() as the basis for your implementation.

Specified by:
clone in interface CloneableSerializable
Overrides:
clone in class AbstractCloneableSerializable
Returns:
A clone of this object.

getCategories

public Set<CategoryType> getCategories()
Description copied from interface: Categorizer
Gets the list of possible categories that the categorizer can produce.

Specified by:
getCategories in interface Categorizer<InputType,CategoryType>
Returns:
The list of possible categories.

setCategories

protected void setCategories(Set<CategoryType> categories)
Sets the Set of possible categories, which are the output values.

Parameters:
categories - The list of possible output categories.