Interface VectorDifferentiableFunction
- All Superinterfaces:
MultivariateVectorFunction
- All Known Subinterfaces:
Constraint
- All Known Implementing Classes:
BoundedConstraint
,EqualityConstraint
,InequalityConstraint
,LinearBoundedConstraint
,LinearEqualityConstraint
,LinearInequalityConstraint
A MultivariateFunction that also has a defined gradient and Hessian.
- Since:
- 3.1
-
Method Summary
Modifier and TypeMethodDescriptionint
dim()
Returns the dimensionality of the function domain.int
dimY()
Returns the dimensionality of the function eval.default RealMatrix
gradient
(double[] x) Returns the gradient of this function at (x)Returns the gradient of this function at (x)default double[]
value
(double[] x) Returns the value of this function at (x)value
(RealVector x) Returns the value of this function at (x)
-
Method Details
-
dim
int dim()Returns the dimensionality of the function domain. If dim() returns (n) then this function expects an n-vector as its input.- Returns:
- the expected dimension of the function's domain
-
dimY
int dimY()Returns the dimensionality of the function eval.- Returns:
- the expected dimension of the function's eval
-
value
Returns the value of this function at (x)- Parameters:
x
- a point to evaluate this function at.- Returns:
- the value of this function at (x)
-
value
default double[] value(double[] x) Returns the value of this function at (x)- Specified by:
value
in interfaceMultivariateVectorFunction
- Parameters:
x
- a point to evaluate this function at.- Returns:
- the value of this function at (x)
-
jacobian
Returns the gradient of this function at (x)- Parameters:
x
- a point to evaluate this gradient at- Returns:
- the gradient of this function at (x)
-
gradient
Returns the gradient of this function at (x)- Parameters:
x
- a point to evaluate this gradient at- Returns:
- the gradient of this function at (x)
-