gov.sandia.cognition.math
Class AbstractDifferentiableUnivariateScalarFunction

java.lang.Object
  extended by gov.sandia.cognition.util.AbstractCloneableSerializable
      extended by gov.sandia.cognition.math.AbstractScalarFunction<Double>
          extended by gov.sandia.cognition.math.AbstractUnivariateScalarFunction
              extended by gov.sandia.cognition.math.AbstractDifferentiableUnivariateScalarFunction
All Implemented Interfaces:
Evaluator<Double,Double>, DifferentiableEvaluator<Double,Double,Double>, DifferentiableUnivariateScalarFunction, ScalarFunction<Double>, UnivariateScalarFunction, CloneableSerializable, Serializable, Cloneable
Direct Known Subclasses:
AtanFunction, CosineFunction, DirectionalVectorToScalarFunction, IdentityScalarFunction, LinearFunction, LineMinimizerDerivativeBased.InternalFunction, PolynomialFunction, PolynomialFunction.Linear, SigmoidFunction

@CodeReview(reviewer="Kevin R. Dixon",
            date="2008-12-02",
            changesNeeded=false,
            comments="Looks fine.")
public abstract class AbstractDifferentiableUnivariateScalarFunction
extends AbstractUnivariateScalarFunction
implements DifferentiableUnivariateScalarFunction

Partial implementation of DifferentiableUnivariateScalarFunction that implements the differentiate(Double) method with a callback to the differentiate(double) method, so that a concrete class only to implement the differentiate(double) method

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

Constructor Summary
AbstractDifferentiableUnivariateScalarFunction()
          Creates a new instance of AbstractDifferentiableUnivariateScalarFunction
 
Method Summary
 Double differentiate(Double input)
          Differentiates the output with respect to the input
 
Methods inherited from class gov.sandia.cognition.math.AbstractUnivariateScalarFunction
evaluate, evaluateAsDouble
 
Methods inherited from class gov.sandia.cognition.util.AbstractCloneableSerializable
clone
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface gov.sandia.cognition.math.DifferentiableUnivariateScalarFunction
differentiate
 
Methods inherited from interface gov.sandia.cognition.math.UnivariateScalarFunction
evaluate
 
Methods inherited from interface gov.sandia.cognition.math.ScalarFunction
evaluateAsDouble
 
Methods inherited from interface gov.sandia.cognition.evaluator.Evaluator
evaluate
 
Methods inherited from interface gov.sandia.cognition.util.CloneableSerializable
clone
 

Constructor Detail

AbstractDifferentiableUnivariateScalarFunction

public AbstractDifferentiableUnivariateScalarFunction()
Creates a new instance of AbstractDifferentiableUnivariateScalarFunction

Method Detail

differentiate

public Double differentiate(Double input)
Description copied from interface: DifferentiableEvaluator
Differentiates the output with respect to the input

Specified by:
differentiate in interface DifferentiableEvaluator<Double,Double,Double>
Parameters:
input - Input about which to compute the derivative
Returns:
Derivative of the output with respect to the given input