com.google.ortools.pdlp.ConvergenceInformationOrBuilder Interface Reference

Inheritance diagram for com.google.ortools.pdlp.ConvergenceInformationOrBuilder:

Public Member Functions
boolean	hasCandidateType ()
com.google.ortools.pdlp.PointType	getCandidateType ()
boolean	hasPrimalObjective ()
double	getPrimalObjective ()
boolean	hasDualObjective ()
double	getDualObjective ()
boolean	hasCorrectedDualObjective ()
double	getCorrectedDualObjective ()
boolean	hasLInfPrimalResidual ()
double	getLInfPrimalResidual ()
boolean	hasL2PrimalResidual ()
double	getL2PrimalResidual ()
boolean	hasLInfComponentwisePrimalResidual ()
double	getLInfComponentwisePrimalResidual ()
boolean	hasLInfDualResidual ()
double	getLInfDualResidual ()
boolean	hasL2DualResidual ()
double	getL2DualResidual ()
boolean	hasLInfComponentwiseDualResidual ()
double	getLInfComponentwiseDualResidual ()
boolean	hasLInfPrimalVariable ()
double	getLInfPrimalVariable ()
boolean	hasL2PrimalVariable ()
double	getL2PrimalVariable ()
boolean	hasLInfDualVariable ()
double	getLInfDualVariable ()
boolean	hasL2DualVariable ()
double	getL2DualVariable ()

Detailed Description

Definition at line 7 of file ConvergenceInformationOrBuilder.java.

Member Function Documentation

getCandidateType()

com.google.ortools.pdlp.PointType com.google.ortools.pdlp.ConvergenceInformationOrBuilder.getCandidateType

(

)

Type of the candidate point described by this ConvergenceInformation.

optional .operations_research.pdlp.PointType candidate_type = 1;

Returns

The candidateType.

Implemented in com.google.ortools.pdlp.ConvergenceInformation.Builder, and com.google.ortools.pdlp.ConvergenceInformation.

getCorrectedDualObjective()

double com.google.ortools.pdlp.ConvergenceInformationOrBuilder.getCorrectedDualObjective

(

)

If possible (e.g., when all primal variables have lower and upper bounds),
a correct dual bound. The value is negative infinity if no corrected dual
bound is available.

optional double corrected_dual_objective = 4;

Returns

The correctedDualObjective.

Implemented in com.google.ortools.pdlp.ConvergenceInformation.Builder, and com.google.ortools.pdlp.ConvergenceInformation.

getDualObjective()

double com.google.ortools.pdlp.ConvergenceInformationOrBuilder.getDualObjective

(

)

The dual objective. The dual need not be feasible. The dual objective
includes the contributions from reduced costs.
NOTE: The definition of dual_objective changed in OR-tools version 9.8.
See
https://developers.google.com/optimization/lp/pdlp_math#reduced_costs_dual_residuals_and_the_corrected_dual_objective
for details.

optional double dual_objective = 3;

Returns

The dualObjective.

Implemented in com.google.ortools.pdlp.ConvergenceInformation.Builder, and com.google.ortools.pdlp.ConvergenceInformation.

getL2DualResidual()

double com.google.ortools.pdlp.ConvergenceInformationOrBuilder.getL2DualResidual

(

)

The l_2 norm of the violations of dual constraints.

optional double l2_dual_residual = 8;

Returns

The l2DualResidual.

Implemented in com.google.ortools.pdlp.ConvergenceInformation.Builder, and com.google.ortools.pdlp.ConvergenceInformation.

getL2DualVariable()

double com.google.ortools.pdlp.ConvergenceInformationOrBuilder.getL2DualVariable

(

)

The l_2 norm of the dual variables.

optional double l2_dual_variable = 17;

Returns

The l2DualVariable.

Implemented in com.google.ortools.pdlp.ConvergenceInformation.Builder, and com.google.ortools.pdlp.ConvergenceInformation.

getL2PrimalResidual()

double com.google.ortools.pdlp.ConvergenceInformationOrBuilder.getL2PrimalResidual

(

)

The l_2 norm of the violations of primal constraints.

optional double l2_primal_residual = 6;

Returns

The l2PrimalResidual.

Implemented in com.google.ortools.pdlp.ConvergenceInformation.Builder, and com.google.ortools.pdlp.ConvergenceInformation.

getL2PrimalVariable()

double com.google.ortools.pdlp.ConvergenceInformationOrBuilder.getL2PrimalVariable

(

)

The l_2 norm of the primal variables.

optional double l2_primal_variable = 15;

Returns

The l2PrimalVariable.

Implemented in com.google.ortools.pdlp.ConvergenceInformation.Builder, and com.google.ortools.pdlp.ConvergenceInformation.

getLInfComponentwiseDualResidual()

double com.google.ortools.pdlp.ConvergenceInformationOrBuilder.getLInfComponentwiseDualResidual

(

)

The maximum relative violation of any dual constraint, with an absolute
offset, i.e., the l_∞ norm of [violation / (eps_ratio + |objective|)] where
eps_ratio = eps_optimal_dual_residual_absolute
/ eps_optimal_dual_residual_relative

optional double l_inf_componentwise_dual_residual = 25;

Returns

The lInfComponentwiseDualResidual.

Implemented in com.google.ortools.pdlp.ConvergenceInformation.Builder, and com.google.ortools.pdlp.ConvergenceInformation.

getLInfComponentwisePrimalResidual()

double com.google.ortools.pdlp.ConvergenceInformationOrBuilder.getLInfComponentwisePrimalResidual

(

)

The maximum relative violation of any primal constraint, with an absolute
offset, i.e., the l_∞ norm of [violation / (eps_ratio + |bound|)] where
eps_ratio = eps_optimal_primal_residual_absolute
/ eps_optimal_primal_residual_relative
and bound is the violated bound.

optional double l_inf_componentwise_primal_residual = 24;

Returns

The lInfComponentwisePrimalResidual.

Implemented in com.google.ortools.pdlp.ConvergenceInformation.Builder, and com.google.ortools.pdlp.ConvergenceInformation.

getLInfDualResidual()

double com.google.ortools.pdlp.ConvergenceInformationOrBuilder.getLInfDualResidual

(

)

The maximum violation of any dual constraint, i.e., the l_∞ norm of the
violations.

optional double l_inf_dual_residual = 7;

Returns

The lInfDualResidual.

Implemented in com.google.ortools.pdlp.ConvergenceInformation.Builder, and com.google.ortools.pdlp.ConvergenceInformation.

getLInfDualVariable()

double com.google.ortools.pdlp.ConvergenceInformationOrBuilder.getLInfDualVariable

(

)

The maximum absolute value of the dual variables, i.e., the l_∞ norm. This
is useful to detect when the dual iterates are diverging. Divergence of the
dual variables could be an algorithmic issue, or indicate the primal is
infeasible.

optional double l_inf_dual_variable = 16;

Returns

The lInfDualVariable.

Implemented in com.google.ortools.pdlp.ConvergenceInformation.Builder, and com.google.ortools.pdlp.ConvergenceInformation.

getLInfPrimalResidual()

double com.google.ortools.pdlp.ConvergenceInformationOrBuilder.getLInfPrimalResidual

(

)

The maximum violation of any primal constraint, i.e., the l_∞ norm of the
violations.

optional double l_inf_primal_residual = 5;

Returns

The lInfPrimalResidual.

Implemented in com.google.ortools.pdlp.ConvergenceInformation.Builder, and com.google.ortools.pdlp.ConvergenceInformation.

getLInfPrimalVariable()

double com.google.ortools.pdlp.ConvergenceInformationOrBuilder.getLInfPrimalVariable

(

)

The maximum absolute value of the primal variables, i.e., the l_∞ norm.
This is useful to detect when the primal iterates are diverging. Divergence
of the primal variables could be an algorithmic issue, or indicate that the
dual is infeasible.

optional double l_inf_primal_variable = 14;

Returns

The lInfPrimalVariable.

Implemented in com.google.ortools.pdlp.ConvergenceInformation.Builder, and com.google.ortools.pdlp.ConvergenceInformation.

getPrimalObjective()

double com.google.ortools.pdlp.ConvergenceInformationOrBuilder.getPrimalObjective

(

)

The primal objective. The primal need not be feasible.

optional double primal_objective = 2;

Returns

The primalObjective.

Implemented in com.google.ortools.pdlp.ConvergenceInformation.Builder, and com.google.ortools.pdlp.ConvergenceInformation.

hasCandidateType()

boolean com.google.ortools.pdlp.ConvergenceInformationOrBuilder.hasCandidateType

(

)

Type of the candidate point described by this ConvergenceInformation.

optional .operations_research.pdlp.PointType candidate_type = 1;

Returns

Whether the candidateType field is set.

Implemented in com.google.ortools.pdlp.ConvergenceInformation.Builder, and com.google.ortools.pdlp.ConvergenceInformation.

hasCorrectedDualObjective()

boolean com.google.ortools.pdlp.ConvergenceInformationOrBuilder.hasCorrectedDualObjective

(

)

If possible (e.g., when all primal variables have lower and upper bounds),
a correct dual bound. The value is negative infinity if no corrected dual
bound is available.

optional double corrected_dual_objective = 4;

Returns

Whether the correctedDualObjective field is set.

Implemented in com.google.ortools.pdlp.ConvergenceInformation.Builder, and com.google.ortools.pdlp.ConvergenceInformation.

hasDualObjective()

boolean com.google.ortools.pdlp.ConvergenceInformationOrBuilder.hasDualObjective

(

)

The dual objective. The dual need not be feasible. The dual objective
includes the contributions from reduced costs.
NOTE: The definition of dual_objective changed in OR-tools version 9.8.
See
https://developers.google.com/optimization/lp/pdlp_math#reduced_costs_dual_residuals_and_the_corrected_dual_objective
for details.

optional double dual_objective = 3;

Returns

Whether the dualObjective field is set.

Implemented in com.google.ortools.pdlp.ConvergenceInformation.Builder, and com.google.ortools.pdlp.ConvergenceInformation.

hasL2DualResidual()

boolean com.google.ortools.pdlp.ConvergenceInformationOrBuilder.hasL2DualResidual

(

)

The l_2 norm of the violations of dual constraints.

optional double l2_dual_residual = 8;

Returns

Whether the l2DualResidual field is set.

Implemented in com.google.ortools.pdlp.ConvergenceInformation.Builder, and com.google.ortools.pdlp.ConvergenceInformation.

hasL2DualVariable()

boolean com.google.ortools.pdlp.ConvergenceInformationOrBuilder.hasL2DualVariable

(

)

The l_2 norm of the dual variables.

optional double l2_dual_variable = 17;

Returns

Whether the l2DualVariable field is set.

Implemented in com.google.ortools.pdlp.ConvergenceInformation.Builder, and com.google.ortools.pdlp.ConvergenceInformation.

hasL2PrimalResidual()

boolean com.google.ortools.pdlp.ConvergenceInformationOrBuilder.hasL2PrimalResidual

(

)

The l_2 norm of the violations of primal constraints.

optional double l2_primal_residual = 6;

Returns

Whether the l2PrimalResidual field is set.

Implemented in com.google.ortools.pdlp.ConvergenceInformation.Builder, and com.google.ortools.pdlp.ConvergenceInformation.

hasL2PrimalVariable()

boolean com.google.ortools.pdlp.ConvergenceInformationOrBuilder.hasL2PrimalVariable

(

)

The l_2 norm of the primal variables.

optional double l2_primal_variable = 15;

Returns

Whether the l2PrimalVariable field is set.

Implemented in com.google.ortools.pdlp.ConvergenceInformation.Builder, and com.google.ortools.pdlp.ConvergenceInformation.

hasLInfComponentwiseDualResidual()

boolean com.google.ortools.pdlp.ConvergenceInformationOrBuilder.hasLInfComponentwiseDualResidual

(

)

The maximum relative violation of any dual constraint, with an absolute
offset, i.e., the l_∞ norm of [violation / (eps_ratio + |objective|)] where
eps_ratio = eps_optimal_dual_residual_absolute
/ eps_optimal_dual_residual_relative

optional double l_inf_componentwise_dual_residual = 25;

Returns

Whether the lInfComponentwiseDualResidual field is set.

Implemented in com.google.ortools.pdlp.ConvergenceInformation.Builder, and com.google.ortools.pdlp.ConvergenceInformation.

hasLInfComponentwisePrimalResidual()

boolean com.google.ortools.pdlp.ConvergenceInformationOrBuilder.hasLInfComponentwisePrimalResidual

(

)

The maximum relative violation of any primal constraint, with an absolute
offset, i.e., the l_∞ norm of [violation / (eps_ratio + |bound|)] where
eps_ratio = eps_optimal_primal_residual_absolute
/ eps_optimal_primal_residual_relative
and bound is the violated bound.

optional double l_inf_componentwise_primal_residual = 24;

Returns

Whether the lInfComponentwisePrimalResidual field is set.

Implemented in com.google.ortools.pdlp.ConvergenceInformation.Builder, and com.google.ortools.pdlp.ConvergenceInformation.

hasLInfDualResidual()

boolean com.google.ortools.pdlp.ConvergenceInformationOrBuilder.hasLInfDualResidual

(

)

The maximum violation of any dual constraint, i.e., the l_∞ norm of the
violations.

optional double l_inf_dual_residual = 7;

Returns

Whether the lInfDualResidual field is set.

Implemented in com.google.ortools.pdlp.ConvergenceInformation.Builder, and com.google.ortools.pdlp.ConvergenceInformation.

hasLInfDualVariable()

boolean com.google.ortools.pdlp.ConvergenceInformationOrBuilder.hasLInfDualVariable

(

)

The maximum absolute value of the dual variables, i.e., the l_∞ norm. This
is useful to detect when the dual iterates are diverging. Divergence of the
dual variables could be an algorithmic issue, or indicate the primal is
infeasible.

optional double l_inf_dual_variable = 16;

Returns

Whether the lInfDualVariable field is set.

Implemented in com.google.ortools.pdlp.ConvergenceInformation.Builder, and com.google.ortools.pdlp.ConvergenceInformation.

hasLInfPrimalResidual()

boolean com.google.ortools.pdlp.ConvergenceInformationOrBuilder.hasLInfPrimalResidual

(

)

The maximum violation of any primal constraint, i.e., the l_∞ norm of the
violations.

optional double l_inf_primal_residual = 5;

Returns

Whether the lInfPrimalResidual field is set.

Implemented in com.google.ortools.pdlp.ConvergenceInformation.Builder, and com.google.ortools.pdlp.ConvergenceInformation.

hasLInfPrimalVariable()

boolean com.google.ortools.pdlp.ConvergenceInformationOrBuilder.hasLInfPrimalVariable

(

)

The maximum absolute value of the primal variables, i.e., the l_∞ norm.
This is useful to detect when the primal iterates are diverging. Divergence
of the primal variables could be an algorithmic issue, or indicate that the
dual is infeasible.

optional double l_inf_primal_variable = 14;

Returns

Whether the lInfPrimalVariable field is set.

Implemented in com.google.ortools.pdlp.ConvergenceInformation.Builder, and com.google.ortools.pdlp.ConvergenceInformation.

hasPrimalObjective()

boolean com.google.ortools.pdlp.ConvergenceInformationOrBuilder.hasPrimalObjective

(

)

The primal objective. The primal need not be feasible.

optional double primal_objective = 2;

Returns

Whether the primalObjective field is set.

Implemented in com.google.ortools.pdlp.ConvergenceInformation.Builder, and com.google.ortools.pdlp.ConvergenceInformation.

---

The documentation for this interface was generated from the following file:

• build/java/ortools-java/src/main/java/com/google/ortools/pdlp/ConvergenceInformationOrBuilder.java