gov.sandia.cognition.learning.algorithm.baseline
Class IdentityLearner<ValueType>

java.lang.Object
  extended by gov.sandia.cognition.util.AbstractCloneableSerializable
      extended by gov.sandia.cognition.learning.algorithm.baseline.IdentityLearner<ValueType>
Type Parameters:
ValueType - The type of value passed into and out of the learner.
All Implemented Interfaces:
BatchLearner<ValueType,ValueType>, CloneableSerializable, Serializable, Cloneable

public class IdentityLearner<ValueType>
extends AbstractCloneableSerializable
implements BatchLearner<ValueType,ValueType>

A batch learner implementation that just returns its inputs, creating an identity function.

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

Constructor Summary
IdentityLearner()
          Creates a new IdentityLearner, which has no parameters.
 
Method Summary
 IdentityLearner<ValueType> clone()
          This makes public the clone method on the Object class and removes the exception that it throws.
static
<ValueType>
IdentityLearner<ValueType>
create()
          A convenience method for creating a IdentityLearner.
 ValueType learn(ValueType data)
          The learn method creates an object of ResultType using data of type DataType, using some form of "learning" algorithm.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IdentityLearner

public IdentityLearner()
Creates a new IdentityLearner, which has no parameters.

Method Detail

clone

public IdentityLearner<ValueType> 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.

learn

public ValueType learn(ValueType 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<ValueType,ValueType>
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.

create

public static <ValueType> IdentityLearner<ValueType> create()
A convenience method for creating a IdentityLearner.

Type Parameters:
ValueType - The type of value passed into and out of the learner.
Returns:
A new learner.