Class LeastSquaresFactory.LocalValueAndJacobianFunction

java.lang.Object

org.apache.commons.math3.fitting.leastsquares.LeastSquaresFactory.LocalValueAndJacobianFunction

Record Components:

value - the vector value function

jacobian - the Jacobian function

All Implemented Interfaces:

MultivariateJacobianFunction, ValueAndJacobianFunction

Enclosing class:

LeastSquaresFactory

private static class LeastSquaresFactory.LocalValueAndJacobianFunction
extends Object
implements ValueAndJacobianFunction

Combine a MultivariateVectorFunction with a MultivariateMatrixFunction to produce a MultivariateJacobianFunction.

Since:

3.3

Field Summary

Fields

Modifier and Type	Field	Description
private final MultivariateMatrixFunction	jacobian	Model's Jacobian.
private final MultivariateVectorFunction	value	Model.

Constructor Summary

Constructors

Constructor	Description
LocalValueAndJacobianFunction(MultivariateVectorFunction value, MultivariateMatrixFunction jacobian)

Method Summary

Modifier and Type	Method	Description
RealMatrix	computeJacobian(double[] params)	Compute the Jacobian.
RealVector	computeValue(double[] params)	Compute the value.
Pair<RealVector, RealMatrix>	value(RealVector point)	Compute the function value and its Jacobian.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

value

private final MultivariateVectorFunction value

Model.

jacobian

private final MultivariateMatrixFunction jacobian

Model's Jacobian.

Constructor Details

LocalValueAndJacobianFunction

LocalValueAndJacobianFunction(MultivariateVectorFunction value,
 MultivariateMatrixFunction jacobian)

Parameters:

value - Model function.

jacobian - Model's Jacobian function.

Method Details

value

public Pair<RealVector, RealMatrix> value(RealVector point)

Compute the function value and its Jacobian.

Specified by:

value in interface MultivariateJacobianFunction

Parameters:

point - the abscissae

Returns:

the values and their Jacobian of this vector valued function.

computeValue

public RealVector computeValue(double[] params)

Compute the value.

Specified by:

computeValue in interface ValueAndJacobianFunction

Parameters:

params - Point.

Returns:

the value at the given point.

computeJacobian

public RealMatrix computeJacobian(double[] params)

Compute the Jacobian.

Specified by:

computeJacobian in interface ValueAndJacobianFunction

Parameters:

params - Point.

Returns:

the Jacobian at the given point.