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.public abstract class AbstractCostFunction<EvaluatedType,CostParametersType> extends AbstractCloneableSerializable implements CostFunction<EvaluatedType,CostParametersType>
Modifier and Type | Field and Description |
---|---|
protected CostParametersType |
costParameters
The parameters of the cost function.
|
Constructor and Description |
---|
AbstractCostFunction()
Creates a new instance of AbstractCostFunction
|
AbstractCostFunction(CostParametersType costParameters)
Creates a new instance of AbstractCostFunction
|
Modifier and Type | Method and Description |
---|---|
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.
|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
evaluate
protected CostParametersType costParameters
public AbstractCostFunction()
public AbstractCostFunction(CostParametersType costParameters)
costParameters
- The parameters of the cost function.public AbstractCostFunction<EvaluatedType,CostParametersType> clone()
AbstractCloneableSerializable
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.clone
in interface CostFunction<EvaluatedType,CostParametersType>
clone
in interface CloneableSerializable
clone
in class AbstractCloneableSerializable
public void setCostParameters(CostParametersType costParameters)
CostFunction
setCostParameters
in interface CostFunction<EvaluatedType,CostParametersType>
costParameters
- The parameters of the cost function.public CostParametersType getCostParameters()
CostFunction
getCostParameters
in interface CostFunction<EvaluatedType,CostParametersType>