ConvergenceInformationOrBuilder (com.google.ortools:ortools-java 9.12.9999 API)

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ConvergenceInformation, ConvergenceInformation.Builder
```
public interface ConvergenceInformationOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`PointType`	`getCandidateType()` Type of the candidate point described by this ConvergenceInformation.
`double`	`getCorrectedDualObjective()` If possible (e.g., when all primal variables have lower and upper bounds), a correct dual bound.
`double`	`getDualObjective()` The dual objective.
`double`	`getL2DualResidual()` The l_2 norm of the violations of dual constraints.
`double`	`getL2DualVariable()` The l_2 norm of the dual variables.
`double`	`getL2PrimalResidual()` The l_2 norm of the violations of primal constraints.
`double`	`getL2PrimalVariable()` The l_2 norm of the primal variables.
`double`	`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;`
`double`	`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.
`double`	`getLInfDualResidual()` The maximum violation of any dual constraint, i.e., the l_∞ norm of the violations.
`double`	`getLInfDualVariable()` The maximum absolute value of the dual variables, i.e., the l_∞ norm.
`double`	`getLInfPrimalResidual()` The maximum violation of any primal constraint, i.e., the l_∞ norm of the violations.
`double`	`getLInfPrimalVariable()` The maximum absolute value of the primal variables, i.e., the l_∞ norm.
`double`	`getPrimalObjective()` The primal objective.
`boolean`	`hasCandidateType()` Type of the candidate point described by this ConvergenceInformation.
`boolean`	`hasCorrectedDualObjective()` If possible (e.g., when all primal variables have lower and upper bounds), a correct dual bound.
`boolean`	`hasDualObjective()` The dual objective.
`boolean`	`hasL2DualResidual()` The l_2 norm of the violations of dual constraints.
`boolean`	`hasL2DualVariable()` The l_2 norm of the dual variables.
`boolean`	`hasL2PrimalResidual()` The l_2 norm of the violations of primal constraints.
`boolean`	`hasL2PrimalVariable()` The l_2 norm of the primal variables.
`boolean`	`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;`
`boolean`	`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.
`boolean`	`hasLInfDualResidual()` The maximum violation of any dual constraint, i.e., the l_∞ norm of the violations.
`boolean`	`hasLInfDualVariable()` The maximum absolute value of the dual variables, i.e., the l_∞ norm.
`boolean`	`hasLInfPrimalResidual()` The maximum violation of any primal constraint, i.e., the l_∞ norm of the violations.
`boolean`	`hasLInfPrimalVariable()` The maximum absolute value of the primal variables, i.e., the l_∞ norm.
`boolean`	`hasPrimalObjective()` The primal objective.

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Method Detail

hasCandidateType
```
boolean 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.

getCandidateType

PointType getCandidateType()

 Type of the candidate point described by this ConvergenceInformation.

optional .operations_research.pdlp.PointType candidate_type = 1;

Returns:: The candidateType.

hasPrimalObjective
```
boolean hasPrimalObjective()
```
```
 The primal objective. The primal need not be feasible.
 
```
optional double primal_objective = 2;
Returns:

Whether the primalObjective field is set.

getPrimalObjective

double getPrimalObjective()

 The primal objective. The primal need not be feasible.

optional double primal_objective = 2;

Returns:: The primalObjective.

hasDualObjective

boolean 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.

getDualObjective

double 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.

hasCorrectedDualObjective

boolean 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.

getCorrectedDualObjective

double 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.

hasLInfPrimalResidual

boolean 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.

getLInfPrimalResidual

double 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.

hasL2PrimalResidual
```
boolean hasL2PrimalResidual()
```
```
 The l_2 norm of the violations of primal constraints.
 
```
optional double l2_primal_residual = 6;
Returns:

Whether the l2PrimalResidual field is set.

getL2PrimalResidual

double getL2PrimalResidual()

 The l_2 norm of the violations of primal constraints.

optional double l2_primal_residual = 6;

Returns:: The l2PrimalResidual.

hasLInfComponentwisePrimalResidual

boolean 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.

getLInfComponentwisePrimalResidual

double 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.

hasLInfDualResidual

boolean 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.

getLInfDualResidual

double 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.

hasL2DualResidual
```
boolean hasL2DualResidual()
```
```
 The l_2 norm of the violations of dual constraints.
 
```
optional double l2_dual_residual = 8;
Returns:

Whether the l2DualResidual field is set.

getL2DualResidual

double getL2DualResidual()

 The l_2 norm of the violations of dual constraints.

optional double l2_dual_residual = 8;

Returns:: The l2DualResidual.

hasLInfComponentwiseDualResidual

boolean 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.

getLInfComponentwiseDualResidual

double 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.

hasLInfPrimalVariable

boolean 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.

getLInfPrimalVariable

double 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.

hasL2PrimalVariable
```
boolean hasL2PrimalVariable()
```
```
 The l_2 norm of the primal variables.
 
```
optional double l2_primal_variable = 15;
Returns:

Whether the l2PrimalVariable field is set.

getL2PrimalVariable
```
double getL2PrimalVariable()
```
```
 The l_2 norm of the primal variables.
 
```
optional double l2_primal_variable = 15;
Returns:

The l2PrimalVariable.

hasLInfDualVariable

boolean 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.

getLInfDualVariable

double 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.

hasL2DualVariable
```
boolean hasL2DualVariable()
```
```
 The l_2 norm of the dual variables.
 
```
optional double l2_dual_variable = 17;
Returns:

Whether the l2DualVariable field is set.

getL2DualVariable
```
double getL2DualVariable()
```
```
 The l_2 norm of the dual variables.
 
```
optional double l2_dual_variable = 17;
Returns:

The l2DualVariable.

Interface ConvergenceInformationOrBuilder

Method Summary

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder