Package de.labathome.trustconstr.records

Class FiniteDifferenceBounds

java.lang.Object

de.labathome.trustconstr.records.FiniteDifferenceBounds

Direct Known Subclasses:

StrictBounds

public class FiniteDifferenceBounds
extends Object

Box bounds lb ≤ x ≤ ub used by NumDiff.approxDerivative(java.util.function.DoubleUnaryOperator, double, de.labathome.trustconstr.records.FiniteDifferenceOptions) to clamp finite-difference perturbations.

Constructor Summary

Constructors

Constructor	Description
FiniteDifferenceBounds(Matrix lb, Matrix ub, boolean keepFeasible)

Method Summary

Modifier and Type	Method	Description
boolean	keepFeasible()
Matrix	lb()
Matrix	ub()
static FiniteDifferenceBounds	unbounded(long nVars)	Convenience factory for the bound-free case: -inf ≤ x ≤ +inf.

Methods inherited from class java.lang.Object

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

Constructor Details

FiniteDifferenceBounds

public FiniteDifferenceBounds(Matrix lb,
 Matrix ub,
 boolean keepFeasible)

Parameters:

lb - per-variable lower bound (n × 1)

ub - per-variable upper bound (n × 1)

keepFeasible - if true, every FD perturbation must stay strictly inside the box

Method Details

unbounded

public static FiniteDifferenceBounds unbounded(long nVars)

Convenience factory for the bound-free case: -inf ≤ x ≤ +inf.

Parameters:

nVars - number of decision variables

Returns:

an unbounded FiniteDifferenceBounds of the requested size

lb

public Matrix lb()

Returns:

defensive copy of the lower bounds (n × 1)

ub

public Matrix ub()

Returns:

defensive copy of the upper bounds (n × 1)

keepFeasible

public boolean keepFeasible()

Returns:

whether perturbations must stay strictly inside the box