Package dev.nm.analysis.differentiation.multivariate

Class JacobianFunction

java.lang.Object

dev.nm.analysis.differentiation.multivariate.JacobianFunction

All Implemented Interfaces:

Function<Vector,Matrix>, RntoMatrix

public class JacobianFunction
extends Object
implements RntoMatrix

The Jacobian function, J(x), evaluates the Jacobian of a real vector-valued function f at a point x. J(x) has the same domain as f(x).

Nested Class Summary

Nested classes/interfaces inherited from interface dev.nm.analysis.function.Function

Function.EvaluationException

Constructor Summary

Constructors

Constructor	Description
JacobianFunction(RealVectorFunction f)	Construct the Jacobian function of a real scalar function f.

Method Summary

Modifier and Type	Method	Description
int	dimensionOfDomain()	Get the number of variables the function has.
int	dimensionOfRange()	Get the dimension of the range space of the function.
Matrix	evaluate(Vector x)	Evaluate the function f at x, where x is from the domain.

Methods inherited from class java.lang.Object

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

Constructor Details

JacobianFunction

public JacobianFunction(RealVectorFunction f)

Construct the Jacobian function of a real scalar function f.

Parameters:

f - a real scalar function

Method Details

evaluate

public Matrix evaluate(Vector x)

Description copied from interface: Function

Evaluate the function f at x, where x is from the domain.

Specified by:

evaluate in interface Function<Vector,Matrix>

Parameters:

x - x

Returns:

f(x)

dimensionOfDomain

public int dimensionOfDomain()

Description copied from interface: Function

Get the number of variables the function has. For example, for a univariate function, the domain dimension is 1; for a bivariate function, the domain dimension is 2.

Specified by:

dimensionOfDomain in interface Function<Vector,Matrix>

Returns:

the number of variables

dimensionOfRange

public int dimensionOfRange()

Description copied from interface: Function

Get the dimension of the range space of the function. For example, for a Rⁿ->R^m function, the dimension of the range is m.

Specified by:

dimensionOfRange in interface Function<Vector,Matrix>

Returns:

the dimension of the range