org.omegahat.Numerics.Optimizers
Interface ModelPointNumericInt

All Superinterfaces:
ModelPoint
All Known Implementing Classes:
ModelPointNumeric, ModelPointDatabase

public interface ModelPointNumericInt
extends ModelPoint

An extension to ModelPoint which provides methods for computing numerical quantities such as the gradient and hessian.


Method Summary
 void evaluate()
          Evaluate the model at the current point, using the model property to define the objective.
 NumericArray getGradient()
           
 NumericMatrix getHessian()
           
 ModelObjective getModel()
           
 java.lang.String[] getNames()
           
 NumericArray getParameters()
           
 double getValue()
           
 boolean isEvaluated()
           
 boolean setEvaluated(boolean value)
           
 NumericArray setGradient(NumericArray value)
           
 NumericMatrix setHessian(NumericMatrix value)
           
 ModelObjective setModel(ModelObjective value)
           
 java.lang.String[] setNames(java.lang.String[] labels)
           
 NumericArray setParameters(NumericArray value)
           
 double setValue(double value)
           
 
Methods inherited from interface org.omegahat.Numerics.Optimizers.ModelPoint
copy, copyData, show, show
 

Method Detail

evaluate

public void evaluate()
Evaluate the model at the current point, using the model property to define the objective. Store the resulting value and optional gradient and hessian in this object and set the evaluated property to true.

getParameters

public NumericArray getParameters()

setParameters

public NumericArray setParameters(NumericArray value)

getValue

public double getValue()

setValue

public double setValue(double value)

getGradient

public NumericArray getGradient()

setGradient

public NumericArray setGradient(NumericArray value)

getHessian

public NumericMatrix getHessian()

setHessian

public NumericMatrix setHessian(NumericMatrix value)

isEvaluated

public boolean isEvaluated()

setEvaluated

public boolean setEvaluated(boolean value)

getNames

public java.lang.String[] getNames()

setNames

public java.lang.String[] setNames(java.lang.String[] labels)

getModel

public ModelObjective getModel()

setModel

public ModelObjective setModel(ModelObjective value)