Java Reference
Java Reference
Detailed Description
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
Definition at line 18 of file MPSolverCommonParameters.java.
Classes | |
| class | Builder |
| enum | LPAlgorithmValues |
| Protobuf enum. More... | |
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 |
| .lang.Deprecated static final com.google.protobuf.Parser< MPSolverCommonParameters > | PARSER |
Protected Member Functions | |
| .lang.Override java.lang.Object | newInstance (UnusedPrivateParameter unused) |
| .lang.Override com.google.protobuf.GeneratedMessageV3.FieldAccessorTable | internalGetFieldAccessorTable () |
| .lang.Override Builder | newBuilderForType (com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
Member Function Documentation
◆ equals()
|
inline |
Definition at line 641 of file MPSolverCommonParameters.java.
◆ getDefaultInstance()
|
inlinestatic |
Definition at line 1895 of file MPSolverCommonParameters.java.
◆ getDefaultInstanceForType()
|
inline |
Definition at line 1920 of file MPSolverCommonParameters.java.
◆ getDescriptor()
|
inlinestatic |
Definition at line 159 of file MPSolverCommonParameters.java.
◆ getDualTolerance()
|
inline |
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;
- Returns
- The dualTolerance.
Implements MPSolverCommonParametersOrBuilder.
Definition at line 462 of file MPSolverCommonParameters.java.
◆ getDualToleranceOrBuilder()
|
inline |
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 MPSolverCommonParametersOrBuilder.
Definition at line 477 of file MPSolverCommonParameters.java.
◆ getLpAlgorithm()
|
inline |
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];
- Returns
- The lpAlgorithm.
Implements MPSolverCommonParametersOrBuilder.
Definition at line 504 of file MPSolverCommonParameters.java.
◆ getParserForType()
|
inline |
Definition at line 1915 of file MPSolverCommonParameters.java.
◆ getPresolve()
|
inline |
Gurobi and SCIP enable presolve by default. Ask or-core-team@ for other solvers.
optional .operations_research.OptionalBoolean presolve = 5 [default = BOOL_UNSPECIFIED];
- Returns
- The presolve.
Implements MPSolverCommonParametersOrBuilder.
Definition at line 533 of file MPSolverCommonParameters.java.
◆ getPrimalTolerance()
|
inline |
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;
- Returns
- The primalTolerance.
Implements MPSolverCommonParametersOrBuilder.
Definition at line 413 of file MPSolverCommonParameters.java.
◆ getPrimalToleranceOrBuilder()
|
inline |
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 MPSolverCommonParametersOrBuilder.
Definition at line 427 of file MPSolverCommonParameters.java.
◆ getRelativeMipGap()
|
inline |
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;
- Returns
- The relativeMipGap.
Implements MPSolverCommonParametersOrBuilder.
Definition at line 357 of file MPSolverCommonParameters.java.
◆ getRelativeMipGapOrBuilder()
|
inline |
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 MPSolverCommonParametersOrBuilder.
Definition at line 380 of file MPSolverCommonParameters.java.
◆ getScaling()
|
inline |
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];
- Returns
- The scaling.
Implements MPSolverCommonParametersOrBuilder.
Definition at line 564 of file MPSolverCommonParameters.java.
◆ getSerializedSize()
|
inline |
Definition at line 606 of file MPSolverCommonParameters.java.
◆ getUnknownFields()
|
inline |
Definition at line 42 of file MPSolverCommonParameters.java.
◆ hasDualTolerance()
|
inline |
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;
- Returns
- Whether the dualTolerance field is set.
Implements MPSolverCommonParametersOrBuilder.
Definition at line 446 of file MPSolverCommonParameters.java.
◆ hashCode()
|
inline |
Definition at line 682 of file MPSolverCommonParameters.java.
◆ hasLpAlgorithm()
|
inline |
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];
- Returns
- Whether the lpAlgorithm field is set.
Implements MPSolverCommonParametersOrBuilder.
Definition at line 492 of file MPSolverCommonParameters.java.
◆ hasPresolve()
|
inline |
Gurobi and SCIP enable presolve by default. Ask or-core-team@ for other solvers.
optional .operations_research.OptionalBoolean presolve = 5 [default = BOOL_UNSPECIFIED];
- Returns
- Whether the presolve field is set.
Implements MPSolverCommonParametersOrBuilder.
Definition at line 521 of file MPSolverCommonParameters.java.
◆ hasPrimalTolerance()
|
inline |
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;
- Returns
- Whether the primalTolerance field is set.
Implements MPSolverCommonParametersOrBuilder.
Definition at line 398 of file MPSolverCommonParameters.java.
◆ hasRelativeMipGap()
|
inline |
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;
- Returns
- Whether the relativeMipGap field is set.
Implements MPSolverCommonParametersOrBuilder.
Definition at line 333 of file MPSolverCommonParameters.java.
◆ hasScaling()
|
inline |
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];
- Returns
- Whether the scaling field is set.
Implements MPSolverCommonParametersOrBuilder.
Definition at line 551 of file MPSolverCommonParameters.java.
◆ internalGetFieldAccessorTable()
|
inlineprotected |
Definition at line 165 of file MPSolverCommonParameters.java.
◆ isInitialized()
|
inline |
Definition at line 572 of file MPSolverCommonParameters.java.
◆ newBuilder() [1/2]
|
inlinestatic |
Definition at line 789 of file MPSolverCommonParameters.java.
◆ newBuilder() [2/2]
|
inlinestatic |
Definition at line 792 of file MPSolverCommonParameters.java.
◆ newBuilderForType() [1/2]
|
inline |
Definition at line 788 of file MPSolverCommonParameters.java.
◆ newBuilderForType() [2/2]
|
inlineprotected |
Definition at line 802 of file MPSolverCommonParameters.java.
◆ newInstance()
|
inlineprotected |
Definition at line 35 of file MPSolverCommonParameters.java.
◆ parseDelimitedFrom() [1/2]
|
inlinestatic |
Definition at line 761 of file MPSolverCommonParameters.java.
◆ parseDelimitedFrom() [2/2]
|
inlinestatic |
Definition at line 766 of file MPSolverCommonParameters.java.
◆ parseFrom() [1/10]
|
inlinestatic |
Definition at line 739 of file MPSolverCommonParameters.java.
◆ parseFrom() [2/10]
|
inlinestatic |
Definition at line 743 of file MPSolverCommonParameters.java.
◆ parseFrom() [3/10]
|
inlinestatic |
Definition at line 728 of file MPSolverCommonParameters.java.
◆ parseFrom() [4/10]
|
inlinestatic |
Definition at line 733 of file MPSolverCommonParameters.java.
◆ parseFrom() [5/10]
|
inlinestatic |
Definition at line 773 of file MPSolverCommonParameters.java.
◆ parseFrom() [6/10]
|
inlinestatic |
Definition at line 779 of file MPSolverCommonParameters.java.
◆ parseFrom() [7/10]
|
inlinestatic |
Definition at line 749 of file MPSolverCommonParameters.java.
◆ parseFrom() [8/10]
|
inlinestatic |
Definition at line 754 of file MPSolverCommonParameters.java.
◆ parseFrom() [9/10]
|
inlinestatic |
Definition at line 717 of file MPSolverCommonParameters.java.
◆ parseFrom() [10/10]
|
inlinestatic |
Definition at line 722 of file MPSolverCommonParameters.java.
◆ parser()
|
inlinestatic |
Definition at line 1910 of file MPSolverCommonParameters.java.
◆ toBuilder()
|
inline |
Definition at line 796 of file MPSolverCommonParameters.java.
◆ writeTo()
|
inline |
Definition at line 582 of file MPSolverCommonParameters.java.
Member Data Documentation
◆ DUAL_TOLERANCE_FIELD_NUMBER
|
static |
Definition at line 431 of file MPSolverCommonParameters.java.
◆ LP_ALGORITHM_FIELD_NUMBER
|
static |
Definition at line 481 of file MPSolverCommonParameters.java.
◆ PARSER
|
static |
Definition at line 1900 of file MPSolverCommonParameters.java.
◆ PRESOLVE_FIELD_NUMBER
|
static |
Definition at line 510 of file MPSolverCommonParameters.java.
◆ PRIMAL_TOLERANCE_FIELD_NUMBER
|
static |
Definition at line 384 of file MPSolverCommonParameters.java.
◆ RELATIVE_MIP_GAP_FIELD_NUMBER
|
static |
Definition at line 310 of file MPSolverCommonParameters.java.
◆ SCALING_FIELD_NUMBER
|
static |
Definition at line 539 of file MPSolverCommonParameters.java.
The documentation for this class was generated from the following file: