Google OR-Tools v9.9
a fast and portable software suite for combinatorial optimization
|
Classes | |
class | Builder |
class | DetailedOptimalityCriteria |
interface | DetailedOptimalityCriteriaOrBuilder |
enum | OptimalityCriteriaCase |
class | SimpleOptimalityCriteria |
interface | SimpleOptimalityCriteriaOrBuilder |
Static Public Member Functions | |
static final com.google.protobuf.Descriptors.Descriptor | getDescriptor () |
static operations_research.pdlp.Solvers.TerminationCriteria | parseFrom (java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException |
static operations_research.pdlp.Solvers.TerminationCriteria | parseFrom (java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException |
static operations_research.pdlp.Solvers.TerminationCriteria | parseFrom (com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException |
static operations_research.pdlp.Solvers.TerminationCriteria | parseFrom (com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException |
static operations_research.pdlp.Solvers.TerminationCriteria | parseFrom (byte[] data) throws com.google.protobuf.InvalidProtocolBufferException |
static operations_research.pdlp.Solvers.TerminationCriteria | parseFrom (byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException |
static operations_research.pdlp.Solvers.TerminationCriteria | parseFrom (java.io.InputStream input) throws java.io.IOException |
static operations_research.pdlp.Solvers.TerminationCriteria | parseFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException |
static operations_research.pdlp.Solvers.TerminationCriteria | parseDelimitedFrom (java.io.InputStream input) throws java.io.IOException |
static operations_research.pdlp.Solvers.TerminationCriteria | parseDelimitedFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException |
static operations_research.pdlp.Solvers.TerminationCriteria | parseFrom (com.google.protobuf.CodedInputStream input) throws java.io.IOException |
static operations_research.pdlp.Solvers.TerminationCriteria | parseFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException |
static Builder | newBuilder () |
static Builder | newBuilder (operations_research.pdlp.Solvers.TerminationCriteria prototype) |
static operations_research.pdlp.Solvers.TerminationCriteria | getDefaultInstance () |
static com.google.protobuf.Parser< TerminationCriteria > | parser () |
Static Public Attributes | |
static final int | OPTIMALITY_NORM_FIELD_NUMBER = 1 |
static final int | SIMPLE_OPTIMALITY_CRITERIA_FIELD_NUMBER = 9 |
static final int | DETAILED_OPTIMALITY_CRITERIA_FIELD_NUMBER = 10 |
static final int | EPS_OPTIMAL_ABSOLUTE_FIELD_NUMBER = 2 |
static final int | EPS_OPTIMAL_RELATIVE_FIELD_NUMBER = 3 |
static final int | EPS_PRIMAL_INFEASIBLE_FIELD_NUMBER = 4 |
static final int | EPS_DUAL_INFEASIBLE_FIELD_NUMBER = 5 |
static final int | TIME_SEC_LIMIT_FIELD_NUMBER = 6 |
static final int | ITERATION_LIMIT_FIELD_NUMBER = 7 |
static final int | KKT_MATRIX_PASS_LIMIT_FIELD_NUMBER = 8 |
static final com.google.protobuf.Parser< TerminationCriteria > | PARSER |
Protected Member Functions | |
java.lang.Object | newInstance (UnusedPrivateParameter unused) |
com.google.protobuf.GeneratedMessageV3.FieldAccessorTable | internalGetFieldAccessorTable () |
Builder | newBuilderForType (com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
Relevant readings on infeasibility certificates: (1) https://docs.mosek.com/modeling-cookbook/qcqo.html provides references explaining why the primal rays imply dual infeasibility and dual rays imply primal infeasibility. (2) The termination criteria for Mosek's linear programming optimizer https://docs.mosek.com/9.0/pythonfusion/solving-linear.html. (3) The termination criteria for OSQP is in section 3.3 of https://web.stanford.edu/~boyd/papers/pdf/osqp.pdf. (4) The termination criteria for SCS is in section 3.5 of https://arxiv.org/pdf/1312.3039.pdf.
Protobuf type operations_research.pdlp.TerminationCriteria
Definition at line 430 of file Solvers.java.
boolean operations_research.pdlp.Solvers.TerminationCriteria.equals | ( | final java.lang.Object | obj | ) |
Definition at line 2841 of file Solvers.java.
|
static |
Definition at line 4267 of file Solvers.java.
operations_research.pdlp.Solvers.TerminationCriteria operations_research.pdlp.Solvers.TerminationCriteria.getDefaultInstanceForType | ( | ) |
Definition at line 4303 of file Solvers.java.
|
static |
Definition at line 458 of file Solvers.java.
operations_research.pdlp.Solvers.TerminationCriteria.DetailedOptimalityCriteria operations_research.pdlp.Solvers.TerminationCriteria.getDetailedOptimalityCriteria | ( | ) |
.operations_research.pdlp.TerminationCriteria.DetailedOptimalityCriteria detailed_optimality_criteria = 10;
Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.
Definition at line 2486 of file Solvers.java.
operations_research.pdlp.Solvers.TerminationCriteria.DetailedOptimalityCriteriaOrBuilder operations_research.pdlp.Solvers.TerminationCriteria.getDetailedOptimalityCriteriaOrBuilder | ( | ) |
.operations_research.pdlp.TerminationCriteria.DetailedOptimalityCriteria detailed_optimality_criteria = 10;
Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.
Definition at line 2496 of file Solvers.java.
double operations_research.pdlp.Solvers.TerminationCriteria.getEpsDualInfeasible | ( | ) |
If the following three conditions hold we say we have obtained an approximate primal ray, which is an approximate certificate of dual infeasibility. (1) primal_ray_linear_objective < 0, (2) max_primal_ray_infeasibility / (-primal_ray_linear_objective) <= eps_dual_infeasible (3) primal_ray_quadratic_norm / (-primal_ray_linear_objective) <= eps_dual_infeasible.
optional double eps_dual_infeasible = 5 [default = 1e-08];
Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.
Definition at line 2651 of file Solvers.java.
double operations_research.pdlp.Solvers.TerminationCriteria.getEpsOptimalAbsolute | ( | ) |
Absolute tolerance on primal residual, dual residual, and the objective gap. Deprecated, use simple_optimality_criteria instead. TODO(b/241462829) delete this deprecated field.
optional double eps_optimal_absolute = 2 [default = 1e-06, deprecated = true];
Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.
Definition at line 2536 of file Solvers.java.
double operations_research.pdlp.Solvers.TerminationCriteria.getEpsOptimalRelative | ( | ) |
Relative tolerance on primal residual, dual residual, and the objective gap. Deprecated, use simple_optimality_criteria instead. TODO(b/241462829) delete this deprecated field.
optional double eps_optimal_relative = 3 [default = 1e-06, deprecated = true];
Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.
Definition at line 2573 of file Solvers.java.
double operations_research.pdlp.Solvers.TerminationCriteria.getEpsPrimalInfeasible | ( | ) |
If the following two conditions hold we say that we have obtained an approximate dual ray, which is an approximate certificate of primal infeasibility. (1) dual_ray_objective > 0, (2) max_dual_ray_infeasibility / dual_ray_objective <= eps_primal_infeasible.
optional double eps_primal_infeasible = 4 [default = 1e-08];
Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.
Definition at line 2610 of file Solvers.java.
int operations_research.pdlp.Solvers.TerminationCriteria.getIterationLimit | ( | ) |
If termination_reason = TERMINATION_REASON_ITERATION_LIMIT then the solver has taken at least iterations_limit iterations.
optional int32 iteration_limit = 7 [default = 2147483647];
Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.
Definition at line 2709 of file Solvers.java.
double operations_research.pdlp.Solvers.TerminationCriteria.getKktMatrixPassLimit | ( | ) |
If termination_reason = TERMINATION_REASON_KKT_MATRIX_PASS_LIMIT then cumulative_kkt_matrix_passes is at least kkt_pass_limit.
optional double kkt_matrix_pass_limit = 8 [default = inf];
Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.
Definition at line 2738 of file Solvers.java.
OptimalityCriteriaCase operations_research.pdlp.Solvers.TerminationCriteria.getOptimalityCriteriaCase | ( | ) |
Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.
Definition at line 2410 of file Solvers.java.
operations_research.pdlp.Solvers.OptimalityNorm operations_research.pdlp.Solvers.TerminationCriteria.getOptimalityNorm | ( | ) |
The norm that we are measuring the optimality criteria in.
optional .operations_research.pdlp.OptimalityNorm optimality_norm = 1 [default = OPTIMALITY_NORM_L2];
Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.
Definition at line 2436 of file Solvers.java.
com.google.protobuf.Parser< TerminationCriteria > operations_research.pdlp.Solvers.TerminationCriteria.getParserForType | ( | ) |
Definition at line 4298 of file Solvers.java.
int operations_research.pdlp.Solvers.TerminationCriteria.getSerializedSize | ( | ) |
Definition at line 2790 of file Solvers.java.
operations_research.pdlp.Solvers.TerminationCriteria.SimpleOptimalityCriteria operations_research.pdlp.Solvers.TerminationCriteria.getSimpleOptimalityCriteria | ( | ) |
.operations_research.pdlp.TerminationCriteria.SimpleOptimalityCriteria simple_optimality_criteria = 9;
Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.
Definition at line 2455 of file Solvers.java.
operations_research.pdlp.Solvers.TerminationCriteria.SimpleOptimalityCriteriaOrBuilder operations_research.pdlp.Solvers.TerminationCriteria.getSimpleOptimalityCriteriaOrBuilder | ( | ) |
.operations_research.pdlp.TerminationCriteria.SimpleOptimalityCriteria simple_optimality_criteria = 9;
Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.
Definition at line 2465 of file Solvers.java.
double operations_research.pdlp.Solvers.TerminationCriteria.getTimeSecLimit | ( | ) |
If termination_reason = TERMINATION_REASON_TIME_LIMIT then the solver has taken at least time_sec_limit time.
optional double time_sec_limit = 6 [default = inf];
Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.
Definition at line 2680 of file Solvers.java.
boolean operations_research.pdlp.Solvers.TerminationCriteria.hasDetailedOptimalityCriteria | ( | ) |
.operations_research.pdlp.TerminationCriteria.DetailedOptimalityCriteria detailed_optimality_criteria = 10;
Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.
Definition at line 2478 of file Solvers.java.
boolean operations_research.pdlp.Solvers.TerminationCriteria.hasEpsDualInfeasible | ( | ) |
If the following three conditions hold we say we have obtained an approximate primal ray, which is an approximate certificate of dual infeasibility. (1) primal_ray_linear_objective < 0, (2) max_primal_ray_infeasibility / (-primal_ray_linear_objective) <= eps_dual_infeasible (3) primal_ray_quadratic_norm / (-primal_ray_linear_objective) <= eps_dual_infeasible.
optional double eps_dual_infeasible = 5 [default = 1e-08];
Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.
Definition at line 2632 of file Solvers.java.
boolean operations_research.pdlp.Solvers.TerminationCriteria.hasEpsOptimalAbsolute | ( | ) |
Absolute tolerance on primal residual, dual residual, and the objective gap. Deprecated, use simple_optimality_criteria instead. TODO(b/241462829) delete this deprecated field.
optional double eps_optimal_absolute = 2 [default = 1e-06, deprecated = true];
Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.
Definition at line 2519 of file Solvers.java.
boolean operations_research.pdlp.Solvers.TerminationCriteria.hasEpsOptimalRelative | ( | ) |
Relative tolerance on primal residual, dual residual, and the objective gap. Deprecated, use simple_optimality_criteria instead. TODO(b/241462829) delete this deprecated field.
optional double eps_optimal_relative = 3 [default = 1e-06, deprecated = true];
Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.
Definition at line 2556 of file Solvers.java.
boolean operations_research.pdlp.Solvers.TerminationCriteria.hasEpsPrimalInfeasible | ( | ) |
If the following two conditions hold we say that we have obtained an approximate dual ray, which is an approximate certificate of primal infeasibility. (1) dual_ray_objective > 0, (2) max_dual_ray_infeasibility / dual_ray_objective <= eps_primal_infeasible.
optional double eps_primal_infeasible = 4 [default = 1e-08];
Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.
Definition at line 2593 of file Solvers.java.
int operations_research.pdlp.Solvers.TerminationCriteria.hashCode | ( | ) |
Definition at line 2913 of file Solvers.java.
boolean operations_research.pdlp.Solvers.TerminationCriteria.hasIterationLimit | ( | ) |
If termination_reason = TERMINATION_REASON_ITERATION_LIMIT then the solver has taken at least iterations_limit iterations.
optional int32 iteration_limit = 7 [default = 2147483647];
Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.
Definition at line 2696 of file Solvers.java.
boolean operations_research.pdlp.Solvers.TerminationCriteria.hasKktMatrixPassLimit | ( | ) |
If termination_reason = TERMINATION_REASON_KKT_MATRIX_PASS_LIMIT then cumulative_kkt_matrix_passes is at least kkt_pass_limit.
optional double kkt_matrix_pass_limit = 8 [default = inf];
Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.
Definition at line 2725 of file Solvers.java.
boolean operations_research.pdlp.Solvers.TerminationCriteria.hasOptimalityNorm | ( | ) |
The norm that we are measuring the optimality criteria in.
optional .operations_research.pdlp.OptimalityNorm optimality_norm = 1 [default = OPTIMALITY_NORM_L2];
Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.
Definition at line 2425 of file Solvers.java.
boolean operations_research.pdlp.Solvers.TerminationCriteria.hasSimpleOptimalityCriteria | ( | ) |
.operations_research.pdlp.TerminationCriteria.SimpleOptimalityCriteria simple_optimality_criteria = 9;
Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.
Definition at line 2447 of file Solvers.java.
boolean operations_research.pdlp.Solvers.TerminationCriteria.hasTimeSecLimit | ( | ) |
If termination_reason = TERMINATION_REASON_TIME_LIMIT then the solver has taken at least time_sec_limit time.
optional double time_sec_limit = 6 [default = inf];
Implements operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.
Definition at line 2667 of file Solvers.java.
|
protected |
Definition at line 464 of file Solvers.java.
final boolean operations_research.pdlp.Solvers.TerminationCriteria.isInitialized | ( | ) |
Definition at line 2744 of file Solvers.java.
|
static |
Definition at line 3048 of file Solvers.java.
|
static |
Definition at line 3051 of file Solvers.java.
Builder operations_research.pdlp.Solvers.TerminationCriteria.newBuilderForType | ( | ) |
Definition at line 3047 of file Solvers.java.
|
protected |
Definition at line 3061 of file Solvers.java.
|
protected |
Definition at line 452 of file Solvers.java.
|
static |
Definition at line 3019 of file Solvers.java.
|
static |
Definition at line 3025 of file Solvers.java.
|
static |
Definition at line 2996 of file Solvers.java.
|
static |
Definition at line 3000 of file Solvers.java.
|
static |
Definition at line 2985 of file Solvers.java.
|
static |
Definition at line 2990 of file Solvers.java.
|
static |
Definition at line 3032 of file Solvers.java.
|
static |
Definition at line 3038 of file Solvers.java.
|
static |
Definition at line 3006 of file Solvers.java.
|
static |
Definition at line 3011 of file Solvers.java.
|
static |
Definition at line 2974 of file Solvers.java.
|
static |
Definition at line 2979 of file Solvers.java.
|
static |
Definition at line 4293 of file Solvers.java.
Builder operations_research.pdlp.Solvers.TerminationCriteria.toBuilder | ( | ) |
Definition at line 3055 of file Solvers.java.
void operations_research.pdlp.Solvers.TerminationCriteria.writeTo | ( | com.google.protobuf.CodedOutputStream | output | ) | throws java.io.IOException |
Definition at line 2754 of file Solvers.java.
|
static |
Definition at line 2472 of file Solvers.java.
|
static |
Definition at line 2614 of file Solvers.java.
|
static |
Definition at line 2503 of file Solvers.java.
|
static |
Definition at line 2540 of file Solvers.java.
|
static |
Definition at line 2577 of file Solvers.java.
|
static |
Definition at line 2684 of file Solvers.java.
|
static |
Definition at line 2713 of file Solvers.java.
|
static |
Definition at line 2415 of file Solvers.java.
|
static |
Definition at line 4272 of file Solvers.java.
|
static |
Definition at line 2441 of file Solvers.java.
|
static |
Definition at line 2655 of file Solvers.java.