Java Reference

Java Reference

MPSolverCommonParametersOrBuilder

Detailed Description

Definition at line 6 of file MPSolverCommonParametersOrBuilder.java.

Public Member Functions

boolean hasRelativeMipGap ()
 
com.google.ortools.linearsolver.OptionalDouble getRelativeMipGap ()
 
com.google.ortools.linearsolver.OptionalDoubleOrBuilder getRelativeMipGapOrBuilder ()
 
boolean hasPrimalTolerance ()
 
com.google.ortools.linearsolver.OptionalDouble getPrimalTolerance ()
 
com.google.ortools.linearsolver.OptionalDoubleOrBuilder getPrimalToleranceOrBuilder ()
 
boolean hasDualTolerance ()
 
com.google.ortools.linearsolver.OptionalDouble getDualTolerance ()
 
com.google.ortools.linearsolver.OptionalDoubleOrBuilder getDualToleranceOrBuilder ()
 
boolean hasLpAlgorithm ()
 
com.google.ortools.linearsolver.MPSolverCommonParameters.LPAlgorithmValues getLpAlgorithm ()
 
boolean hasPresolve ()
 
com.google.ortools.util.OptionalBoolean getPresolve ()
 
boolean hasScaling ()
 
com.google.ortools.util.OptionalBoolean getScaling ()
 

Member Function Documentation

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

Implemented in MPSolverCommonParameters.Builder, and 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;

Implemented in MPSolverCommonParameters.Builder, and 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];

Returns
The lpAlgorithm.

Implemented in MPSolverCommonParameters.Builder, and 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];

Returns
The presolve.

Implemented in MPSolverCommonParameters.Builder, and 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;

Returns
The primalTolerance.

Implemented in MPSolverCommonParameters.Builder, and 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;

Implemented in MPSolverCommonParameters.Builder, and 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;

Returns
The relativeMipGap.

Implemented in MPSolverCommonParameters.Builder, and 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;

Implemented in MPSolverCommonParameters.Builder, and 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];

Returns
The scaling.

Implemented in MPSolverCommonParameters.Builder, and MPSolverCommonParameters.

◆ hasDualTolerance()

boolean 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.

Implemented in MPSolverCommonParameters.Builder, and MPSolverCommonParameters.

◆ hasLpAlgorithm()

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

Returns
Whether the lpAlgorithm field is set.

Implemented in MPSolverCommonParameters.Builder, and MPSolverCommonParameters.

◆ hasPresolve()

boolean hasPresolve ( )
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.

Implemented in MPSolverCommonParameters.Builder, and MPSolverCommonParameters.

◆ hasPrimalTolerance()

boolean 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.

Implemented in MPSolverCommonParameters.Builder, and MPSolverCommonParameters.

◆ hasRelativeMipGap()

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

Returns
Whether the relativeMipGap field is set.

Implemented in MPSolverCommonParameters.Builder, and MPSolverCommonParameters.

◆ hasScaling()

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

Returns
Whether the scaling field is set.

Implemented in MPSolverCommonParameters.Builder, and MPSolverCommonParameters.


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