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
All Methods Instance Methods Concrete Methods 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.
-
-
-
Constructor Detail
-
JacobianFunction
public JacobianFunction(RealVectorFunction f)
Construct the Jacobian function of a real scalar function f.- Parameters:
f
- a real scalar function
-
-
Method Detail
-
evaluate
public Matrix evaluate(Vector x)
Description copied from interface:Function
Evaluate the function f at x, where x is from the domain.
-
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 interfaceFunction<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 Rn->Rm function, the dimension of the range is m.- Specified by:
dimensionOfRange
in interfaceFunction<Vector,Matrix>
- Returns:
- the dimension of the range
-
-