Package org.ddogleg.optimization.wrap

Class Individual_to_CoupledJacobian<S extends DMatrix>

java.lang.Object

org.ddogleg.optimization.wrap.Individual_to_CoupledJacobian<S>

All Implemented Interfaces:

CoupledJacobian<S>, FunctionInOut

public class Individual_to_CoupledJacobian<S extends DMatrix>
extends Object
implements CoupledJacobian<S>

Wrapper around FunctionNtoM and FunctionNtoMxN for CoupledJacobian.

Constructor Summary

Constructors

Constructor	Description
Individual_to_CoupledJacobian(FunctionNtoM func, FunctionNtoMxN<S> jacobian)

Method Summary

Modifier and Type	Method	Description
void	computeFunctions(double[] output)
void	computeJacobian(S jacobian)	Processes the input parameters into the 2D Jacobian matrix.
int	getNumOfInputsN()	Number of input elements.
int	getNumOfOutputsM()	Number of output elements.
void	setInput(double[] x)	Specifies the input parameters.

Methods inherited from class java.lang.Object

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

Constructor Details

Individual_to_CoupledJacobian

public Individual_to_CoupledJacobian(FunctionNtoM func,
 FunctionNtoMxN<S> jacobian)

Method Details

getNumOfInputsN

public int getNumOfInputsN()

Description copied from interface: FunctionInOut

Number of input elements. Typically, the parameters you are optimizing.

Specified by:

getNumOfInputsN in interface FunctionInOut

Returns:

number of input elements

getNumOfOutputsM

public int getNumOfOutputsM()

Description copied from interface: FunctionInOut

Number of output elements. Typically, the functions that are being optimized.

Specified by:

getNumOfOutputsM in interface FunctionInOut

Returns:

number of output elements

setInput

public void setInput(double[] x)

Description copied from interface: CoupledJacobian

Specifies the input parameters. The user can modify these values and they will be modified inside the optimization function too.

Specified by:

setInput in interface CoupledJacobian<S extends DMatrix>

Parameters:

x - Optimization parameters.

computeFunctions

public void computeFunctions(double[] output)

Specified by:

computeFunctions in interface CoupledJacobian<S extends DMatrix>

computeJacobian

public void computeJacobian(S jacobian)

Description copied from interface: CoupledJacobian

Processes the input parameters into the 2D Jacobian matrix. The matrix has a dimension of M rows and N columns and is formatted as a row major 1D-array. EJML can be used to provide a matrix wrapper around the output array: DenseMatrix J = DenseMatrix.wrap(m,n,output);

The user can modify the input parameters here and the optimizer must use those changes.

Specified by:

computeJacobian in interface CoupledJacobian<S extends DMatrix>

Parameters:

jacobian - matrix with M rows and N columns.