Inheritance diagram for operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder:

Public Member Functions
Builder	clear ()

com.google.protobuf.Descriptors.Descriptor	getDescriptorForType ()

operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation	getDefaultInstanceForType ()

operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation	build ()

operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation	buildPartial ()

Builder	clone ()

Builder	setField (com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)

Builder	clearField (com.google.protobuf.Descriptors.FieldDescriptor field)

Builder	clearOneof (com.google.protobuf.Descriptors.OneofDescriptor oneof)

Builder	setRepeatedField (com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)

Builder	addRepeatedField (com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)

Builder	mergeFrom (com.google.protobuf.Message other)

Builder	mergeFrom (operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation other)

final boolean	isInitialized ()

Builder	mergeFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException

boolean	hasCandidateType ()

operations_research.pdlp.SolveLogOuterClass.PointType	getCandidateType ()

Builder	setCandidateType (operations_research.pdlp.SolveLogOuterClass.PointType value)

Builder	clearCandidateType ()

boolean	hasPrimalObjective ()

double	getPrimalObjective ()

Builder	setPrimalObjective (double value)

Builder	clearPrimalObjective ()

boolean	hasDualObjective ()

double	getDualObjective ()

Builder	setDualObjective (double value)

Builder	clearDualObjective ()

boolean	hasCorrectedDualObjective ()

double	getCorrectedDualObjective ()

Builder	setCorrectedDualObjective (double value)

Builder	clearCorrectedDualObjective ()

boolean	hasLInfPrimalResidual ()

double	getLInfPrimalResidual ()

Builder	setLInfPrimalResidual (double value)

Builder	clearLInfPrimalResidual ()

boolean	hasL2PrimalResidual ()

double	getL2PrimalResidual ()

Builder	setL2PrimalResidual (double value)

Builder	clearL2PrimalResidual ()

boolean	hasLInfComponentwisePrimalResidual ()

double	getLInfComponentwisePrimalResidual ()

Builder	setLInfComponentwisePrimalResidual (double value)

Builder	clearLInfComponentwisePrimalResidual ()

boolean	hasLInfDualResidual ()

double	getLInfDualResidual ()

Builder	setLInfDualResidual (double value)

Builder	clearLInfDualResidual ()

boolean	hasL2DualResidual ()

double	getL2DualResidual ()

Builder	setL2DualResidual (double value)

Builder	clearL2DualResidual ()

boolean	hasLInfComponentwiseDualResidual ()

double	getLInfComponentwiseDualResidual ()

Builder	setLInfComponentwiseDualResidual (double value)

Builder	clearLInfComponentwiseDualResidual ()

boolean	hasLInfPrimalVariable ()

double	getLInfPrimalVariable ()

Builder	setLInfPrimalVariable (double value)

Builder	clearLInfPrimalVariable ()

boolean	hasL2PrimalVariable ()

double	getL2PrimalVariable ()

Builder	setL2PrimalVariable (double value)

Builder	clearL2PrimalVariable ()

boolean	hasLInfDualVariable ()

double	getLInfDualVariable ()

Builder	setLInfDualVariable (double value)

Builder	clearLInfDualVariable ()

boolean	hasL2DualVariable ()

double	getL2DualVariable ()

Builder	setL2DualVariable (double value)

Builder	clearL2DualVariable ()

final Builder	setUnknownFields (final com.google.protobuf.UnknownFieldSet unknownFields)

final Builder	mergeUnknownFields (final com.google.protobuf.UnknownFieldSet unknownFields)

Static Public Member Functions
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor ()

Protected Member Functions
com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable ()

Detailed Description

Information measuring how close a candidate is to establishing feasibility
and optimality; see also TerminationCriteria.

Protobuf type operations_research.pdlp.ConvergenceInformation

Definition at line 5918 of file SolveLogOuterClass.java.

Member Function Documentation

◆ addRepeatedField()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.addRepeatedField	(	com.google.protobuf.Descriptors.FieldDescriptor	field,
		java.lang.Object	value )

Definition at line 6083 of file SolveLogOuterClass.java.

◆ build()

operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.build ( )

Definition at line 5978 of file SolveLogOuterClass.java.

◆ buildPartial()

operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.buildPartial ( )

Definition at line 5987 of file SolveLogOuterClass.java.

◆ clear()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.clear ( )

Definition at line 5946 of file SolveLogOuterClass.java.

◆ clearCandidateType()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.clearCandidateType ( )

Type of the candidate point described by this ConvergenceInformation.

optional .operations_research.pdlp.PointType candidate_type = 1;

Returns: This builder for chaining.

Definition at line 6313 of file SolveLogOuterClass.java.

◆ clearCorrectedDualObjective()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.clearCorrectedDualObjective ( )

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: This builder for chaining.

Definition at line 6509 of file SolveLogOuterClass.java.

◆ clearDualObjective()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.clearDualObjective ( )

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: This builder for chaining.

Definition at line 6445 of file SolveLogOuterClass.java.

◆ clearField()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.clearField ( com.google.protobuf.Descriptors.FieldDescriptor field )

Definition at line 6067 of file SolveLogOuterClass.java.

◆ clearL2DualResidual()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.clearL2DualResidual ( )

The l_2 norm of the violations of dual constraints.

optional double l2_dual_residual = 8;

Returns: This builder for chaining.

Definition at line 6813 of file SolveLogOuterClass.java.

◆ clearL2DualVariable()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.clearL2DualVariable ( )

The l_2 norm of the dual variables.

optional double l2_dual_variable = 17;

Returns: This builder for chaining.

Definition at line 7129 of file SolveLogOuterClass.java.

◆ clearL2PrimalResidual()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.clearL2PrimalResidual ( )

The l_2 norm of the violations of primal constraints.

optional double l2_primal_residual = 6;

Returns: This builder for chaining.

Definition at line 6625 of file SolveLogOuterClass.java.

◆ clearL2PrimalVariable()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.clearL2PrimalVariable ( )

The l_2 norm of the primal variables.

optional double l2_primal_variable = 15;

Returns: This builder for chaining.

Definition at line 7005 of file SolveLogOuterClass.java.

◆ clearLInfComponentwiseDualResidual()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.clearLInfComponentwiseDualResidual ( )

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: This builder for chaining.

Definition at line 6881 of file SolveLogOuterClass.java.

◆ clearLInfComponentwisePrimalResidual()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.clearLInfComponentwisePrimalResidual ( )

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: This builder for chaining.

Definition at line 6697 of file SolveLogOuterClass.java.

◆ clearLInfDualResidual()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.clearLInfDualResidual ( )

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

optional double l_inf_dual_residual = 7;

Returns: This builder for chaining.

Definition at line 6757 of file SolveLogOuterClass.java.

◆ clearLInfDualVariable()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.clearLInfDualVariable ( )

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: This builder for chaining.

Definition at line 7073 of file SolveLogOuterClass.java.

◆ clearLInfPrimalResidual()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.clearLInfPrimalResidual ( )

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

optional double l_inf_primal_residual = 5;

Returns: This builder for chaining.

Definition at line 6569 of file SolveLogOuterClass.java.

◆ clearLInfPrimalVariable()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.clearLInfPrimalVariable ( )

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: This builder for chaining.

Definition at line 6949 of file SolveLogOuterClass.java.

◆ clearOneof()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.clearOneof ( com.google.protobuf.Descriptors.OneofDescriptor oneof )

Definition at line 6072 of file SolveLogOuterClass.java.

◆ clearPrimalObjective()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.clearPrimalObjective ( )

The primal objective. The primal need not be feasible.

optional double primal_objective = 2;

Returns: This builder for chaining.

Definition at line 6369 of file SolveLogOuterClass.java.

◆ clone()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.clone ( )

Definition at line 6057 of file SolveLogOuterClass.java.

◆ getCandidateType()

operations_research.pdlp.SolveLogOuterClass.PointType operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.getCandidateType ( )

Type of the candidate point described by this ConvergenceInformation.

optional .operations_research.pdlp.PointType candidate_type = 1;

Returns: The candidateType.

Implements operations_research.pdlp.SolveLogOuterClass.ConvergenceInformationOrBuilder.

Definition at line 6283 of file SolveLogOuterClass.java.

◆ getCorrectedDualObjective()

double operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.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.

Implements operations_research.pdlp.SolveLogOuterClass.ConvergenceInformationOrBuilder.

Definition at line 6478 of file SolveLogOuterClass.java.

◆ getDefaultInstanceForType()

operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.getDefaultInstanceForType ( )

Definition at line 5973 of file SolveLogOuterClass.java.

◆ getDescriptor()

static final com.google.protobuf.Descriptors.Descriptor operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.getDescriptor ( )

static

Definition at line 5923 of file SolveLogOuterClass.java.

◆ getDescriptorForType()

com.google.protobuf.Descriptors.Descriptor operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.getDescriptorForType ( )

Definition at line 5968 of file SolveLogOuterClass.java.

◆ getDualObjective()

double operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.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.

Implements operations_research.pdlp.SolveLogOuterClass.ConvergenceInformationOrBuilder.

Definition at line 6408 of file SolveLogOuterClass.java.

◆ getL2DualResidual()

double operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.getL2DualResidual ( )

The l_2 norm of the violations of dual constraints.

optional double l2_dual_residual = 8;

Returns: The l2DualResidual.

Implements operations_research.pdlp.SolveLogOuterClass.ConvergenceInformationOrBuilder.

Definition at line 6786 of file SolveLogOuterClass.java.

◆ getL2DualVariable()

double operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.getL2DualVariable ( )

The l_2 norm of the dual variables.

optional double l2_dual_variable = 17;

Returns: The l2DualVariable.

Implements operations_research.pdlp.SolveLogOuterClass.ConvergenceInformationOrBuilder.

Definition at line 7102 of file SolveLogOuterClass.java.

◆ getL2PrimalResidual()

double operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.getL2PrimalResidual ( )

The l_2 norm of the violations of primal constraints.

optional double l2_primal_residual = 6;

Returns: The l2PrimalResidual.

Implements operations_research.pdlp.SolveLogOuterClass.ConvergenceInformationOrBuilder.

Definition at line 6598 of file SolveLogOuterClass.java.

◆ getL2PrimalVariable()

double operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.getL2PrimalVariable ( )

The l_2 norm of the primal variables.

optional double l2_primal_variable = 15;

Returns: The l2PrimalVariable.

Implements operations_research.pdlp.SolveLogOuterClass.ConvergenceInformationOrBuilder.

Definition at line 6978 of file SolveLogOuterClass.java.

◆ getLInfComponentwiseDualResidual()

double operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.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.

Implements operations_research.pdlp.SolveLogOuterClass.ConvergenceInformationOrBuilder.

Definition at line 6848 of file SolveLogOuterClass.java.

◆ getLInfComponentwisePrimalResidual()

double operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.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.

Implements operations_research.pdlp.SolveLogOuterClass.ConvergenceInformationOrBuilder.

Definition at line 6662 of file SolveLogOuterClass.java.

◆ getLInfDualResidual()

double operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.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.

Implements operations_research.pdlp.SolveLogOuterClass.ConvergenceInformationOrBuilder.

Definition at line 6728 of file SolveLogOuterClass.java.

◆ getLInfDualVariable()

double operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.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.

Implements operations_research.pdlp.SolveLogOuterClass.ConvergenceInformationOrBuilder.

Definition at line 7040 of file SolveLogOuterClass.java.

◆ getLInfPrimalResidual()

double operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.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.

Implements operations_research.pdlp.SolveLogOuterClass.ConvergenceInformationOrBuilder.

Definition at line 6540 of file SolveLogOuterClass.java.

◆ getLInfPrimalVariable()

double operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.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.

Implements operations_research.pdlp.SolveLogOuterClass.ConvergenceInformationOrBuilder.

Definition at line 6916 of file SolveLogOuterClass.java.

◆ getPrimalObjective()

double operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.getPrimalObjective ( )

The primal objective. The primal need not be feasible.

optional double primal_objective = 2;

Returns: The primalObjective.

Implements operations_research.pdlp.SolveLogOuterClass.ConvergenceInformationOrBuilder.

Definition at line 6342 of file SolveLogOuterClass.java.

◆ hasCandidateType()

boolean operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.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.

Implements operations_research.pdlp.SolveLogOuterClass.ConvergenceInformationOrBuilder.

Definition at line 6271 of file SolveLogOuterClass.java.

◆ hasCorrectedDualObjective()

boolean operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.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.

Implements operations_research.pdlp.SolveLogOuterClass.ConvergenceInformationOrBuilder.

Definition at line 6464 of file SolveLogOuterClass.java.

◆ hasDualObjective()

boolean operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.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.

Implements operations_research.pdlp.SolveLogOuterClass.ConvergenceInformationOrBuilder.

Definition at line 6391 of file SolveLogOuterClass.java.

◆ hasL2DualResidual()

boolean operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.hasL2DualResidual ( )

The l_2 norm of the violations of dual constraints.

optional double l2_dual_residual = 8;

Returns: Whether the l2DualResidual field is set.

Implements operations_research.pdlp.SolveLogOuterClass.ConvergenceInformationOrBuilder.

Definition at line 6774 of file SolveLogOuterClass.java.

◆ hasL2DualVariable()

boolean operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.hasL2DualVariable ( )

The l_2 norm of the dual variables.

optional double l2_dual_variable = 17;

Returns: Whether the l2DualVariable field is set.

Implements operations_research.pdlp.SolveLogOuterClass.ConvergenceInformationOrBuilder.

Definition at line 7090 of file SolveLogOuterClass.java.

◆ hasL2PrimalResidual()

boolean operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.hasL2PrimalResidual ( )

The l_2 norm of the violations of primal constraints.

optional double l2_primal_residual = 6;

Returns: Whether the l2PrimalResidual field is set.

Implements operations_research.pdlp.SolveLogOuterClass.ConvergenceInformationOrBuilder.

Definition at line 6586 of file SolveLogOuterClass.java.

◆ hasL2PrimalVariable()

boolean operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.hasL2PrimalVariable ( )

The l_2 norm of the primal variables.

optional double l2_primal_variable = 15;

Returns: Whether the l2PrimalVariable field is set.

Implements operations_research.pdlp.SolveLogOuterClass.ConvergenceInformationOrBuilder.

Definition at line 6966 of file SolveLogOuterClass.java.

◆ hasLInfComponentwiseDualResidual()

boolean operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.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.

Implements operations_research.pdlp.SolveLogOuterClass.ConvergenceInformationOrBuilder.

Definition at line 6833 of file SolveLogOuterClass.java.

◆ hasLInfComponentwisePrimalResidual()

boolean operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.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.

Implements operations_research.pdlp.SolveLogOuterClass.ConvergenceInformationOrBuilder.

Definition at line 6646 of file SolveLogOuterClass.java.

◆ hasLInfDualResidual()

boolean operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.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.

Implements operations_research.pdlp.SolveLogOuterClass.ConvergenceInformationOrBuilder.

Definition at line 6715 of file SolveLogOuterClass.java.

◆ hasLInfDualVariable()

boolean operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.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.

Implements operations_research.pdlp.SolveLogOuterClass.ConvergenceInformationOrBuilder.

Definition at line 7025 of file SolveLogOuterClass.java.

◆ hasLInfPrimalResidual()

boolean operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.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.

Implements operations_research.pdlp.SolveLogOuterClass.ConvergenceInformationOrBuilder.

Definition at line 6527 of file SolveLogOuterClass.java.

◆ hasLInfPrimalVariable()

boolean operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.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.

Implements operations_research.pdlp.SolveLogOuterClass.ConvergenceInformationOrBuilder.

Definition at line 6901 of file SolveLogOuterClass.java.

◆ hasPrimalObjective()

boolean operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.hasPrimalObjective ( )

The primal objective. The primal need not be feasible.

optional double primal_objective = 2;

Returns: Whether the primalObjective field is set.

Implements operations_research.pdlp.SolveLogOuterClass.ConvergenceInformationOrBuilder.

Definition at line 6330 of file SolveLogOuterClass.java.

◆ internalGetFieldAccessorTable()

com.google.protobuf.GeneratedMessageV3.FieldAccessorTable operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.internalGetFieldAccessorTable ( )

protected

Definition at line 5929 of file SolveLogOuterClass.java.

◆ isInitialized()

final boolean operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.isInitialized ( )

Definition at line 6148 of file SolveLogOuterClass.java.

◆ mergeFrom() [1/3]

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.mergeFrom	(	com.google.protobuf.CodedInputStream	input,
		com.google.protobuf.ExtensionRegistryLite	extensionRegistry ) throws java.io.IOException

Definition at line 6153 of file SolveLogOuterClass.java.

◆ mergeFrom() [2/3]

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.mergeFrom ( com.google.protobuf.Message other )

Definition at line 6089 of file SolveLogOuterClass.java.

◆ mergeFrom() [3/3]

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.mergeFrom ( operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation other )

Definition at line 6098 of file SolveLogOuterClass.java.

◆ mergeUnknownFields()

final Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.mergeUnknownFields ( final com.google.protobuf.UnknownFieldSet unknownFields )

Definition at line 7142 of file SolveLogOuterClass.java.

◆ setCandidateType()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.setCandidateType ( operations_research.pdlp.SolveLogOuterClass.PointType value )

Type of the candidate point described by this ConvergenceInformation.

optional .operations_research.pdlp.PointType candidate_type = 1;

Parameters

value The candidateType to set.

Returns: This builder for chaining.

Definition at line 6296 of file SolveLogOuterClass.java.

◆ setCorrectedDualObjective()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.setCorrectedDualObjective ( double value )

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;

Parameters

value The correctedDualObjective to set.

Returns: This builder for chaining.

Definition at line 6492 of file SolveLogOuterClass.java.

◆ setDualObjective()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.setDualObjective ( double value )

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;

Parameters

value The dualObjective to set.

Returns: This builder for chaining.

Definition at line 6425 of file SolveLogOuterClass.java.

◆ setField()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.setField	(	com.google.protobuf.Descriptors.FieldDescriptor	field,
		java.lang.Object	value )

Definition at line 6061 of file SolveLogOuterClass.java.

◆ setL2DualResidual()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.setL2DualResidual ( double value )

The l_2 norm of the violations of dual constraints.

optional double l2_dual_residual = 8;

Parameters

value The l2DualResidual to set.

Returns: This builder for chaining.

Definition at line 6798 of file SolveLogOuterClass.java.

◆ setL2DualVariable()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.setL2DualVariable ( double value )

The l_2 norm of the dual variables.

optional double l2_dual_variable = 17;

Parameters

value The l2DualVariable to set.

Returns: This builder for chaining.

Definition at line 7114 of file SolveLogOuterClass.java.

◆ setL2PrimalResidual()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.setL2PrimalResidual ( double value )

The l_2 norm of the violations of primal constraints.

optional double l2_primal_residual = 6;

Parameters

value The l2PrimalResidual to set.

Returns: This builder for chaining.

Definition at line 6610 of file SolveLogOuterClass.java.

◆ setL2PrimalVariable()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.setL2PrimalVariable ( double value )

The l_2 norm of the primal variables.

optional double l2_primal_variable = 15;

Parameters

value The l2PrimalVariable to set.

Returns: This builder for chaining.

Definition at line 6990 of file SolveLogOuterClass.java.

◆ setLInfComponentwiseDualResidual()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.setLInfComponentwiseDualResidual ( double value )

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;

Parameters

value The lInfComponentwiseDualResidual to set.

Returns: This builder for chaining.

Definition at line 6863 of file SolveLogOuterClass.java.

◆ setLInfComponentwisePrimalResidual()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.setLInfComponentwisePrimalResidual ( double value )

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;

Parameters

value The lInfComponentwisePrimalResidual to set.

Returns: This builder for chaining.

Definition at line 6678 of file SolveLogOuterClass.java.

◆ setLInfDualResidual()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.setLInfDualResidual ( double value )

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

optional double l_inf_dual_residual = 7;

Parameters

value The lInfDualResidual to set.

Returns: This builder for chaining.

Definition at line 6741 of file SolveLogOuterClass.java.

◆ setLInfDualVariable()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.setLInfDualVariable ( double value )

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;

Parameters

value The lInfDualVariable to set.

Returns: This builder for chaining.

Definition at line 7055 of file SolveLogOuterClass.java.

◆ setLInfPrimalResidual()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.setLInfPrimalResidual ( double value )

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

optional double l_inf_primal_residual = 5;

Parameters

value The lInfPrimalResidual to set.

Returns: This builder for chaining.

Definition at line 6553 of file SolveLogOuterClass.java.

◆ setLInfPrimalVariable()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.setLInfPrimalVariable ( double value )

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;

Parameters

value The lInfPrimalVariable to set.

Returns: This builder for chaining.

Definition at line 6931 of file SolveLogOuterClass.java.

◆ setPrimalObjective()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.setPrimalObjective ( double value )

The primal objective. The primal need not be feasible.

optional double primal_objective = 2;

Parameters

value The primalObjective to set.

Returns: This builder for chaining.

Definition at line 6354 of file SolveLogOuterClass.java.

◆ setRepeatedField()

Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.setRepeatedField	(	com.google.protobuf.Descriptors.FieldDescriptor	field,
		int	index,
		java.lang.Object	value )

Definition at line 6077 of file SolveLogOuterClass.java.

◆ setUnknownFields()

final Builder operations_research.pdlp.SolveLogOuterClass.ConvergenceInformation.Builder.setUnknownFields ( final com.google.protobuf.UnknownFieldSet unknownFields )

Definition at line 7136 of file SolveLogOuterClass.java.

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

build/java/ortools-java/src/main/java/operations_research/pdlp/SolveLogOuterClass.java

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ addRepeatedField()

◆ build()

◆ buildPartial()

◆ clear()

◆ clearCandidateType()

◆ clearCorrectedDualObjective()

◆ clearDualObjective()

◆ clearField()

◆ clearL2DualResidual()

◆ clearL2DualVariable()

◆ clearL2PrimalResidual()

◆ clearL2PrimalVariable()

◆ clearLInfComponentwiseDualResidual()

◆ clearLInfComponentwisePrimalResidual()

◆ clearLInfDualResidual()

◆ clearLInfDualVariable()

◆ clearLInfPrimalResidual()

◆ clearLInfPrimalVariable()

◆ clearOneof()

◆ clearPrimalObjective()

◆ clone()

◆ getCandidateType()

◆ getCorrectedDualObjective()

◆ getDefaultInstanceForType()

◆ getDescriptor()

◆ getDescriptorForType()

◆ getDualObjective()

◆ getL2DualResidual()

◆ getL2DualVariable()

◆ getL2PrimalResidual()

◆ getL2PrimalVariable()

◆ getLInfComponentwiseDualResidual()

◆ getLInfComponentwisePrimalResidual()

◆ getLInfDualResidual()

◆ getLInfDualVariable()

◆ getLInfPrimalResidual()

◆ getLInfPrimalVariable()

◆ getPrimalObjective()

◆ hasCandidateType()

◆ hasCorrectedDualObjective()

◆ hasDualObjective()

◆ hasL2DualResidual()

◆ hasL2DualVariable()

◆ hasL2PrimalResidual()

◆ hasL2PrimalVariable()

◆ hasLInfComponentwiseDualResidual()

◆ hasLInfComponentwisePrimalResidual()

◆ hasLInfDualResidual()

◆ hasLInfDualVariable()

◆ hasLInfPrimalResidual()

◆ hasLInfPrimalVariable()

◆ hasPrimalObjective()

◆ internalGetFieldAccessorTable()

◆ isInitialized()

◆ mergeFrom() [1/3]

◆ mergeFrom() [2/3]

◆ mergeFrom() [3/3]

◆ mergeUnknownFields()

◆ setCandidateType()

◆ setCorrectedDualObjective()

◆ setDualObjective()

◆ setField()

◆ setL2DualResidual()

◆ setL2DualVariable()

◆ setL2PrimalResidual()

◆ setL2PrimalVariable()

◆ setLInfComponentwiseDualResidual()

◆ setLInfComponentwisePrimalResidual()

◆ setLInfDualResidual()

◆ setLInfDualVariable()

◆ setLInfPrimalResidual()

◆ setLInfPrimalVariable()

◆ setPrimalObjective()

◆ setRepeatedField()

◆ setUnknownFields()