Inheritance diagram for com.google.ortools.linearsolver.MPSolverCommonParameters.Builder:

Public Member Functions
Builder	clear ()

com.google.protobuf.Descriptors.Descriptor	getDescriptorForType ()

com.google.ortools.linearsolver.MPSolverCommonParameters	getDefaultInstanceForType ()

com.google.ortools.linearsolver.MPSolverCommonParameters	build ()

com.google.ortools.linearsolver.MPSolverCommonParameters	buildPartial ()

Builder	mergeFrom (com.google.protobuf.Message other)

Builder	mergeFrom (com.google.ortools.linearsolver.MPSolverCommonParameters other)

final boolean	isInitialized ()

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 ()

boolean	hasLpAlgorithm ()

com.google.ortools.linearsolver.MPSolverCommonParameters.LPAlgorithmValues	getLpAlgorithm ()

Builder	setLpAlgorithm (com.google.ortools.linearsolver.MPSolverCommonParameters.LPAlgorithmValues value)

Builder	clearLpAlgorithm ()

boolean	hasPresolve ()

com.google.ortools.util.OptionalBoolean	getPresolve ()

Builder	setPresolve (com.google.ortools.util.OptionalBoolean value)

Builder	clearPresolve ()

boolean	hasScaling ()

com.google.ortools.util.OptionalBoolean	getScaling ()

Builder	setScaling (com.google.ortools.util.OptionalBoolean value)

Builder	clearScaling ()

Static Public Member Functions
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor ()

Protected Member Functions
com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable ()

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

Member Function Documentation

◆ build()

com.google.ortools.linearsolver.MPSolverCommonParameters com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.build ( )

Definition at line 791 of file MPSolverCommonParameters.java.

◆ buildPartial()

com.google.ortools.linearsolver.MPSolverCommonParameters com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.buildPartial ( )

Definition at line 800 of file MPSolverCommonParameters.java.

◆ clear()

Builder com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.clear ( )

Definition at line 755 of file MPSolverCommonParameters.java.

◆ clearDualTolerance()

Builder com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.clearDualTolerance ( )

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

◆ clearLpAlgorithm()

Builder com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.clearLpAlgorithm ( )

Algorithm to solve linear programs.
Ask or-core-team&#64; 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 1688 of file MPSolverCommonParameters.java.

◆ clearPresolve()

Builder com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.clearPresolve ( )

Gurobi and SCIP enable presolve by default.
Ask or-core-team&#64; for other solvers.

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

Returns: This builder for chaining.

Definition at line 1750 of file MPSolverCommonParameters.java.

◆ clearPrimalTolerance()

Builder com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.clearPrimalTolerance ( )

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

◆ clearRelativeMipGap()

Builder com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.clearRelativeMipGap ( )

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&#64; for other solvers.

optional .operations_research.OptionalDouble relative_mip_gap = 1;

Definition at line 1156 of file MPSolverCommonParameters.java.

◆ clearScaling()

Builder com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.clearScaling ( )

Enable automatic scaling of matrix coefficients and objective. Available
for Gurobi and GLOP.
Ask or-core-team&#64; if you want more details.

optional .operations_research.OptionalBoolean scaling = 7 [default = BOOL_UNSPECIFIED];

Returns: This builder for chaining.

Definition at line 1816 of file MPSolverCommonParameters.java.

◆ getDefaultInstanceForType()

com.google.ortools.linearsolver.MPSolverCommonParameters com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.getDefaultInstanceForType ( )

Definition at line 786 of file MPSolverCommonParameters.java.

◆ getDescriptor()

static final com.google.protobuf.Descriptors.Descriptor com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.getDescriptor ( )

static

Definition at line 724 of file MPSolverCommonParameters.java.

◆ getDescriptorForType()

com.google.protobuf.Descriptors.Descriptor com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.getDescriptorForType ( )

Definition at line 781 of file MPSolverCommonParameters.java.

◆ getDualTolerance()

com.google.ortools.linearsolver.OptionalDouble com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.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 com.google.ortools.linearsolver.MPSolverCommonParametersOrBuilder.

Definition at line 1470 of file MPSolverCommonParameters.java.

◆ getDualToleranceBuilder()

com.google.ortools.linearsolver.OptionalDouble.Builder com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.getDualToleranceBuilder ( )

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

◆ getDualToleranceOrBuilder()

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

◆ getLpAlgorithm()

com.google.ortools.linearsolver.MPSolverCommonParameters.LPAlgorithmValues com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.getLpAlgorithm ( )

Algorithm to solve linear programs.
Ask or-core-team&#64; 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 com.google.ortools.linearsolver.MPSolverCommonParametersOrBuilder.

Definition at line 1656 of file MPSolverCommonParameters.java.

◆ getPresolve()

com.google.ortools.util.OptionalBoolean com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.getPresolve ( )

Gurobi and SCIP enable presolve by default.
Ask or-core-team&#64; for other solvers.

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

Returns: The presolve.

Implements com.google.ortools.linearsolver.MPSolverCommonParametersOrBuilder.

Definition at line 1718 of file MPSolverCommonParameters.java.

◆ getPrimalTolerance()

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

Returns: The primalTolerance.

Implements com.google.ortools.linearsolver.MPSolverCommonParametersOrBuilder.

Definition at line 1284 of file MPSolverCommonParameters.java.

◆ getPrimalToleranceBuilder()

com.google.ortools.linearsolver.OptionalDouble.Builder com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.getPrimalToleranceBuilder ( )

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

◆ getPrimalToleranceOrBuilder()

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

◆ getRelativeMipGap()

com.google.ortools.linearsolver.OptionalDouble com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.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&#64; for other solvers.

optional .operations_research.OptionalDouble relative_mip_gap = 1;

Returns: The relativeMipGap.

Implements com.google.ortools.linearsolver.MPSolverCommonParametersOrBuilder.

Definition at line 1023 of file MPSolverCommonParameters.java.

◆ getRelativeMipGapBuilder()

com.google.ortools.linearsolver.OptionalDouble.Builder com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.getRelativeMipGapBuilder ( )

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&#64; for other solvers.

optional .operations_research.OptionalDouble relative_mip_gap = 1;

Definition at line 1187 of file MPSolverCommonParameters.java.

◆ getRelativeMipGapOrBuilder()

com.google.ortools.linearsolver.OptionalDoubleOrBuilder com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.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&#64; for other solvers.

optional .operations_research.OptionalDouble relative_mip_gap = 1;

Implements com.google.ortools.linearsolver.MPSolverCommonParametersOrBuilder.

Definition at line 1213 of file MPSolverCommonParameters.java.

◆ getScaling()

com.google.ortools.util.OptionalBoolean com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.getScaling ( )

Enable automatic scaling of matrix coefficients and objective. Available
for Gurobi and GLOP.
Ask or-core-team&#64; if you want more details.

optional .operations_research.OptionalBoolean scaling = 7 [default = BOOL_UNSPECIFIED];

Returns: The scaling.

Implements com.google.ortools.linearsolver.MPSolverCommonParametersOrBuilder.

Definition at line 1782 of file MPSolverCommonParameters.java.

◆ hasDualTolerance()

boolean com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.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;

Returns: Whether the dualTolerance field is set.

Implements com.google.ortools.linearsolver.MPSolverCommonParametersOrBuilder.

Definition at line 1455 of file MPSolverCommonParameters.java.

◆ hasLpAlgorithm()

boolean com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.hasLpAlgorithm ( )

Algorithm to solve linear programs.
Ask or-core-team&#64; 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 com.google.ortools.linearsolver.MPSolverCommonParametersOrBuilder.

Definition at line 1643 of file MPSolverCommonParameters.java.

◆ hasPresolve()

boolean com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.hasPresolve ( )

Gurobi and SCIP enable presolve by default.
Ask or-core-team&#64; for other solvers.

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

Returns: Whether the presolve field is set.

Implements com.google.ortools.linearsolver.MPSolverCommonParametersOrBuilder.

Definition at line 1705 of file MPSolverCommonParameters.java.

◆ hasPrimalTolerance()

boolean com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.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;

Returns: Whether the primalTolerance field is set.

Implements com.google.ortools.linearsolver.MPSolverCommonParametersOrBuilder.

Definition at line 1270 of file MPSolverCommonParameters.java.

◆ hasRelativeMipGap()

boolean com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.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&#64; for other solvers.

optional .operations_research.OptionalDouble relative_mip_gap = 1;

Returns: Whether the relativeMipGap field is set.

Implements com.google.ortools.linearsolver.MPSolverCommonParametersOrBuilder.

Definition at line 998 of file MPSolverCommonParameters.java.

◆ hasScaling()

boolean com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.hasScaling ( )

Enable automatic scaling of matrix coefficients and objective. Available
for Gurobi and GLOP.
Ask or-core-team&#64; if you want more details.

optional .operations_research.OptionalBoolean scaling = 7 [default = BOOL_UNSPECIFIED];

Returns: Whether the scaling field is set.

Implements com.google.ortools.linearsolver.MPSolverCommonParametersOrBuilder.

Definition at line 1768 of file MPSolverCommonParameters.java.

◆ internalGetFieldAccessorTable()

com.google.protobuf.GeneratedMessage.FieldAccessorTable com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.internalGetFieldAccessorTable ( )

protected

Definition at line 730 of file MPSolverCommonParameters.java.

◆ isInitialized()

final boolean com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.isInitialized ( )

Definition at line 879 of file MPSolverCommonParameters.java.

◆ mergeDualTolerance()

Builder com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.mergeDualTolerance ( com.google.ortools.linearsolver.OptionalDouble value )

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

◆ mergeFrom() [1/3]

Builder com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.mergeFrom ( com.google.ortools.linearsolver.MPSolverCommonParameters other )

Definition at line 853 of file MPSolverCommonParameters.java.

◆ mergeFrom() [2/3]

Builder com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.mergeFrom	(	com.google.protobuf.CodedInputStream	input,
		com.google.protobuf.ExtensionRegistryLite	extensionRegistry ) throws java.io.IOException

Definition at line 884 of file MPSolverCommonParameters.java.

◆ mergeFrom() [3/3]

Builder com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.mergeFrom ( com.google.protobuf.Message other )

Definition at line 844 of file MPSolverCommonParameters.java.

◆ mergePrimalTolerance()

Builder com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.mergePrimalTolerance ( com.google.ortools.linearsolver.OptionalDouble value )

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

◆ mergeRelativeMipGap()

Builder com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.mergeRelativeMipGap ( com.google.ortools.linearsolver.OptionalDouble value )

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&#64; for other solvers.

optional .operations_research.OptionalDouble relative_mip_gap = 1;

Definition at line 1117 of file MPSolverCommonParameters.java.

◆ setDualTolerance() [1/2]

Builder com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.setDualTolerance ( com.google.ortools.linearsolver.OptionalDouble value )

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

◆ setDualTolerance() [2/2]

Builder com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.setDualTolerance ( com.google.ortools.linearsolver.OptionalDouble.Builder builderForValue )

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

◆ setLpAlgorithm()

Builder com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.setLpAlgorithm ( com.google.ortools.linearsolver.MPSolverCommonParameters.LPAlgorithmValues value )

Algorithm to solve linear programs.
Ask or-core-team&#64; if you want to know what this does exactly.

optional .operations_research.MPSolverCommonParameters.LPAlgorithmValues lp_algorithm = 4 [default = LP_ALGO_UNSPECIFIED];

Parameters

value The lpAlgorithm to set.

Returns: This builder for chaining.

Definition at line 1670 of file MPSolverCommonParameters.java.

◆ setPresolve()

Builder com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.setPresolve ( com.google.ortools.util.OptionalBoolean value )

Gurobi and SCIP enable presolve by default.
Ask or-core-team&#64; for other solvers.

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

Parameters

value The presolve to set.

Returns: This builder for chaining.

Definition at line 1732 of file MPSolverCommonParameters.java.

◆ setPrimalTolerance() [1/2]

Builder com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.setPrimalTolerance ( com.google.ortools.linearsolver.OptionalDouble value )

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

◆ setPrimalTolerance() [2/2]

Builder com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.setPrimalTolerance ( com.google.ortools.linearsolver.OptionalDouble.Builder builderForValue )

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

◆ setRelativeMipGap() [1/2]

Builder com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.setRelativeMipGap ( com.google.ortools.linearsolver.OptionalDouble value )

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&#64; for other solvers.

optional .operations_research.OptionalDouble relative_mip_gap = 1;

Definition at line 1051 of file MPSolverCommonParameters.java.

◆ setRelativeMipGap() [2/2]

Builder com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.setRelativeMipGap ( com.google.ortools.linearsolver.OptionalDouble.Builder builderForValue )

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&#64; for other solvers.

optional .operations_research.OptionalDouble relative_mip_gap = 1;

Definition at line 1085 of file MPSolverCommonParameters.java.

◆ setScaling()

Builder com.google.ortools.linearsolver.MPSolverCommonParameters.Builder.setScaling ( com.google.ortools.util.OptionalBoolean value )

Enable automatic scaling of matrix coefficients and objective. Available
for Gurobi and GLOP.
Ask or-core-team&#64; if you want more details.

optional .operations_research.OptionalBoolean scaling = 7 [default = BOOL_UNSPECIFIED];

Parameters

value The scaling to set.

Returns: This builder for chaining.

Definition at line 1797 of file MPSolverCommonParameters.java.

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

build/java/ortools-java/src/main/java/com/google/ortools/linearsolver/MPSolverCommonParameters.java

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ build()

◆ buildPartial()

◆ clear()

◆ clearDualTolerance()

◆ clearLpAlgorithm()

◆ clearPresolve()

◆ clearPrimalTolerance()

◆ clearRelativeMipGap()

◆ clearScaling()

◆ getDefaultInstanceForType()

◆ getDescriptor()

◆ getDescriptorForType()

◆ getDualTolerance()

◆ getDualToleranceBuilder()

◆ getDualToleranceOrBuilder()

◆ getLpAlgorithm()

◆ getPresolve()

◆ getPrimalTolerance()

◆ getPrimalToleranceBuilder()

◆ getPrimalToleranceOrBuilder()

◆ getRelativeMipGap()

◆ getRelativeMipGapBuilder()

◆ getRelativeMipGapOrBuilder()

◆ getScaling()

◆ hasDualTolerance()

◆ hasLpAlgorithm()

◆ hasPresolve()

◆ hasPrimalTolerance()

◆ hasRelativeMipGap()

◆ hasScaling()

◆ internalGetFieldAccessorTable()

◆ isInitialized()

◆ mergeDualTolerance()

◆ mergeFrom() [1/3]

◆ mergeFrom() [2/3]

◆ mergeFrom() [3/3]

◆ mergePrimalTolerance()

◆ mergeRelativeMipGap()

◆ setDualTolerance() [1/2]

◆ setDualTolerance() [2/2]

◆ setLpAlgorithm()

◆ setPresolve()

◆ setPrimalTolerance() [1/2]

◆ setPrimalTolerance() [2/2]

◆ setRelativeMipGap() [1/2]

◆ setRelativeMipGap() [2/2]

◆ setScaling()