gov.sandia.cognition.learning.function.cost
Class EuclideanDistanceCostFunction

java.lang.Object
  extended by gov.sandia.cognition.util.AbstractCloneableSerializable
      extended by gov.sandia.cognition.learning.function.cost.EuclideanDistanceCostFunction
All Implemented Interfaces:
Evaluator<Vectorizable,Double>, CostFunction<Vectorizable,Vectorizable>, CloneableSerializable, Serializable, Cloneable

@CodeReview(reviewer="Justin Basilico",
            date="2006-10-04",
            changesNeeded=false,
            comments="Switched usage for the goal from Vectorizable to just a Vector so it does not call convertToVector() over and over.")
public class EuclideanDistanceCostFunction
extends AbstractCloneableSerializable
implements CostFunction<Vectorizable,Vectorizable>

The EuclideanDistanceCostFunction class implements a CostFunction that calculates the Euclidean distance the given Vectorizable and the goal vector.

Since:
1.0
Author:
Jonathan McClain
See Also:
Serialized Form

Constructor Summary
EuclideanDistanceCostFunction()
          Creates a new EuclideanDistanceCostFunction with no initial goal.
EuclideanDistanceCostFunction(Vector goal)
          Creates a new instance of EuclideanDistanceCostFunction.
 
Method Summary
 EuclideanDistanceCostFunction clone()
          This makes public the clone method on the Object class and removes the exception that it throws.
 Double evaluate(Vectorizable target)
          Evaluates the Euclidean distance between the provided target and the goal.
 Vectorizable getCostParameters()
          Gets the parameters of the cost function.
 void setCostParameters(Vectorizable 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
 

Constructor Detail

EuclideanDistanceCostFunction

public EuclideanDistanceCostFunction()
Creates a new EuclideanDistanceCostFunction with no initial goal.


EuclideanDistanceCostFunction

public EuclideanDistanceCostFunction(Vector goal)
Creates a new instance of EuclideanDistanceCostFunction.

Parameters:
goal - The goal of the search.
Method Detail

clone

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

evaluate

public Double evaluate(Vectorizable target)
Evaluates the Euclidean distance between the provided target and the goal.

Specified by:
evaluate in interface Evaluator<Vectorizable,Double>
Specified by:
evaluate in interface CostFunction<Vectorizable,Vectorizable>
Parameters:
target - The target to evaluate.
Returns:
The distance between the target and the goal.

setCostParameters

public void setCostParameters(Vectorizable 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<Vectorizable,Vectorizable>
Parameters:
costParameters - The parameters of the cost function.

getCostParameters

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

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