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

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.

Definition at line 5577 of file LinearSolver.pb.cs.

Inheritance diagram for OperationsResearch.MPSolverCommonParameters:

Classes
class	Types
	Container for nested types declared in the MPSolverCommonParameters message type. More...

Public Member Functions
	MPSolverCommonParameters ()
	MPSolverCommonParameters (MPSolverCommonParameters other)
MPSolverCommonParameters	Clone ()
void	ClearLpAlgorithm ()
	Clears the value of the "lp_algorithm" field.
void	ClearPresolve ()
	Clears the value of the "presolve" field.
void	ClearScaling ()
	Clears the value of the "scaling" field.
override bool	Equals (object other)
bool	Equals (MPSolverCommonParameters other)
override int	GetHashCode ()
override string	ToString ()
void	WriteTo (pb::CodedOutputStream output)
int	CalculateSize ()
void	MergeFrom (MPSolverCommonParameters other)
void	MergeFrom (pb::CodedInputStream input)

Static Public Attributes
const int	RelativeMipGapFieldNumber = 1
	Field number for the "relative_mip_gap" field.
const int	PrimalToleranceFieldNumber = 2
	Field number for the "primal_tolerance" field.
const int	DualToleranceFieldNumber = 3
	Field number for the "dual_tolerance" field.
const int	LpAlgorithmFieldNumber = 4
	Field number for the "lp_algorithm" field.
const int	PresolveFieldNumber = 5
	Field number for the "presolve" field.
const int	ScalingFieldNumber = 7
	Field number for the "scaling" field.

Properties
static pb::MessageParser< MPSolverCommonParameters >	Parser `[get]`
static pbr::MessageDescriptor	Descriptor `[get]`
global::OperationsResearch.OptionalDouble	RelativeMipGap `[get, set]`
	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:
global::OperationsResearch.OptionalDouble	PrimalTolerance `[get, set]`
	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.
global::OperationsResearch.OptionalDouble	DualTolerance `[get, set]`
	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.
global::OperationsResearch.MPSolverCommonParameters.Types.LPAlgorithmValues	LpAlgorithm `[get, set]`
	Algorithm to solve linear programs. Ask or-core-team@ if you want to know what this does exactly.
bool	HasLpAlgorithm `[get]`
	Gets whether the "lp_algorithm" field is set.
global::Google.OrTools.Util.OptionalBoolean	Presolve `[get, set]`
	Gurobi and SCIP enable presolve by default. Ask or-core-team@ for other solvers.
bool	HasPresolve `[get]`
	Gets whether the "presolve" field is set.
global::Google.OrTools.Util.OptionalBoolean	Scaling `[get, set]`
	Enable automatic scaling of matrix coefficients and objective. Available for Gurobi and GLOP. Ask or-core-team@ if you want more details.
bool	HasScaling `[get]`
	Gets whether the "scaling" field is set.

Constructor & Destructor Documentation

◆ MPSolverCommonParameters() [1/2]

OperationsResearch.MPSolverCommonParameters.MPSolverCommonParameters ( )

inline

Definition at line 5603 of file LinearSolver.pb.cs.

◆ MPSolverCommonParameters() [2/2]

OperationsResearch.MPSolverCommonParameters.MPSolverCommonParameters ( MPSolverCommonParameters other )

inline

Definition at line 5611 of file LinearSolver.pb.cs.

Member Function Documentation

◆ CalculateSize()

int OperationsResearch.MPSolverCommonParameters.CalculateSize ( )

inline

Definition at line 5908 of file LinearSolver.pb.cs.

◆ ClearLpAlgorithm()

void OperationsResearch.MPSolverCommonParameters.ClearLpAlgorithm ( )

inline

Clears the value of the "lp_algorithm" field.

Definition at line 5723 of file LinearSolver.pb.cs.

◆ ClearPresolve()

void OperationsResearch.MPSolverCommonParameters.ClearPresolve ( )

inline

Clears the value of the "presolve" field.

Definition at line 5754 of file LinearSolver.pb.cs.

◆ ClearScaling()

void OperationsResearch.MPSolverCommonParameters.ClearScaling ( )

inline

Clears the value of the "scaling" field.

Definition at line 5786 of file LinearSolver.pb.cs.

◆ Clone()

MPSolverCommonParameters OperationsResearch.MPSolverCommonParameters.Clone ( )

inline

Definition at line 5624 of file LinearSolver.pb.cs.

◆ Equals() [1/2]

bool OperationsResearch.MPSolverCommonParameters.Equals ( MPSolverCommonParameters other )

inline

Definition at line 5798 of file LinearSolver.pb.cs.

◆ Equals() [2/2]

override bool OperationsResearch.MPSolverCommonParameters.Equals ( object other )

inline

Definition at line 5792 of file LinearSolver.pb.cs.

◆ GetHashCode()

override int OperationsResearch.MPSolverCommonParameters.GetHashCode ( )

inline

Definition at line 5816 of file LinearSolver.pb.cs.

◆ MergeFrom() [1/2]

void OperationsResearch.MPSolverCommonParameters.MergeFrom ( MPSolverCommonParameters other )

inline

Definition at line 5936 of file LinearSolver.pb.cs.

◆ MergeFrom() [2/2]

void OperationsResearch.MPSolverCommonParameters.MergeFrom ( pb.CodedInputStream input )

inline

Definition at line 5972 of file LinearSolver.pb.cs.

◆ ToString()

override string OperationsResearch.MPSolverCommonParameters.ToString ( )

inline

Definition at line 5832 of file LinearSolver.pb.cs.

◆ WriteTo()

void OperationsResearch.MPSolverCommonParameters.WriteTo ( pb.CodedOutputStream output )

inline

Definition at line 5838 of file LinearSolver.pb.cs.

Member Data Documentation

◆ DualToleranceFieldNumber

const int OperationsResearch.MPSolverCommonParameters.DualToleranceFieldNumber = 3

static

Field number for the "dual_tolerance" field.

Definition at line 5678 of file LinearSolver.pb.cs.

◆ LpAlgorithmFieldNumber

const int OperationsResearch.MPSolverCommonParameters.LpAlgorithmFieldNumber = 4

static

Field number for the "lp_algorithm" field.

Definition at line 5697 of file LinearSolver.pb.cs.

◆ PresolveFieldNumber

const int OperationsResearch.MPSolverCommonParameters.PresolveFieldNumber = 5

static

Field number for the "presolve" field.

Definition at line 5728 of file LinearSolver.pb.cs.

◆ PrimalToleranceFieldNumber

const int OperationsResearch.MPSolverCommonParameters.PrimalToleranceFieldNumber = 2

static

Field number for the "primal_tolerance" field.

Definition at line 5660 of file LinearSolver.pb.cs.

◆ RelativeMipGapFieldNumber

const int OperationsResearch.MPSolverCommonParameters.RelativeMipGapFieldNumber = 1

static

Field number for the "relative_mip_gap" field.

Definition at line 5629 of file LinearSolver.pb.cs.

◆ ScalingFieldNumber

const int OperationsResearch.MPSolverCommonParameters.ScalingFieldNumber = 7

static

Field number for the "scaling" field.

Definition at line 5759 of file LinearSolver.pb.cs.

Property Documentation

◆ Descriptor

pbr.MessageDescriptor OperationsResearch.MPSolverCommonParameters.Descriptor

staticget

Definition at line 5591 of file LinearSolver.pb.cs.

◆ DualTolerance

global.OperationsResearch.OptionalDouble OperationsResearch.MPSolverCommonParameters.DualTolerance

getset

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.

Definition at line 5689 of file LinearSolver.pb.cs.

◆ HasLpAlgorithm

bool OperationsResearch.MPSolverCommonParameters.HasLpAlgorithm

get

Gets whether the "lp_algorithm" field is set.

Definition at line 5717 of file LinearSolver.pb.cs.

◆ HasPresolve

bool OperationsResearch.MPSolverCommonParameters.HasPresolve

get

Gets whether the "presolve" field is set.

Definition at line 5748 of file LinearSolver.pb.cs.

◆ HasScaling

bool OperationsResearch.MPSolverCommonParameters.HasScaling

get

Gets whether the "scaling" field is set.

Definition at line 5780 of file LinearSolver.pb.cs.

◆ LpAlgorithm

global.OperationsResearch.MPSolverCommonParameters.Types.LPAlgorithmValues OperationsResearch.MPSolverCommonParameters.LpAlgorithm

getset

Algorithm to solve linear programs. Ask or-core-team@ if you want to know what this does exactly.

Definition at line 5707 of file LinearSolver.pb.cs.

◆ Parser

pb.MessageParser<MPSolverCommonParameters> OperationsResearch.MPSolverCommonParameters.Parser

staticget

Definition at line 5587 of file LinearSolver.pb.cs.

◆ Presolve

global.Google.OrTools.Util.OptionalBoolean OperationsResearch.MPSolverCommonParameters.Presolve

getset

Gurobi and SCIP enable presolve by default. Ask or-core-team@ for other solvers.

Definition at line 5738 of file LinearSolver.pb.cs.

◆ PrimalTolerance

global.OperationsResearch.OptionalDouble OperationsResearch.MPSolverCommonParameters.PrimalTolerance

getset

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.

Definition at line 5670 of file LinearSolver.pb.cs.

◆ RelativeMipGap

global.OperationsResearch.OptionalDouble OperationsResearch.MPSolverCommonParameters.RelativeMipGap

getset

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.

Definition at line 5652 of file LinearSolver.pb.cs.

◆ Scaling

global.Google.OrTools.Util.OptionalBoolean OperationsResearch.MPSolverCommonParameters.Scaling

getset

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

Definition at line 5770 of file LinearSolver.pb.cs.

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

build/dotnet/Google.OrTools/ortools/linear_solver/LinearSolver.pb.cs

Detailed Description

Classes

Public Member Functions

Static Public Attributes

Properties

Constructor & Destructor Documentation

◆ MPSolverCommonParameters() [1/2]

◆ MPSolverCommonParameters() [2/2]

Member Function Documentation

◆ CalculateSize()

◆ ClearLpAlgorithm()

◆ ClearPresolve()

◆ ClearScaling()

◆ Clone()

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ MergeFrom() [1/2]

◆ MergeFrom() [2/2]

◆ ToString()

◆ WriteTo()

Member Data Documentation

◆ DualToleranceFieldNumber

◆ LpAlgorithmFieldNumber

◆ PresolveFieldNumber

◆ PrimalToleranceFieldNumber

◆ RelativeMipGapFieldNumber

◆ ScalingFieldNumber

Property Documentation

◆ Descriptor

◆ DualTolerance

◆ HasLpAlgorithm

◆ HasPresolve

◆ HasScaling

◆ LpAlgorithm

◆ Parser

◆ Presolve

◆ PrimalTolerance

◆ RelativeMipGap

◆ Scaling