org.gersteinlab.regulation.numeric
Class DifferentiableMultivariateFunction

java.lang.Object
  extended by org.gersteinlab.regulation.numeric.MultivariateFunction
      extended by org.gersteinlab.regulation.numeric.DifferentiableMultivariateFunction
Direct Known Subclasses:
DoublyDifferentiableMultivariateFunction

public abstract class DifferentiableMultivariateFunction
extends MultivariateFunction

        A class that represents a differentiable multivariate real function.
        Each inherited class should implement at least one of gf(double) and
        gf().
        

Version:
1.0 (August 29, 2008)
        Change History:
        1.0     - Initial version
        
Author:
Kevin Yuk-Lap Yip

Field Summary
 
Fields inherited from class org.gersteinlab.regulation.numeric.MultivariateFunction
xStored
 
Constructor Summary
DifferentiableMultivariateFunction()
           
 
Method Summary
 double[] gf()
          Evaluate the gradient of the function at the stored point.
 double[] gf(double[] x)
          Evaluate the gradient of the function at a point.
 
Methods inherited from class org.gersteinlab.regulation.numeric.MultivariateFunction
f, f, set
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DifferentiableMultivariateFunction

public DifferentiableMultivariateFunction()
Method Detail

gf

public double[] gf(double[] x)
Evaluate the gradient of the function at a point.

Parameters:
x - The point
Returns:
The gradient of the function at the point

gf

public double[] gf()
Evaluate the gradient of the function at the stored point.

Returns:
The gradient of the function at the point