gov.sandia.cognition.learning.algorithm.nearest
Class NearestNeighborExhaustive.Learner<InputType,OutputType>

java.lang.Object
  extended by gov.sandia.cognition.util.AbstractCloneableSerializable
      extended by gov.sandia.cognition.learning.function.distance.DefaultDivergenceFunctionContainer<InputType,InputType>
          extended by gov.sandia.cognition.learning.algorithm.nearest.NearestNeighborExhaustive.Learner<InputType,OutputType>
Type Parameters:
InputType - The input type for nearest neighbor.
OutputType - The output type for nearest neighbor.
All Implemented Interfaces:
BatchLearner<Collection<? extends InputOutputPair<? extends InputType,OutputType>>,NearestNeighborExhaustive<InputType,OutputType>>, SupervisedBatchLearner<InputType,OutputType,NearestNeighborExhaustive<InputType,OutputType>>, DivergenceFunctionContainer<InputType,InputType>, CloneableSerializable, Serializable, Cloneable
Enclosing class:
NearestNeighborExhaustive<InputType,OutputType>

public static class NearestNeighborExhaustive.Learner<InputType,OutputType>
extends DefaultDivergenceFunctionContainer<InputType,InputType>
implements SupervisedBatchLearner<InputType,OutputType,NearestNeighborExhaustive<InputType,OutputType>>

The NearestNeighborExhaustive.Learner class implements a batch learner for the NearestNeighborExhaustive class.

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

Field Summary
 
Fields inherited from class gov.sandia.cognition.learning.function.distance.DefaultDivergenceFunctionContainer
divergenceFunction
 
Constructor Summary
NearestNeighborExhaustive.Learner()
          Creates a new instance of NearestNeighborExhaustive.Learner.
NearestNeighborExhaustive.Learner(DivergenceFunction<? super InputType,? super InputType> divergenceFunction)
          Creates a new instance of NearestNeighborExhaustive.Learner.
 
Method Summary
 NearestNeighborExhaustive<InputType,OutputType> learn(Collection<? extends InputOutputPair<? extends InputType,OutputType>> data)
          The learn method creates an object of ResultType using data of type DataType, using some form of "learning" algorithm.
 
Methods inherited from class gov.sandia.cognition.learning.function.distance.DefaultDivergenceFunctionContainer
clone, getDivergenceFunction, setDivergenceFunction
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface gov.sandia.cognition.util.CloneableSerializable
clone
 

Constructor Detail

NearestNeighborExhaustive.Learner

public NearestNeighborExhaustive.Learner()
Creates a new instance of NearestNeighborExhaustive.Learner.


NearestNeighborExhaustive.Learner

public NearestNeighborExhaustive.Learner(DivergenceFunction<? super InputType,? super InputType> divergenceFunction)
Creates a new instance of NearestNeighborExhaustive.Learner.

Parameters:
divergenceFunction - The divergence function to use.
Method Detail

learn

public NearestNeighborExhaustive<InputType,OutputType> learn(Collection<? extends InputOutputPair<? extends InputType,OutputType>> 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<Collection<? extends InputOutputPair<? extends InputType,OutputType>>,NearestNeighborExhaustive<InputType,OutputType>>
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.