Java Reference

Java Reference

MPSolverCommonParameters.Builder

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

operations_research.MPSolverCommonParameters

Definition at line 819 of file MPSolverCommonParameters.java.

Public Member Functions

.lang.Override Builder clear ()
 
.lang.Override com.google.protobuf.Descriptors.Descriptor getDescriptorForType ()
 
.lang.Override com.google.ortools.linearsolver.MPSolverCommonParameters getDefaultInstanceForType ()
 
.lang.Override com.google.ortools.linearsolver.MPSolverCommonParameters build ()
 
.lang.Override com.google.ortools.linearsolver.MPSolverCommonParameters buildPartial ()
 
.lang.Override Builder clone ()
 
.lang.Override Builder setField (com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
 
.lang.Override Builder clearField (com.google.protobuf.Descriptors.FieldDescriptor field)
 
.lang.Override Builder clearOneof (com.google.protobuf.Descriptors.OneofDescriptor oneof)
 
.lang.Override Builder setRepeatedField (com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
 
.lang.Override Builder addRepeatedField (com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
 
.lang.Override Builder mergeFrom (com.google.protobuf.Message other)
 
Builder mergeFrom (com.google.ortools.linearsolver.MPSolverCommonParameters other)
 
.lang.Override final boolean isInitialized ()
 
.lang.Override Builder mergeFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
 
boolean hasRelativeMipGap ()
 
com.google.ortools.linearsolver.OptionalDouble getRelativeMipGap ()
 
Builder setRelativeMipGap (com.google.ortools.linearsolver.OptionalDouble value)
 
Builder setRelativeMipGap (com.google.ortools.linearsolver.OptionalDouble.Builder builderForValue)
 
Builder mergeRelativeMipGap (com.google.ortools.linearsolver.OptionalDouble value)
 
Builder clearRelativeMipGap ()
 
com.google.ortools.linearsolver.OptionalDouble.Builder getRelativeMipGapBuilder ()
 
com.google.ortools.linearsolver.OptionalDoubleOrBuilder getRelativeMipGapOrBuilder ()
 
boolean hasPrimalTolerance ()
 
com.google.ortools.linearsolver.OptionalDouble getPrimalTolerance ()
 
Builder setPrimalTolerance (com.google.ortools.linearsolver.OptionalDouble value)
 
Builder setPrimalTolerance (com.google.ortools.linearsolver.OptionalDouble.Builder builderForValue)
 
Builder mergePrimalTolerance (com.google.ortools.linearsolver.OptionalDouble value)
 
Builder clearPrimalTolerance ()
 
com.google.ortools.linearsolver.OptionalDouble.Builder getPrimalToleranceBuilder ()
 
com.google.ortools.linearsolver.OptionalDoubleOrBuilder getPrimalToleranceOrBuilder ()
 
boolean hasDualTolerance ()
 
com.google.ortools.linearsolver.OptionalDouble getDualTolerance ()
 
Builder setDualTolerance (com.google.ortools.linearsolver.OptionalDouble value)
 
Builder setDualTolerance (com.google.ortools.linearsolver.OptionalDouble.Builder builderForValue)
 
Builder mergeDualTolerance (com.google.ortools.linearsolver.OptionalDouble value)
 
Builder clearDualTolerance ()
 
com.google.ortools.linearsolver.OptionalDouble.Builder getDualToleranceBuilder ()
 
com.google.ortools.linearsolver.OptionalDoubleOrBuilder getDualToleranceOrBuilder ()
 
.lang.Override boolean hasLpAlgorithm ()
 
.lang.Override com.google.ortools.linearsolver.MPSolverCommonParameters.LPAlgorithmValues getLpAlgorithm ()
 
Builder setLpAlgorithm (com.google.ortools.linearsolver.MPSolverCommonParameters.LPAlgorithmValues value)
 
Builder clearLpAlgorithm ()
 
.lang.Override boolean hasPresolve ()
 
.lang.Override com.google.ortools.util.OptionalBoolean getPresolve ()
 
Builder setPresolve (com.google.ortools.util.OptionalBoolean value)
 
Builder clearPresolve ()
 
.lang.Override boolean hasScaling ()
 
.lang.Override com.google.ortools.util.OptionalBoolean getScaling ()
 
Builder setScaling (com.google.ortools.util.OptionalBoolean value)
 
Builder clearScaling ()
 
.lang.Override final Builder setUnknownFields (final com.google.protobuf.UnknownFieldSet unknownFields)
 
.lang.Override final Builder mergeUnknownFields (final com.google.protobuf.UnknownFieldSet unknownFields)
 

Static Public Member Functions

static final com.google.protobuf.Descriptors.Descriptor getDescriptor ()
 

Protected Member Functions

.lang.Override com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable ()
 

Member Function Documentation

◆ addRepeatedField()

.lang.Override Builder addRepeatedField ( com.google.protobuf.Descriptors.FieldDescriptor  field,
java.lang.Object  value 
)
inline

Definition at line 977 of file MPSolverCommonParameters.java.

◆ build()

Definition at line 896 of file MPSolverCommonParameters.java.

◆ buildPartial()

.lang.Override com.google.ortools.linearsolver.MPSolverCommonParameters buildPartial ( )
inline

Definition at line 905 of file MPSolverCommonParameters.java.

◆ clear()

.lang.Override Builder clear ( )
inline

Definition at line 855 of file MPSolverCommonParameters.java.

◆ clearDualTolerance()

Builder clearDualTolerance ( )
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;

Definition at line 1611 of file MPSolverCommonParameters.java.

◆ clearField()

.lang.Override Builder clearField ( com.google.protobuf.Descriptors.FieldDescriptor  field)
inline

Definition at line 961 of file MPSolverCommonParameters.java.

◆ clearLpAlgorithm()

Builder clearLpAlgorithm ( )
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
This builder for chaining.

Definition at line 1737 of file MPSolverCommonParameters.java.

◆ clearOneof()

.lang.Override Builder clearOneof ( com.google.protobuf.Descriptors.OneofDescriptor  oneof)
inline

Definition at line 966 of file MPSolverCommonParameters.java.

◆ clearPresolve()

Builder clearPresolve ( )
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
This builder for chaining.

Definition at line 1800 of file MPSolverCommonParameters.java.

◆ clearPrimalTolerance()

Builder clearPrimalTolerance ( )
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;

Definition at line 1422 of file MPSolverCommonParameters.java.

◆ clearRelativeMipGap()

Builder clearRelativeMipGap ( )
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;

Definition at line 1212 of file MPSolverCommonParameters.java.

◆ clearScaling()

Builder clearScaling ( )
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
This builder for chaining.

Definition at line 1867 of file MPSolverCommonParameters.java.

◆ clone()

.lang.Override Builder clone ( )
inline

Definition at line 951 of file MPSolverCommonParameters.java.

◆ getDefaultInstanceForType()

.lang.Override com.google.ortools.linearsolver.MPSolverCommonParameters getDefaultInstanceForType ( )
inline

Definition at line 891 of file MPSolverCommonParameters.java.

◆ getDescriptor()

static final com.google.protobuf.Descriptors.Descriptor getDescriptor ( )
inlinestatic

Definition at line 824 of file MPSolverCommonParameters.java.

◆ getDescriptorForType()

.lang.Override com.google.protobuf.Descriptors.Descriptor getDescriptorForType ( )
inline

Definition at line 886 of file MPSolverCommonParameters.java.

◆ 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;

Returns
The dualTolerance.

Implements MPSolverCommonParametersOrBuilder.

Definition at line 1519 of file MPSolverCommonParameters.java.

◆ getDualToleranceBuilder()

com.google.ortools.linearsolver.OptionalDouble.Builder getDualToleranceBuilder ( )
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;

Definition at line 1632 of file MPSolverCommonParameters.java.

◆ getDualToleranceOrBuilder()

com.google.ortools.linearsolver.OptionalDoubleOrBuilder 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 1648 of file MPSolverCommonParameters.java.

◆ 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];

Returns
The lpAlgorithm.

Implements MPSolverCommonParametersOrBuilder.

Definition at line 1704 of file MPSolverCommonParameters.java.

◆ getPresolve()

.lang.Override com.google.ortools.util.OptionalBoolean 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 1767 of file MPSolverCommonParameters.java.

◆ getPrimalTolerance()

com.google.ortools.linearsolver.OptionalDouble 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 1334 of file MPSolverCommonParameters.java.

◆ getPrimalToleranceBuilder()

com.google.ortools.linearsolver.OptionalDouble.Builder getPrimalToleranceBuilder ( )
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;

Definition at line 1442 of file MPSolverCommonParameters.java.

◆ getPrimalToleranceOrBuilder()

com.google.ortools.linearsolver.OptionalDoubleOrBuilder 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 1457 of file MPSolverCommonParameters.java.

◆ getRelativeMipGap()

com.google.ortools.linearsolver.OptionalDouble 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 1088 of file MPSolverCommonParameters.java.

◆ getRelativeMipGapBuilder()

com.google.ortools.linearsolver.OptionalDouble.Builder getRelativeMipGapBuilder ( )
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;

Definition at line 1241 of file MPSolverCommonParameters.java.

◆ getRelativeMipGapOrBuilder()

com.google.ortools.linearsolver.OptionalDoubleOrBuilder 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 1265 of file MPSolverCommonParameters.java.

◆ getScaling()

.lang.Override com.google.ortools.util.OptionalBoolean 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 1832 of file MPSolverCommonParameters.java.

◆ hasDualTolerance()

boolean 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 1504 of file MPSolverCommonParameters.java.

◆ hasLpAlgorithm()

.lang.Override boolean 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 1691 of file MPSolverCommonParameters.java.

◆ hasPresolve()

.lang.Override boolean 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 1754 of file MPSolverCommonParameters.java.

◆ hasPrimalTolerance()

boolean 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 1320 of file MPSolverCommonParameters.java.

◆ hasRelativeMipGap()

boolean 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 1065 of file MPSolverCommonParameters.java.

◆ hasScaling()

.lang.Override boolean 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 1818 of file MPSolverCommonParameters.java.

◆ internalGetFieldAccessorTable()

.lang.Override com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable ( )
inlineprotected

Definition at line 830 of file MPSolverCommonParameters.java.

◆ isInitialized()

.lang.Override final boolean isInitialized ( )
inline

Definition at line 1018 of file MPSolverCommonParameters.java.

◆ mergeDualTolerance()

Builder mergeDualTolerance ( com.google.ortools.linearsolver.OptionalDouble  value)
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;

Definition at line 1583 of file MPSolverCommonParameters.java.

◆ mergeFrom() [1/3]

◆ mergeFrom() [2/3]

.lang.Override Builder mergeFrom ( com.google.protobuf.CodedInputStream  input,
com.google.protobuf.ExtensionRegistryLite  extensionRegistry 
) throws java.io.IOException
inline

Definition at line 1023 of file MPSolverCommonParameters.java.

◆ mergeFrom() [3/3]

.lang.Override Builder mergeFrom ( com.google.protobuf.Message  other)
inline

Definition at line 983 of file MPSolverCommonParameters.java.

◆ mergePrimalTolerance()

Builder mergePrimalTolerance ( com.google.ortools.linearsolver.OptionalDouble  value)
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;

Definition at line 1395 of file MPSolverCommonParameters.java.

◆ mergeRelativeMipGap()

Builder mergeRelativeMipGap ( com.google.ortools.linearsolver.OptionalDouble  value)
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;

Definition at line 1176 of file MPSolverCommonParameters.java.

◆ mergeUnknownFields()

.lang.Override final Builder mergeUnknownFields ( final com.google.protobuf.UnknownFieldSet  unknownFields)
inline

Definition at line 1880 of file MPSolverCommonParameters.java.

◆ setDualTolerance() [1/2]

Builder setDualTolerance ( com.google.ortools.linearsolver.OptionalDouble  value)
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;

Definition at line 1537 of file MPSolverCommonParameters.java.

◆ setDualTolerance() [2/2]

Builder setDualTolerance ( com.google.ortools.linearsolver.OptionalDouble.Builder  builderForValue)
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;

Definition at line 1561 of file MPSolverCommonParameters.java.

◆ setField()

.lang.Override Builder setField ( com.google.protobuf.Descriptors.FieldDescriptor  field,
java.lang.Object  value 
)
inline

Definition at line 955 of file MPSolverCommonParameters.java.

◆ setLpAlgorithm()

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];

Parameters
valueThe lpAlgorithm to set.
Returns
This builder for chaining.

Definition at line 1719 of file MPSolverCommonParameters.java.

◆ setPresolve()

Builder setPresolve ( com.google.ortools.util.OptionalBoolean  value)
inline
Gurobi and SCIP enable presolve by default.
Ask or-core-team@ for other solvers.

optional .operations_research.OptionalBoolean presolve = 5 [default = BOOL_UNSPECIFIED];

Parameters
valueThe presolve to set.
Returns
This builder for chaining.

Definition at line 1782 of file MPSolverCommonParameters.java.

◆ setPrimalTolerance() [1/2]

Builder setPrimalTolerance ( com.google.ortools.linearsolver.OptionalDouble  value)
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;

Definition at line 1351 of file MPSolverCommonParameters.java.

◆ setPrimalTolerance() [2/2]

Builder setPrimalTolerance ( com.google.ortools.linearsolver.OptionalDouble.Builder  builderForValue)
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;

Definition at line 1374 of file MPSolverCommonParameters.java.

◆ setRelativeMipGap() [1/2]

Builder setRelativeMipGap ( com.google.ortools.linearsolver.OptionalDouble  value)
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;

Definition at line 1114 of file MPSolverCommonParameters.java.

◆ setRelativeMipGap() [2/2]

Builder setRelativeMipGap ( com.google.ortools.linearsolver.OptionalDouble.Builder  builderForValue)
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;

Definition at line 1146 of file MPSolverCommonParameters.java.

◆ setRepeatedField()

.lang.Override Builder setRepeatedField ( com.google.protobuf.Descriptors.FieldDescriptor  field,
int  index,
java.lang.Object  value 
)
inline

Definition at line 971 of file MPSolverCommonParameters.java.

◆ setScaling()

Builder setScaling ( com.google.ortools.util.OptionalBoolean  value)
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];

Parameters
valueThe scaling to set.
Returns
This builder for chaining.

Definition at line 1848 of file MPSolverCommonParameters.java.

◆ setUnknownFields()

.lang.Override final Builder setUnknownFields ( final com.google.protobuf.UnknownFieldSet  unknownFields)
inline

Definition at line 1874 of file MPSolverCommonParameters.java.


The documentation for this class was generated from the following file: