Package de.labathome.trustconstr

Class SparsityForcedConstraint

java.lang.Object

de.labathome.trustconstr.SparsityForcedConstraint

All Implemented Interfaces:

Constraint, Jacobian

public final class SparsityForcedConstraint
extends Object
implements Constraint, Jacobian

Decorator that wraps a Constraint + Jacobian source and forces the jacEq / jacIneq return values to a specific sparsity. Used by MinimizeTrustConstr.minimizeTrustConstr(java.util.function.ToDoubleBiFunction<de.labathome.trustconstr.matrix.Matrix, java.lang.Object>, de.labathome.trustconstr.matrix.Matrix, java.lang.Object, java.util.function.BiFunction<de.labathome.trustconstr.matrix.Matrix, java.lang.Object, de.labathome.trustconstr.matrix.Matrix>, java.util.function.BiFunction<de.labathome.trustconstr.matrix.Matrix, java.lang.Object, de.labathome.trustconstr.matrix.Matrix>, de.labathome.trustconstr.interfaces.HessianProduct, de.labathome.trustconstr.records.Bounds, java.lang.Object, double, double, double, java.util.Optional<java.lang.Boolean>, de.labathome.trustconstr.interfaces.IterationCallback, int, int, de.labathome.trustconstr.matrix.Matrix, double, double, double, double, de.labathome.trustconstr.enums.ProjectionMethod, boolean) to honor the user-supplied sparseJacobian preference (mirrors scipy's sparse_jacobian=True/False argument): when explicitly set, callers can override the auto-detected representation.

constrEq / constrIneq pass through unchanged (constraint values are 1-D and sparsity is rarely meaningful for them). lagrangianContribution, nEq(), nIneq(), keepFeasible-related delegates, and validateKeepFeasibleAtStart pass through to the source as well.

Constructor Summary

Constructors

Constructor	Description
SparsityForcedConstraint(Object source, boolean wantSparse)

Method Summary

Modifier and Type	Method	Description
Matrix	constrEq(Matrix x)
Matrix	constrIneq(Matrix x)
boolean[]	enforceFeasibilityIneq()	Pass-through to the source's enforce-feasibility flags.
Matrix	jacEq(Matrix x)
Matrix	jacIneq(Matrix x)
Matrix	lagrangianContribution(Matrix x, double[] vEq, double[] vIneq)	Pass-through to the source's Lagrangian-Hessian contribution.
int	nEq()
int	nIneq()
Object	source()
void	validateKeepFeasibleAtStart(Matrix x0)	Pass-through to the source's keep-feasible-at-start validation.

Methods inherited from class java.lang.Object

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

Constructor Details

SparsityForcedConstraint

public SparsityForcedConstraint(Object source,
 boolean wantSparse)

Parameters:

source - wrapped constraint (must implement both Constraint and Jacobian)

wantSparse - true forces sparse Jacobian output; false forces dense

Method Details

nEq

public int nEq()

Returns:

number of equality rows in the wrapped source

nIneq

public int nIneq()

Returns:

number of canonical inequality rows in the wrapped source

constrEq

public Matrix constrEq(Matrix x)

Specified by:

constrEq in interface Constraint

Parameters:

x - current iterate (n × 1)

Returns:

equality-constraint residual (nEq × 1)

constrIneq

public Matrix constrIneq(Matrix x)

Specified by:

constrIneq in interface Constraint

Parameters:

x - current iterate (n × 1)

Returns:

inequality-constraint residual (nIneq × 1); feasible iff every entry is ≤ 0

jacEq

public Matrix jacEq(Matrix x)

Specified by:

jacEq in interface Jacobian

Parameters:

x - current iterate (n × 1)

Returns:

Jacobian of constr_eq at x (nEq × n)

jacIneq

public Matrix jacIneq(Matrix x)

Specified by:

jacIneq in interface Jacobian

Parameters:

x - current iterate (n × 1)

Returns:

Jacobian of constr_ineq at x (nIneq × n)

lagrangianContribution

public Matrix lagrangianContribution(Matrix x,
 double[] vEq,
 double[] vIneq)

Pass-through to the source's Lagrangian-Hessian contribution.

Parameters:

x - iterate

vEq - equality multipliers

vIneq - inequality multipliers

Returns:

summed constraint Hessian, or null if the source has none

enforceFeasibilityIneq

public boolean[] enforceFeasibilityIneq()

Pass-through to the source's enforce-feasibility flags.

Returns:

per-canonical-row strict-feasibility flags

validateKeepFeasibleAtStart

public void validateKeepFeasibleAtStart(Matrix x0)

Pass-through to the source's keep-feasible-at-start validation.

Parameters:

x0 - starting iterate (n x 1)

source

public Object source()

Returns:

the wrapped source for type-introspection by the orchestrator