![]() |
Google OR-Tools v9.12
a fast and portable software suite for combinatorial optimization
|
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) |
Information measuring how close a candidate is to establishing feasibility and optimality; see also TerminationCriteria.
Protobuf type operations_research.pdlp.ConvergenceInformation
Definition at line 16 of file ConvergenceInformation.java.
boolean com.google.ortools.pdlp.ConvergenceInformation.equals | ( | final java.lang.Object | obj | ) |
Definition at line 600 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 73 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 169 of file ConvergenceInformation.java.
|
static |
Definition at line 2071 of file ConvergenceInformation.java.
com.google.ortools.pdlp.ConvergenceInformation com.google.ortools.pdlp.ConvergenceInformation.getDefaultInstanceForType | ( | ) |
Definition at line 2107 of file ConvergenceInformation.java.
|
static |
Definition at line 39 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 138 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 316 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 469 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 225 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 409 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 349 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 260 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 289 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 442 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 198 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 382 of file ConvergenceInformation.java.
com.google.protobuf.Parser< ConvergenceInformation > com.google.ortools.pdlp.ConvergenceInformation.getParserForType | ( | ) |
Definition at line 2102 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 101 of file ConvergenceInformation.java.
int com.google.ortools.pdlp.ConvergenceInformation.getSerializedSize | ( | ) |
Definition at line 533 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 62 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 155 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 121 of file ConvergenceInformation.java.
int com.google.ortools.pdlp.ConvergenceInformation.hashCode | ( | ) |
Definition at line 696 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 304 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 457 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 213 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 397 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 334 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 244 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 276 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 427 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 185 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 367 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 89 of file ConvergenceInformation.java.
|
protected |
Definition at line 45 of file ConvergenceInformation.java.
final boolean com.google.ortools.pdlp.ConvergenceInformation.isInitialized | ( | ) |
Definition at line 475 of file ConvergenceInformation.java.
|
static |
Definition at line 850 of file ConvergenceInformation.java.
|
static |
Definition at line 853 of file ConvergenceInformation.java.
Builder com.google.ortools.pdlp.ConvergenceInformation.newBuilderForType | ( | ) |
Definition at line 849 of file ConvergenceInformation.java.
|
protected |
Definition at line 863 of file ConvergenceInformation.java.
|
static |
Definition at line 821 of file ConvergenceInformation.java.
|
static |
Definition at line 827 of file ConvergenceInformation.java.
|
static |
Definition at line 798 of file ConvergenceInformation.java.
|
static |
Definition at line 802 of file ConvergenceInformation.java.
|
static |
Definition at line 787 of file ConvergenceInformation.java.
|
static |
Definition at line 792 of file ConvergenceInformation.java.
|
static |
Definition at line 834 of file ConvergenceInformation.java.
|
static |
Definition at line 840 of file ConvergenceInformation.java.
|
static |
Definition at line 808 of file ConvergenceInformation.java.
|
static |
Definition at line 813 of file ConvergenceInformation.java.
|
static |
Definition at line 776 of file ConvergenceInformation.java.
|
static |
Definition at line 781 of file ConvergenceInformation.java.
|
static |
Definition at line 2097 of file ConvergenceInformation.java.
Builder com.google.ortools.pdlp.ConvergenceInformation.toBuilder | ( | ) |
Definition at line 857 of file ConvergenceInformation.java.
void com.google.ortools.pdlp.ConvergenceInformation.writeTo | ( | com.google.protobuf.CodedOutputStream | output | ) | throws java.io.IOException |
Definition at line 485 of file ConvergenceInformation.java.
|
static |
Definition at line 52 of file ConvergenceInformation.java.
|
static |
Definition at line 142 of file ConvergenceInformation.java.
|
static |
Definition at line 105 of file ConvergenceInformation.java.
|
static |
Definition at line 293 of file ConvergenceInformation.java.
|
static |
Definition at line 446 of file ConvergenceInformation.java.
|
static |
Definition at line 202 of file ConvergenceInformation.java.
|
static |
Definition at line 386 of file ConvergenceInformation.java.
|
static |
Definition at line 320 of file ConvergenceInformation.java.
|
static |
Definition at line 229 of file ConvergenceInformation.java.
|
static |
Definition at line 264 of file ConvergenceInformation.java.
|
static |
Definition at line 413 of file ConvergenceInformation.java.
|
static |
Definition at line 173 of file ConvergenceInformation.java.
|
static |
Definition at line 353 of file ConvergenceInformation.java.
|
static |
Definition at line 78 of file ConvergenceInformation.java.