gov.sandia.cognition.learning.function.categorization

Class EvaluatorToCategorizerAdapter.Learner<InputType,CategoryType>

java.lang.Object

gov.sandia.cognition.util.AbstractCloneableSerializable

gov.sandia.cognition.learning.algorithm.AbstractBatchLearnerContainer<BatchLearner<? super java.util.Collection<? extends InputOutputPair<? extends InputType,CategoryType>>,? extends Evaluator<? super InputType,? extends CategoryType>>>

gov.sandia.cognition.learning.function.categorization.EvaluatorToCategorizerAdapter.Learner<InputType,CategoryType>

Type Parameters:

InputType - The type of the input values.

CategoryType - The type of the output categories.

All Implemented Interfaces:

BatchLearner<java.util.Collection<? extends InputOutputPair<? extends InputType,CategoryType>>,EvaluatorToCategorizerAdapter<InputType,CategoryType>>, BatchLearnerContainer<BatchLearner<? super java.util.Collection<? extends InputOutputPair<? extends InputType,CategoryType>>,? extends Evaluator<? super InputType,? extends CategoryType>>>, SupervisedBatchLearner<InputType,CategoryType,EvaluatorToCategorizerAdapter<InputType,CategoryType>>, CloneableSerializable, java.io.Serializable, java.lang.Cloneable

Enclosing class:

EvaluatorToCategorizerAdapter<InputType,CategoryType>

public static class EvaluatorToCategorizerAdapter.Learner<InputType,CategoryType>
extends AbstractBatchLearnerContainer<BatchLearner<? super java.util.Collection<? extends InputOutputPair<? extends InputType,CategoryType>>,? extends Evaluator<? super InputType,? extends CategoryType>>>
implements SupervisedBatchLearner<InputType,CategoryType,EvaluatorToCategorizerAdapter<InputType,CategoryType>>

The EvaluatorToCategorizerAdapter.Learner class implements a simple supervised learner for a EvaluatorToCategorizerAdapter.

See Also:

Serialized Form

Field Summary

Fields inherited from class gov.sandia.cognition.learning.algorithm.AbstractBatchLearnerContainer

learner

Constructor Summary

Constructors

Constructor and Description
Learner() Creates a new EvaluatorToCategorizerAdapter.
Learner(BatchLearner<? super java.util.Collection<? extends InputOutputPair<? extends InputType,CategoryType>>,? extends Evaluator<? super InputType,? extends CategoryType>> learner) Creates a new EvaluatorToCategorizerAdapter.

Method Summary

Modifier and Type	Method and Description
EvaluatorToCategorizerAdapter.Learner<InputType,CategoryType>	clone() This makes public the clone method on the Object class and removes the exception that it throws.
BatchLearner<? super java.util.Collection<? extends InputOutputPair<? extends InputType,CategoryType>>,? extends Evaluator<? super InputType,? extends CategoryType>>	getLearner() Gets the learner whose output is to be adapted to be a categorizer.
EvaluatorToCategorizerAdapter<InputType,CategoryType>	learn(java.util.Collection<? extends InputOutputPair<? extends InputType,CategoryType>> data) The learn method creates an object of ResultType using data of type DataType, using some form of "learning" algorithm.
void	setLearner(BatchLearner<? super java.util.Collection<? extends InputOutputPair<? extends InputType,CategoryType>>,? extends Evaluator<? super InputType,? extends CategoryType>> learner) Sets the learner whose output is to be adapted to be a categorizer.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Learner

public Learner()

Creates a new EvaluatorToCategorizerAdapter.

Learner

public Learner(BatchLearner<? super java.util.Collection<? extends InputOutputPair<? extends InputType,CategoryType>>,? extends Evaluator<? super InputType,? extends CategoryType>> learner)

Creates a new EvaluatorToCategorizerAdapter.

Parameters:

learner - The learner to adapt the output of to be a categorizer.

Method Detail

clone

public EvaluatorToCategorizerAdapter.Learner<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 AbstractBatchLearnerContainer<BatchLearner<? super java.util.Collection<? extends InputOutputPair<? extends InputType,CategoryType>>,? extends Evaluator<? super InputType,? extends CategoryType>>>

Returns:

A clone of this object.

learn

public EvaluatorToCategorizerAdapter<InputType,CategoryType> learn(java.util.Collection<? extends InputOutputPair<? extends InputType,CategoryType>> data)

Description copied from interface: BatchLearner

The learn method creates an object of ResultType using data of type DataType, using some form of "learning" algorithm.

Specified by:

learn in interface BatchLearner<java.util.Collection<? extends InputOutputPair<? extends InputType,CategoryType>>,EvaluatorToCategorizerAdapter<InputType,CategoryType>>

Parameters:

data - The data that the learning algorithm will use to create an object of ResultType.

Returns:

The object that is created based on the given data using the learning algorithm.

getLearner

public BatchLearner<? super java.util.Collection<? extends InputOutputPair<? extends InputType,CategoryType>>,? extends Evaluator<? super InputType,? extends CategoryType>> getLearner()

Gets the learner whose output is to be adapted to be a categorizer.

Specified by:

getLearner in interface BatchLearnerContainer<BatchLearner<? super java.util.Collection<? extends InputOutputPair<? extends InputType,CategoryType>>,? extends Evaluator<? super InputType,? extends CategoryType>>>

Overrides:

getLearner in class AbstractBatchLearnerContainer<BatchLearner<? super java.util.Collection<? extends InputOutputPair<? extends InputType,CategoryType>>,? extends Evaluator<? super InputType,? extends CategoryType>>>

Returns:

The learner to adapt the output of.

setLearner

public void setLearner(BatchLearner<? super java.util.Collection<? extends InputOutputPair<? extends InputType,CategoryType>>,? extends Evaluator<? super InputType,? extends CategoryType>> learner)

Sets the learner whose output is to be adapted to be a categorizer.

Overrides:

setLearner in class AbstractBatchLearnerContainer<BatchLearner<? super java.util.Collection<? extends InputOutputPair<? extends InputType,CategoryType>>,? extends Evaluator<? super InputType,? extends CategoryType>>>

Parameters:

learner - The leaner to adapt the output of.