Constraint (Hipparchus::Optimization 4.0.2 API)

All Superinterfaces:

MultivariateVectorFunction, OptimizationData, VectorDifferentiableFunction

All Known Implementing Classes:

BoundedConstraint, EqualityConstraint, InequalityConstraint, LinearBoundedConstraint, LinearEqualityConstraint, LinearInequalityConstraint
```
public interface Constraint
extends VectorDifferentiableFunction, OptimizationData
```
Generic constraint.

Since:

3.1

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`RealVector`	`getLowerBound()`	Get Lower Bound for `value(x)`.
`RealVector`	`getUpperBound()`	Get Upper Bound for `value(x)`.
`double`	`overshoot(RealVector y)`	Check how much a point overshoots the constraint.

Methods inherited from interface org.hipparchus.optim.nonlinear.vector.constrained.VectorDifferentiableFunction
dim, dimY, gradient, jacobian, value, value

- Method Detail
  - getLowerBound
```
RealVector getLowerBound()
```
    Get Lower Bound for value(x).
    
    Returns:
    
    Lower Bound for value(x)
  - getUpperBound
```
RealVector getUpperBound()
```
    Get Upper Bound for value(x).
    
    Returns:
    
    Upper Bound for value(x)
  - overshoot
```
double overshoot(RealVector y)
```
    Check how much a point overshoots the constraint.
    The overshoots is zero if the point fulfills the constraint, and positive if the value of the constraint is on the wrong side of lower or upper boundaries.
    
    Parameters:
    
    y - constraint value (y = value(x))
    
    Returns:
    
    L¹-norm of constraint overshoot