@CodeReview(reviewer="Kevin R. Dixon", date="2009-07-06", changesNeeded=false, comments={"Made clone() call super.clone().","Created test class.","Class looks fine."}) public class DirectionalVectorToDifferentiableScalarFunction extends DirectionalVectorToScalarFunction
FORWARD_DIFFERENCE| Constructor and Description |
|---|
DirectionalVectorToDifferentiableScalarFunction(DifferentiableEvaluator<? super Vector,? extends java.lang.Double,Vector> vectorScalarFunction,
Vector vectorOffset,
Vector direction)
Creates a new instance of DirectionalVectorToDifferentiableScalarFunction
|
| Modifier and Type | Method and Description |
|---|---|
DirectionalVectorToDifferentiableScalarFunction |
clone()
This makes public the clone method on the
Object class and
removes the exception that it throws. |
double |
differentiate(double input)
Differentiates the output of the function about the given input
|
InputOutputPair<Vector,Vector> |
getLastGradient()
Getter for lastGradient
|
void |
setLastGradient(InputOutputPair<Vector,Vector> lastGradient)
Setter for lastGradient
|
computeVector, evaluate, getDirection, getVectorOffset, getVectorScalarFunction, setDirection, setVectorOffset, setVectorScalarFunctionequals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitdifferentiateevaluate, evaluateAsDoublepublic DirectionalVectorToDifferentiableScalarFunction(DifferentiableEvaluator<? super Vector,? extends java.lang.Double,Vector> vectorScalarFunction, Vector vectorOffset, Vector direction)
vectorScalarFunction - Function that maps a Vector onto a DoublevectorOffset - offset vector from which to scale along
direction to evaluate vectorFunctiondirection - Direction to optimize alongpublic DirectionalVectorToDifferentiableScalarFunction clone()
AbstractCloneableSerializableObject 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 CloneableSerializableclone in class DirectionalVectorToScalarFunctionpublic double differentiate(double input)
DifferentiableUnivariateScalarFunctiondifferentiate in interface DifferentiableUnivariateScalarFunctiondifferentiate in class DirectionalVectorToScalarFunctioninput - Input about which to compute the derivative of the function outputpublic InputOutputPair<Vector,Vector> getLastGradient()
public void setLastGradient(InputOutputPair<Vector,Vector> lastGradient)
lastGradient - Last gradient information