Google OR-Tools v9.9
a fast and portable software suite for combinatorial optimization
|
Classes | |
class | Builder |
enum | LPAlgorithmValues |
Static Public Member Functions | |
static final com.google.protobuf.Descriptors.Descriptor | getDescriptor () |
static com.google.ortools.linearsolver.MPSolverCommonParameters | parseFrom (java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException |
static com.google.ortools.linearsolver.MPSolverCommonParameters | parseFrom (java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException |
static com.google.ortools.linearsolver.MPSolverCommonParameters | parseFrom (com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException |
static com.google.ortools.linearsolver.MPSolverCommonParameters | parseFrom (com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException |
static com.google.ortools.linearsolver.MPSolverCommonParameters | parseFrom (byte[] data) throws com.google.protobuf.InvalidProtocolBufferException |
static com.google.ortools.linearsolver.MPSolverCommonParameters | parseFrom (byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException |
static com.google.ortools.linearsolver.MPSolverCommonParameters | parseFrom (java.io.InputStream input) throws java.io.IOException |
static com.google.ortools.linearsolver.MPSolverCommonParameters | parseFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException |
static com.google.ortools.linearsolver.MPSolverCommonParameters | parseDelimitedFrom (java.io.InputStream input) throws java.io.IOException |
static com.google.ortools.linearsolver.MPSolverCommonParameters | parseDelimitedFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException |
static com.google.ortools.linearsolver.MPSolverCommonParameters | parseFrom (com.google.protobuf.CodedInputStream input) throws java.io.IOException |
static com.google.ortools.linearsolver.MPSolverCommonParameters | parseFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException |
static Builder | newBuilder () |
static Builder | newBuilder (com.google.ortools.linearsolver.MPSolverCommonParameters prototype) |
static com.google.ortools.linearsolver.MPSolverCommonParameters | getDefaultInstance () |
static com.google.protobuf.Parser< MPSolverCommonParameters > | parser () |
Static Public Attributes | |
static final int | RELATIVE_MIP_GAP_FIELD_NUMBER = 1 |
static final int | PRIMAL_TOLERANCE_FIELD_NUMBER = 2 |
static final int | DUAL_TOLERANCE_FIELD_NUMBER = 3 |
static final int | LP_ALGORITHM_FIELD_NUMBER = 4 |
static final int | PRESOLVE_FIELD_NUMBER = 5 |
static final int | SCALING_FIELD_NUMBER = 7 |
static final com.google.protobuf.Parser< MPSolverCommonParameters > | PARSER |
Protected Member Functions | |
java.lang.Object | newInstance (UnusedPrivateParameter unused) |
com.google.protobuf.GeneratedMessageV3.FieldAccessorTable | internalGetFieldAccessorTable () |
Builder | newBuilderForType (com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
MPSolverCommonParameters holds advanced usage parameters that apply to any of the solvers we support. All of the fields in this proto can have a value of unspecified. In this case each inner solver will use their own safe defaults. Some values won't be supported by some solvers. The behavior in that case is not defined yet.
Protobuf type operations_research.MPSolverCommonParameters
Definition at line 19 of file MPSolverCommonParameters.java.
boolean com.google.ortools.linearsolver.MPSolverCommonParameters.equals | ( | final java.lang.Object | obj | ) |
Definition at line 527 of file MPSolverCommonParameters.java.
|
static |
Definition at line 1864 of file MPSolverCommonParameters.java.
com.google.ortools.linearsolver.MPSolverCommonParameters com.google.ortools.linearsolver.MPSolverCommonParameters.getDefaultInstanceForType | ( | ) |
Definition at line 1900 of file MPSolverCommonParameters.java.
|
static |
Definition at line 42 of file MPSolverCommonParameters.java.
com.google.ortools.linearsolver.OptionalDouble com.google.ortools.linearsolver.MPSolverCommonParameters.getDualTolerance | ( | ) |
Tolerance for dual feasibility. For SCIP and Gurobi this is the feasibility tolerance for reduced costs in LP solution: reduced costs must all be smaller than this value in the improving direction in order for a model to be declared optimal. Not supported for other solvers.
optional .operations_research.OptionalDouble dual_tolerance = 3;
Implements com.google.ortools.linearsolver.MPSolverCommonParametersOrBuilder.
Definition at line 351 of file MPSolverCommonParameters.java.
com.google.ortools.linearsolver.OptionalDoubleOrBuilder com.google.ortools.linearsolver.MPSolverCommonParameters.getDualToleranceOrBuilder | ( | ) |
Tolerance for dual feasibility. For SCIP and Gurobi this is the feasibility tolerance for reduced costs in LP solution: reduced costs must all be smaller than this value in the improving direction in order for a model to be declared optimal. Not supported for other solvers.
optional .operations_research.OptionalDouble dual_tolerance = 3;
Implements com.google.ortools.linearsolver.MPSolverCommonParametersOrBuilder.
Definition at line 366 of file MPSolverCommonParameters.java.
com.google.ortools.linearsolver.MPSolverCommonParameters.LPAlgorithmValues com.google.ortools.linearsolver.MPSolverCommonParameters.getLpAlgorithm | ( | ) |
Algorithm to solve linear programs. Ask or-core-team@ if you want to know what this does exactly.
optional .operations_research.MPSolverCommonParameters.LPAlgorithmValues lp_algorithm = 4 [default = LP_ALGO_UNSPECIFIED];
Implements com.google.ortools.linearsolver.MPSolverCommonParametersOrBuilder.
Definition at line 393 of file MPSolverCommonParameters.java.
com.google.protobuf.Parser< MPSolverCommonParameters > com.google.ortools.linearsolver.MPSolverCommonParameters.getParserForType | ( | ) |
Definition at line 1895 of file MPSolverCommonParameters.java.
com.google.ortools.util.OptionalBoolean com.google.ortools.linearsolver.MPSolverCommonParameters.getPresolve | ( | ) |
Gurobi and SCIP enable presolve by default. Ask or-core-team@ for other solvers.
optional .operations_research.OptionalBoolean presolve = 5 [default = BOOL_UNSPECIFIED];
Implements com.google.ortools.linearsolver.MPSolverCommonParametersOrBuilder.
Definition at line 421 of file MPSolverCommonParameters.java.
com.google.ortools.linearsolver.OptionalDouble com.google.ortools.linearsolver.MPSolverCommonParameters.getPrimalTolerance | ( | ) |
Tolerance for primal feasibility of basic solutions: this is the maximum allowed error in constraint satisfiability. For SCIP this includes integrality constraints. For Gurobi it does not, you need to set the custom parameter IntFeasTol.
optional .operations_research.OptionalDouble primal_tolerance = 2;
Implements com.google.ortools.linearsolver.MPSolverCommonParametersOrBuilder.
Definition at line 302 of file MPSolverCommonParameters.java.
com.google.ortools.linearsolver.OptionalDoubleOrBuilder com.google.ortools.linearsolver.MPSolverCommonParameters.getPrimalToleranceOrBuilder | ( | ) |
Tolerance for primal feasibility of basic solutions: this is the maximum allowed error in constraint satisfiability. For SCIP this includes integrality constraints. For Gurobi it does not, you need to set the custom parameter IntFeasTol.
optional .operations_research.OptionalDouble primal_tolerance = 2;
Implements com.google.ortools.linearsolver.MPSolverCommonParametersOrBuilder.
Definition at line 316 of file MPSolverCommonParameters.java.
com.google.ortools.linearsolver.OptionalDouble com.google.ortools.linearsolver.MPSolverCommonParameters.getRelativeMipGap | ( | ) |
The solver stops if the relative MIP gap reaches this value or below. The relative MIP gap is an upper bound of the relative distance to the optimum, and it is defined as: abs(best_bound - incumbent) / abs(incumbent) [Gurobi] abs(best_bound - incumbent) / min(abs(best_bound), abs(incumbent)) [SCIP] where "incumbent" is the objective value of the best solution found so far (i.e., lowest when minimizing, highest when maximizing), and "best_bound" is the tightest bound of the objective determined so far (i.e., highest when minimizing, and lowest when maximizing). The MIP Gap is sensitive to objective offset. If the denominator is 0 the MIP Gap is INFINITY for SCIP and Gurobi. Of note, "incumbent" and "best bound" are called "primal bound" and "dual bound" in SCIP, respectively. Ask or-core-team@ for other solvers.
optional .operations_research.OptionalDouble relative_mip_gap = 1;
Implements com.google.ortools.linearsolver.MPSolverCommonParametersOrBuilder.
Definition at line 244 of file MPSolverCommonParameters.java.
com.google.ortools.linearsolver.OptionalDoubleOrBuilder com.google.ortools.linearsolver.MPSolverCommonParameters.getRelativeMipGapOrBuilder | ( | ) |
The solver stops if the relative MIP gap reaches this value or below. The relative MIP gap is an upper bound of the relative distance to the optimum, and it is defined as: abs(best_bound - incumbent) / abs(incumbent) [Gurobi] abs(best_bound - incumbent) / min(abs(best_bound), abs(incumbent)) [SCIP] where "incumbent" is the objective value of the best solution found so far (i.e., lowest when minimizing, highest when maximizing), and "best_bound" is the tightest bound of the objective determined so far (i.e., highest when minimizing, and lowest when maximizing). The MIP Gap is sensitive to objective offset. If the denominator is 0 the MIP Gap is INFINITY for SCIP and Gurobi. Of note, "incumbent" and "best bound" are called "primal bound" and "dual bound" in SCIP, respectively. Ask or-core-team@ for other solvers.
optional .operations_research.OptionalDouble relative_mip_gap = 1;
Implements com.google.ortools.linearsolver.MPSolverCommonParametersOrBuilder.
Definition at line 269 of file MPSolverCommonParameters.java.
com.google.ortools.util.OptionalBoolean com.google.ortools.linearsolver.MPSolverCommonParameters.getScaling | ( | ) |
Enable automatic scaling of matrix coefficients and objective. Available for Gurobi and GLOP. Ask or-core-team@ if you want more details.
optional .operations_research.OptionalBoolean scaling = 7 [default = BOOL_UNSPECIFIED];
Implements com.google.ortools.linearsolver.MPSolverCommonParametersOrBuilder.
Definition at line 451 of file MPSolverCommonParameters.java.
int com.google.ortools.linearsolver.MPSolverCommonParameters.getSerializedSize | ( | ) |
Definition at line 492 of file MPSolverCommonParameters.java.
boolean com.google.ortools.linearsolver.MPSolverCommonParameters.hasDualTolerance | ( | ) |
Tolerance for dual feasibility. For SCIP and Gurobi this is the feasibility tolerance for reduced costs in LP solution: reduced costs must all be smaller than this value in the improving direction in order for a model to be declared optimal. Not supported for other solvers.
optional .operations_research.OptionalDouble dual_tolerance = 3;
Implements com.google.ortools.linearsolver.MPSolverCommonParametersOrBuilder.
Definition at line 335 of file MPSolverCommonParameters.java.
int com.google.ortools.linearsolver.MPSolverCommonParameters.hashCode | ( | ) |
Definition at line 568 of file MPSolverCommonParameters.java.
boolean com.google.ortools.linearsolver.MPSolverCommonParameters.hasLpAlgorithm | ( | ) |
Algorithm to solve linear programs. Ask or-core-team@ if you want to know what this does exactly.
optional .operations_research.MPSolverCommonParameters.LPAlgorithmValues lp_algorithm = 4 [default = LP_ALGO_UNSPECIFIED];
Implements com.google.ortools.linearsolver.MPSolverCommonParametersOrBuilder.
Definition at line 381 of file MPSolverCommonParameters.java.
boolean com.google.ortools.linearsolver.MPSolverCommonParameters.hasPresolve | ( | ) |
Gurobi and SCIP enable presolve by default. Ask or-core-team@ for other solvers.
optional .operations_research.OptionalBoolean presolve = 5 [default = BOOL_UNSPECIFIED];
Implements com.google.ortools.linearsolver.MPSolverCommonParametersOrBuilder.
Definition at line 409 of file MPSolverCommonParameters.java.
boolean com.google.ortools.linearsolver.MPSolverCommonParameters.hasPrimalTolerance | ( | ) |
Tolerance for primal feasibility of basic solutions: this is the maximum allowed error in constraint satisfiability. For SCIP this includes integrality constraints. For Gurobi it does not, you need to set the custom parameter IntFeasTol.
optional .operations_research.OptionalDouble primal_tolerance = 2;
Implements com.google.ortools.linearsolver.MPSolverCommonParametersOrBuilder.
Definition at line 287 of file MPSolverCommonParameters.java.
boolean com.google.ortools.linearsolver.MPSolverCommonParameters.hasRelativeMipGap | ( | ) |
The solver stops if the relative MIP gap reaches this value or below. The relative MIP gap is an upper bound of the relative distance to the optimum, and it is defined as: abs(best_bound - incumbent) / abs(incumbent) [Gurobi] abs(best_bound - incumbent) / min(abs(best_bound), abs(incumbent)) [SCIP] where "incumbent" is the objective value of the best solution found so far (i.e., lowest when minimizing, highest when maximizing), and "best_bound" is the tightest bound of the objective determined so far (i.e., highest when minimizing, and lowest when maximizing). The MIP Gap is sensitive to objective offset. If the denominator is 0 the MIP Gap is INFINITY for SCIP and Gurobi. Of note, "incumbent" and "best bound" are called "primal bound" and "dual bound" in SCIP, respectively. Ask or-core-team@ for other solvers.
optional .operations_research.OptionalDouble relative_mip_gap = 1;
Implements com.google.ortools.linearsolver.MPSolverCommonParametersOrBuilder.
Definition at line 218 of file MPSolverCommonParameters.java.
boolean com.google.ortools.linearsolver.MPSolverCommonParameters.hasScaling | ( | ) |
Enable automatic scaling of matrix coefficients and objective. Available for Gurobi and GLOP. Ask or-core-team@ if you want more details.
optional .operations_research.OptionalBoolean scaling = 7 [default = BOOL_UNSPECIFIED];
Implements com.google.ortools.linearsolver.MPSolverCommonParametersOrBuilder.
Definition at line 438 of file MPSolverCommonParameters.java.
|
protected |
Definition at line 48 of file MPSolverCommonParameters.java.
final boolean com.google.ortools.linearsolver.MPSolverCommonParameters.isInitialized | ( | ) |
Definition at line 458 of file MPSolverCommonParameters.java.
|
static |
Definition at line 677 of file MPSolverCommonParameters.java.
|
static |
Definition at line 680 of file MPSolverCommonParameters.java.
Builder com.google.ortools.linearsolver.MPSolverCommonParameters.newBuilderForType | ( | ) |
Definition at line 676 of file MPSolverCommonParameters.java.
|
protected |
Definition at line 690 of file MPSolverCommonParameters.java.
|
protected |
Definition at line 36 of file MPSolverCommonParameters.java.
|
static |
Definition at line 648 of file MPSolverCommonParameters.java.
|
static |
Definition at line 654 of file MPSolverCommonParameters.java.
|
static |
Definition at line 625 of file MPSolverCommonParameters.java.
|
static |
Definition at line 629 of file MPSolverCommonParameters.java.
|
static |
Definition at line 614 of file MPSolverCommonParameters.java.
|
static |
Definition at line 619 of file MPSolverCommonParameters.java.
|
static |
Definition at line 661 of file MPSolverCommonParameters.java.
|
static |
Definition at line 667 of file MPSolverCommonParameters.java.
|
static |
Definition at line 635 of file MPSolverCommonParameters.java.
|
static |
Definition at line 640 of file MPSolverCommonParameters.java.
|
static |
Definition at line 603 of file MPSolverCommonParameters.java.
|
static |
Definition at line 608 of file MPSolverCommonParameters.java.
|
static |
Definition at line 1890 of file MPSolverCommonParameters.java.
Builder com.google.ortools.linearsolver.MPSolverCommonParameters.toBuilder | ( | ) |
Definition at line 684 of file MPSolverCommonParameters.java.
void com.google.ortools.linearsolver.MPSolverCommonParameters.writeTo | ( | com.google.protobuf.CodedOutputStream | output | ) | throws java.io.IOException |
Definition at line 468 of file MPSolverCommonParameters.java.
|
static |
Definition at line 320 of file MPSolverCommonParameters.java.
|
static |
Definition at line 370 of file MPSolverCommonParameters.java.
|
static |
Definition at line 1869 of file MPSolverCommonParameters.java.
|
static |
Definition at line 398 of file MPSolverCommonParameters.java.
|
static |
Definition at line 273 of file MPSolverCommonParameters.java.
|
static |
Definition at line 193 of file MPSolverCommonParameters.java.
|
static |
Definition at line 426 of file MPSolverCommonParameters.java.