org.omegahat.Numerics.Optimizers
Interface ModelPoint

All Known Subinterfaces:

ModelPointNumericInt

public interface ModelPoint

The interface to define a point estimate for a numerical model.

An implementing class has to provide numeric parameters implementing interface NumericArray, a <>double value, a NumericArray gradient and a NumericMatrix hessian. The hessian can be left null if the method does not use second derivatives, and similarly for the gradient if first derivatives are not used.

The String[] vector of parameter names likewise can be returned as null if names have not been defined.

The implementing class will have to choose a particular implementation of the FONT CLASS=JavaClass>NumericArray and FONT CLASS=JavaClass>NumericMatrix interfaces, for example by choosing a matrix package through the LinearAlgebra module.

Method Summary

ModelPoint	copy() Copy the model point and its numeric properties (parameters, gradient, hessian).
void	copyData(ModelPoint theta) copy in the data from theta.
void	show()
void	show(java.lang.String header)

Method Detail

show

public void show(java.lang.String header)

show

public void show()

copy

public ModelPoint copy()

Copy the model point and its numeric properties (parameters, gradient, hessian). It is not required to copy the model.

copyData

public void copyData(ModelPoint theta)

copy in the data from theta.

The parameters will be those in theta, as will the value, gradient, and hessian (either of the latter two can be null). If allocate is true, the fields will be newly allocated; otherwise, data will be copied into them if they match in structure the corresponding fields in theta.