gov.sandia.cognition.learning.function.cost
Class AbstractCostFunction<EvaluatedType,CostParametersType>

java.lang.Object
  extended by gov.sandia.cognition.util.AbstractCloneableSerializable
      extended by gov.sandia.cognition.learning.function.cost.AbstractCostFunction<EvaluatedType,CostParametersType>
Type Parameters:
EvaluatedType - Class type to evaluate, for example a "Vector" or "Evaluator"
CostParametersType - Class type that parameterizes the CostFunction, for example, a Collection of InputOutputPairs. Usually the dataset we're interested in.
All Implemented Interfaces:
Evaluator<EvaluatedType,Double>, CostFunction<EvaluatedType,CostParametersType>, CloneableSerializable, Serializable, Cloneable
Direct Known Subclasses:
KolmogorovSmirnovDivergence, NegativeLogLikelihood

public abstract class AbstractCostFunction<EvaluatedType,CostParametersType>
extends AbstractCloneableSerializable
implements CostFunction<EvaluatedType,CostParametersType>

Partial implementation of CostFunction.

Since:
3.1
Author:
Kevin R. Dixon
See Also:
Serialized Form

Field Summary
protected  CostParametersType costParameters
          The parameters of the cost function.
 
Constructor Summary
AbstractCostFunction()
          Creates a new instance of AbstractCostFunction
AbstractCostFunction(CostParametersType costParameters)
          Creates a new instance of AbstractCostFunction
 
Method Summary
 AbstractCostFunction<EvaluatedType,CostParametersType> clone()
          This makes public the clone method on the Object class and removes the exception that it throws.
 CostParametersType getCostParameters()
          Gets the parameters of the cost function.
 void setCostParameters(CostParametersType costParameters)
          Sets the parameters of the cost function used to evaluate the cost of a target.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface gov.sandia.cognition.learning.function.cost.CostFunction
evaluate
 

Field Detail

costParameters

protected CostParametersType costParameters
The parameters of the cost function.

Constructor Detail

AbstractCostFunction

public AbstractCostFunction()
Creates a new instance of AbstractCostFunction


AbstractCostFunction

public AbstractCostFunction(CostParametersType costParameters)
Creates a new instance of AbstractCostFunction

Parameters:
costParameters - The parameters of the cost function.
Method Detail

clone

public AbstractCostFunction<EvaluatedType,CostParametersType> 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 CostFunction<EvaluatedType,CostParametersType>
Specified by:
clone in interface CloneableSerializable
Overrides:
clone in class AbstractCloneableSerializable
Returns:
A clone of this object.

setCostParameters

public void setCostParameters(CostParametersType costParameters)
Description copied from interface: CostFunction
Sets the parameters of the cost function used to evaluate the cost of a target.

Specified by:
setCostParameters in interface CostFunction<EvaluatedType,CostParametersType>
Parameters:
costParameters - The parameters of the cost function.

getCostParameters

public CostParametersType getCostParameters()
Description copied from interface: CostFunction
Gets the parameters of the cost function.

Specified by:
getCostParameters in interface CostFunction<EvaluatedType,CostParametersType>
Returns:
The current parameters of the cost function.