![]() |
Google OR-Tools v9.14
a fast and portable software suite for combinatorial optimization
|
Information measuring how close a candidate is to establishing feasibility and optimality; see also TerminationCriteria.
Protobuf type operations_research.pdlp.ConvergenceInformation
Definition at line 17 of file ConvergenceInformation.java.
Classes | |
class | Builder |
Static Public Member Functions | |
static final com.google.protobuf.Descriptors.Descriptor | getDescriptor () |
static com.google.ortools.pdlp.ConvergenceInformation | parseFrom (java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException |
static com.google.ortools.pdlp.ConvergenceInformation | parseFrom (java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException |
static com.google.ortools.pdlp.ConvergenceInformation | parseFrom (com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException |
static com.google.ortools.pdlp.ConvergenceInformation | parseFrom (com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException |
static com.google.ortools.pdlp.ConvergenceInformation | parseFrom (byte[] data) throws com.google.protobuf.InvalidProtocolBufferException |
static com.google.ortools.pdlp.ConvergenceInformation | parseFrom (byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException |
static com.google.ortools.pdlp.ConvergenceInformation | parseFrom (java.io.InputStream input) throws java.io.IOException |
static com.google.ortools.pdlp.ConvergenceInformation | parseFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException |
static com.google.ortools.pdlp.ConvergenceInformation | parseDelimitedFrom (java.io.InputStream input) throws java.io.IOException |
static com.google.ortools.pdlp.ConvergenceInformation | parseDelimitedFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException |
static com.google.ortools.pdlp.ConvergenceInformation | parseFrom (com.google.protobuf.CodedInputStream input) throws java.io.IOException |
static com.google.ortools.pdlp.ConvergenceInformation | parseFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException |
static Builder | newBuilder () |
static Builder | newBuilder (com.google.ortools.pdlp.ConvergenceInformation prototype) |
static com.google.ortools.pdlp.ConvergenceInformation | getDefaultInstance () |
static com.google.protobuf.Parser< ConvergenceInformation > | parser () |
Static Public Attributes | |
static final int | CANDIDATE_TYPE_FIELD_NUMBER = 1 |
static final int | PRIMAL_OBJECTIVE_FIELD_NUMBER = 2 |
static final int | DUAL_OBJECTIVE_FIELD_NUMBER = 3 |
static final int | CORRECTED_DUAL_OBJECTIVE_FIELD_NUMBER = 4 |
static final int | L_INF_PRIMAL_RESIDUAL_FIELD_NUMBER = 5 |
static final int | L2_PRIMAL_RESIDUAL_FIELD_NUMBER = 6 |
static final int | L_INF_COMPONENTWISE_PRIMAL_RESIDUAL_FIELD_NUMBER = 24 |
static final int | L_INF_DUAL_RESIDUAL_FIELD_NUMBER = 7 |
static final int | L2_DUAL_RESIDUAL_FIELD_NUMBER = 8 |
static final int | L_INF_COMPONENTWISE_DUAL_RESIDUAL_FIELD_NUMBER = 25 |
static final int | L_INF_PRIMAL_VARIABLE_FIELD_NUMBER = 14 |
static final int | L2_PRIMAL_VARIABLE_FIELD_NUMBER = 15 |
static final int | L_INF_DUAL_VARIABLE_FIELD_NUMBER = 16 |
static final int | L2_DUAL_VARIABLE_FIELD_NUMBER = 17 |
Protected Member Functions | |
com.google.protobuf.GeneratedMessage.FieldAccessorTable | internalGetFieldAccessorTable () |
Builder | newBuilderForType (com.google.protobuf.GeneratedMessage.BuilderParent parent) |
boolean com.google.ortools.pdlp.ConvergenceInformation.equals | ( | final java.lang.Object | obj | ) |
Definition at line 601 of file ConvergenceInformation.java.
com.google.ortools.pdlp.PointType com.google.ortools.pdlp.ConvergenceInformation.getCandidateType | ( | ) |
Type of the candidate point described by this ConvergenceInformation.
optional .operations_research.pdlp.PointType candidate_type = 1;
Implements com.google.ortools.pdlp.ConvergenceInformationOrBuilder.
Definition at line 74 of file ConvergenceInformation.java.
double com.google.ortools.pdlp.ConvergenceInformation.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;
Implements com.google.ortools.pdlp.ConvergenceInformationOrBuilder.
Definition at line 170 of file ConvergenceInformation.java.
|
static |
Definition at line 2070 of file ConvergenceInformation.java.
com.google.ortools.pdlp.ConvergenceInformation com.google.ortools.pdlp.ConvergenceInformation.getDefaultInstanceForType | ( | ) |
Definition at line 2106 of file ConvergenceInformation.java.
|
static |
Definition at line 40 of file ConvergenceInformation.java.
double com.google.ortools.pdlp.ConvergenceInformation.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;
Implements com.google.ortools.pdlp.ConvergenceInformationOrBuilder.
Definition at line 139 of file ConvergenceInformation.java.
double com.google.ortools.pdlp.ConvergenceInformation.getL2DualResidual | ( | ) |
The l_2 norm of the violations of dual constraints.
optional double l2_dual_residual = 8;
Implements com.google.ortools.pdlp.ConvergenceInformationOrBuilder.
Definition at line 317 of file ConvergenceInformation.java.
double com.google.ortools.pdlp.ConvergenceInformation.getL2DualVariable | ( | ) |
The l_2 norm of the dual variables.
optional double l2_dual_variable = 17;
Implements com.google.ortools.pdlp.ConvergenceInformationOrBuilder.
Definition at line 470 of file ConvergenceInformation.java.
double com.google.ortools.pdlp.ConvergenceInformation.getL2PrimalResidual | ( | ) |
The l_2 norm of the violations of primal constraints.
optional double l2_primal_residual = 6;
Implements com.google.ortools.pdlp.ConvergenceInformationOrBuilder.
Definition at line 226 of file ConvergenceInformation.java.
double com.google.ortools.pdlp.ConvergenceInformation.getL2PrimalVariable | ( | ) |
The l_2 norm of the primal variables.
optional double l2_primal_variable = 15;
Implements com.google.ortools.pdlp.ConvergenceInformationOrBuilder.
Definition at line 410 of file ConvergenceInformation.java.
double com.google.ortools.pdlp.ConvergenceInformation.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;
Implements com.google.ortools.pdlp.ConvergenceInformationOrBuilder.
Definition at line 350 of file ConvergenceInformation.java.
double com.google.ortools.pdlp.ConvergenceInformation.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;
Implements com.google.ortools.pdlp.ConvergenceInformationOrBuilder.
Definition at line 261 of file ConvergenceInformation.java.
double com.google.ortools.pdlp.ConvergenceInformation.getLInfDualResidual | ( | ) |
The maximum violation of any dual constraint, i.e., the l_∞ norm of the violations.
optional double l_inf_dual_residual = 7;
Implements com.google.ortools.pdlp.ConvergenceInformationOrBuilder.
Definition at line 290 of file ConvergenceInformation.java.
double com.google.ortools.pdlp.ConvergenceInformation.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;
Implements com.google.ortools.pdlp.ConvergenceInformationOrBuilder.
Definition at line 443 of file ConvergenceInformation.java.
double com.google.ortools.pdlp.ConvergenceInformation.getLInfPrimalResidual | ( | ) |
The maximum violation of any primal constraint, i.e., the l_∞ norm of the violations.
optional double l_inf_primal_residual = 5;
Implements com.google.ortools.pdlp.ConvergenceInformationOrBuilder.
Definition at line 199 of file ConvergenceInformation.java.
double com.google.ortools.pdlp.ConvergenceInformation.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;
Implements com.google.ortools.pdlp.ConvergenceInformationOrBuilder.
Definition at line 383 of file ConvergenceInformation.java.
com.google.protobuf.Parser< ConvergenceInformation > com.google.ortools.pdlp.ConvergenceInformation.getParserForType | ( | ) |
Definition at line 2101 of file ConvergenceInformation.java.
double com.google.ortools.pdlp.ConvergenceInformation.getPrimalObjective | ( | ) |
The primal objective. The primal need not be feasible.
optional double primal_objective = 2;
Implements com.google.ortools.pdlp.ConvergenceInformationOrBuilder.
Definition at line 102 of file ConvergenceInformation.java.
int com.google.ortools.pdlp.ConvergenceInformation.getSerializedSize | ( | ) |
Definition at line 534 of file ConvergenceInformation.java.
boolean com.google.ortools.pdlp.ConvergenceInformation.hasCandidateType | ( | ) |
Type of the candidate point described by this ConvergenceInformation.
optional .operations_research.pdlp.PointType candidate_type = 1;
Implements com.google.ortools.pdlp.ConvergenceInformationOrBuilder.
Definition at line 63 of file ConvergenceInformation.java.
boolean com.google.ortools.pdlp.ConvergenceInformation.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;
Implements com.google.ortools.pdlp.ConvergenceInformationOrBuilder.
Definition at line 156 of file ConvergenceInformation.java.
boolean com.google.ortools.pdlp.ConvergenceInformation.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;
Implements com.google.ortools.pdlp.ConvergenceInformationOrBuilder.
Definition at line 122 of file ConvergenceInformation.java.
int com.google.ortools.pdlp.ConvergenceInformation.hashCode | ( | ) |
Definition at line 697 of file ConvergenceInformation.java.
boolean com.google.ortools.pdlp.ConvergenceInformation.hasL2DualResidual | ( | ) |
The l_2 norm of the violations of dual constraints.
optional double l2_dual_residual = 8;
Implements com.google.ortools.pdlp.ConvergenceInformationOrBuilder.
Definition at line 305 of file ConvergenceInformation.java.
boolean com.google.ortools.pdlp.ConvergenceInformation.hasL2DualVariable | ( | ) |
The l_2 norm of the dual variables.
optional double l2_dual_variable = 17;
Implements com.google.ortools.pdlp.ConvergenceInformationOrBuilder.
Definition at line 458 of file ConvergenceInformation.java.
boolean com.google.ortools.pdlp.ConvergenceInformation.hasL2PrimalResidual | ( | ) |
The l_2 norm of the violations of primal constraints.
optional double l2_primal_residual = 6;
Implements com.google.ortools.pdlp.ConvergenceInformationOrBuilder.
Definition at line 214 of file ConvergenceInformation.java.
boolean com.google.ortools.pdlp.ConvergenceInformation.hasL2PrimalVariable | ( | ) |
The l_2 norm of the primal variables.
optional double l2_primal_variable = 15;
Implements com.google.ortools.pdlp.ConvergenceInformationOrBuilder.
Definition at line 398 of file ConvergenceInformation.java.
boolean com.google.ortools.pdlp.ConvergenceInformation.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;
Implements com.google.ortools.pdlp.ConvergenceInformationOrBuilder.
Definition at line 335 of file ConvergenceInformation.java.
boolean com.google.ortools.pdlp.ConvergenceInformation.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;
Implements com.google.ortools.pdlp.ConvergenceInformationOrBuilder.
Definition at line 245 of file ConvergenceInformation.java.
boolean com.google.ortools.pdlp.ConvergenceInformation.hasLInfDualResidual | ( | ) |
The maximum violation of any dual constraint, i.e., the l_∞ norm of the violations.
optional double l_inf_dual_residual = 7;
Implements com.google.ortools.pdlp.ConvergenceInformationOrBuilder.
Definition at line 277 of file ConvergenceInformation.java.
boolean com.google.ortools.pdlp.ConvergenceInformation.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;
Implements com.google.ortools.pdlp.ConvergenceInformationOrBuilder.
Definition at line 428 of file ConvergenceInformation.java.
boolean com.google.ortools.pdlp.ConvergenceInformation.hasLInfPrimalResidual | ( | ) |
The maximum violation of any primal constraint, i.e., the l_∞ norm of the violations.
optional double l_inf_primal_residual = 5;
Implements com.google.ortools.pdlp.ConvergenceInformationOrBuilder.
Definition at line 186 of file ConvergenceInformation.java.
boolean com.google.ortools.pdlp.ConvergenceInformation.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;
Implements com.google.ortools.pdlp.ConvergenceInformationOrBuilder.
Definition at line 368 of file ConvergenceInformation.java.
boolean com.google.ortools.pdlp.ConvergenceInformation.hasPrimalObjective | ( | ) |
The primal objective. The primal need not be feasible.
optional double primal_objective = 2;
Implements com.google.ortools.pdlp.ConvergenceInformationOrBuilder.
Definition at line 90 of file ConvergenceInformation.java.
|
protected |
Definition at line 46 of file ConvergenceInformation.java.
final boolean com.google.ortools.pdlp.ConvergenceInformation.isInitialized | ( | ) |
Definition at line 476 of file ConvergenceInformation.java.
|
static |
Definition at line 851 of file ConvergenceInformation.java.
|
static |
Definition at line 854 of file ConvergenceInformation.java.
Builder com.google.ortools.pdlp.ConvergenceInformation.newBuilderForType | ( | ) |
Definition at line 850 of file ConvergenceInformation.java.
|
protected |
Definition at line 864 of file ConvergenceInformation.java.
|
static |
Definition at line 822 of file ConvergenceInformation.java.
|
static |
Definition at line 828 of file ConvergenceInformation.java.
|
static |
Definition at line 799 of file ConvergenceInformation.java.
|
static |
Definition at line 803 of file ConvergenceInformation.java.
|
static |
Definition at line 788 of file ConvergenceInformation.java.
|
static |
Definition at line 793 of file ConvergenceInformation.java.
|
static |
Definition at line 835 of file ConvergenceInformation.java.
|
static |
Definition at line 841 of file ConvergenceInformation.java.
|
static |
Definition at line 809 of file ConvergenceInformation.java.
|
static |
Definition at line 814 of file ConvergenceInformation.java.
|
static |
Definition at line 777 of file ConvergenceInformation.java.
|
static |
Definition at line 782 of file ConvergenceInformation.java.
|
static |
Definition at line 2096 of file ConvergenceInformation.java.
Builder com.google.ortools.pdlp.ConvergenceInformation.toBuilder | ( | ) |
Definition at line 858 of file ConvergenceInformation.java.
void com.google.ortools.pdlp.ConvergenceInformation.writeTo | ( | com.google.protobuf.CodedOutputStream | output | ) | throws java.io.IOException |
Definition at line 486 of file ConvergenceInformation.java.
|
static |
Definition at line 53 of file ConvergenceInformation.java.
|
static |
Definition at line 143 of file ConvergenceInformation.java.
|
static |
Definition at line 106 of file ConvergenceInformation.java.
|
static |
Definition at line 294 of file ConvergenceInformation.java.
|
static |
Definition at line 447 of file ConvergenceInformation.java.
|
static |
Definition at line 203 of file ConvergenceInformation.java.
|
static |
Definition at line 387 of file ConvergenceInformation.java.
|
static |
Definition at line 321 of file ConvergenceInformation.java.
|
static |
Definition at line 230 of file ConvergenceInformation.java.
|
static |
Definition at line 265 of file ConvergenceInformation.java.
|
static |
Definition at line 414 of file ConvergenceInformation.java.
|
static |
Definition at line 174 of file ConvergenceInformation.java.
|
static |
Definition at line 354 of file ConvergenceInformation.java.
|
static |
Definition at line 79 of file ConvergenceInformation.java.