@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>
Constructor and Description |
---|
EuclideanDistanceCostFunction()
Creates a new EuclideanDistanceCostFunction with no initial goal.
|
EuclideanDistanceCostFunction(Vector goal)
Creates a new instance of EuclideanDistanceCostFunction.
|
Modifier and Type | Method and Description |
---|---|
EuclideanDistanceCostFunction |
clone()
This makes public the clone method on the
Object class and
removes the exception that it throws. |
java.lang.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.
|
public EuclideanDistanceCostFunction()
public EuclideanDistanceCostFunction(Vector goal)
goal
- The goal of the search.public EuclideanDistanceCostFunction 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<Vectorizable,Vectorizable>
clone
in interface CloneableSerializable
clone
in class AbstractCloneableSerializable
public java.lang.Double evaluate(Vectorizable target)
evaluate
in interface Evaluator<Vectorizable,java.lang.Double>
evaluate
in interface CostFunction<Vectorizable,Vectorizable>
target
- The target to evaluate.public void setCostParameters(Vectorizable costParameters)
CostFunction
setCostParameters
in interface CostFunction<Vectorizable,Vectorizable>
costParameters
- The parameters of the cost function.public Vectorizable getCostParameters()
CostFunction
getCostParameters
in interface CostFunction<Vectorizable,Vectorizable>