Google OR-Tools v9.12
a fast and portable software suite for combinatorial optimization
Loading...
Searching...
No Matches
Classes | Public Member Functions | Static Public Attributes | Properties | List of all members
OperationsResearch.MPModelRequest Class Referencesealed

Next id: 18. More...

Inheritance diagram for OperationsResearch.MPModelRequest:

Classes

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

Public Member Functions

 MPModelRequest ()
 
 MPModelRequest (MPModelRequest other)
 
MPModelRequest Clone ()
 
void ClearSolverType ()
 Clears the value of the "solver_type" field.
 
void ClearSolverTimeLimitSeconds ()
 Clears the value of the "solver_time_limit_seconds" field.
 
void ClearEnableInternalSolverOutput ()
 Clears the value of the "enable_internal_solver_output" field.
 
void ClearSolverSpecificParameters ()
 Clears the value of the "solver_specific_parameters" field.
 
void ClearIgnoreSolverSpecificParametersFailure ()
 Clears the value of the "ignore_solver_specific_parameters_failure" field.
 
void ClearPopulateAdditionalSolutionsUpTo ()
 Clears the value of the "populate_additional_solutions_up_to" field.
 
override bool Equals (object other)
 
bool Equals (MPModelRequest other)
 
override int GetHashCode ()
 
override string ToString ()
 
void WriteTo (pb::CodedOutputStream output)
 
int CalculateSize ()
 
void MergeFrom (MPModelRequest other)
 
void MergeFrom (pb::CodedInputStream input)
 

Static Public Attributes

const int ModelFieldNumber = 1
 Field number for the "model" field.
 
const int SolverTypeFieldNumber = 2
 Field number for the "solver_type" field.
 
const int SolverTimeLimitSecondsFieldNumber = 3
 Field number for the "solver_time_limit_seconds" field.
 
const int EnableInternalSolverOutputFieldNumber = 4
 Field number for the "enable_internal_solver_output" field.
 
const int SolverSpecificParametersFieldNumber = 5
 Field number for the "solver_specific_parameters" field.
 
const int IgnoreSolverSpecificParametersFailureFieldNumber = 9
 Field number for the "ignore_solver_specific_parameters_failure" field.
 
const int ModelDeltaFieldNumber = 8
 Field number for the "model_delta" field.
 
const int PopulateAdditionalSolutionsUpToFieldNumber = 11
 Field number for the "populate_additional_solutions_up_to" field.
 

Properties

static pb::MessageParser< MPModelRequest > Parser [get]
 
static pbr::MessageDescriptor Descriptor [get]
 
global::OperationsResearch.MPModelProto Model [get, set]
 The model to be optimized by the server.
 
global::OperationsResearch.MPModelRequest.Types.SolverType SolverType [get, set]
 
bool HasSolverType [get]
 Gets whether the "solver_type" field is set.
 
double SolverTimeLimitSeconds [get, set]
 Maximum time to be spent by the solver to solve 'model'. If the server is busy and the RPC's deadline_left is less than this, it will immediately give up and return an error, without even trying to solve.
 
bool HasSolverTimeLimitSeconds [get]
 Gets whether the "solver_time_limit_seconds" field is set.
 
bool EnableInternalSolverOutput [get, set]
 If this is set, then EnableOutput() will be set on the internal MPSolver that solves the model.
 
bool HasEnableInternalSolverOutput [get]
 Gets whether the "enable_internal_solver_output" field is set.
 
string SolverSpecificParameters [get, set]
 Advanced usage. Solver-specific parameters in the solver's own format, different for each solver. For example, if you use SCIP and you want to stop the solve earlier than the time limit if it reached a solution that is at most 1% away from the optimal, you can set this to "limits/gap=0.01".
 
bool HasSolverSpecificParameters [get]
 Gets whether the "solver_specific_parameters" field is set.
 
bool IgnoreSolverSpecificParametersFailure [get, set]
 
bool HasIgnoreSolverSpecificParametersFailure [get]
 Gets whether the "ignore_solver_specific_parameters_failure" field is set.
 
global::OperationsResearch.MPModelDeltaProto ModelDelta [get, set]
 Advanced usage: model "delta". If used, "model" must be unset. See the definition of MPModelDeltaProto.
 
int PopulateAdditionalSolutionsUpTo [get, set]
 Controls the recovery of additional solutions, if any, saved by the underlying solver back in the MPSolutionResponse.additional_solutions. The repeated field will be length min(populate_addition_solutions_up_to, #additional_solutions_available_in_underlying_solver) These additional solutions may have a worse objective than the main solution returned in the response.
 
bool HasPopulateAdditionalSolutionsUpTo [get]
 Gets whether the "populate_additional_solutions_up_to" field is set.
 

Detailed Description

Next id: 18.

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

Constructor & Destructor Documentation

◆ MPModelRequest() [1/2]

OperationsResearch.MPModelRequest.MPModelRequest ( )
inline

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

◆ MPModelRequest() [2/2]

OperationsResearch.MPModelRequest.MPModelRequest ( MPModelRequest other)
inline

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

Member Function Documentation

◆ CalculateSize()

int OperationsResearch.MPModelRequest.CalculateSize ( )
inline

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

◆ ClearEnableInternalSolverOutput()

void OperationsResearch.MPModelRequest.ClearEnableInternalSolverOutput ( )
inline

Clears the value of the "enable_internal_solver_output" field.

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

◆ ClearIgnoreSolverSpecificParametersFailure()

void OperationsResearch.MPModelRequest.ClearIgnoreSolverSpecificParametersFailure ( )
inline

Clears the value of the "ignore_solver_specific_parameters_failure" field.

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

◆ ClearPopulateAdditionalSolutionsUpTo()

void OperationsResearch.MPModelRequest.ClearPopulateAdditionalSolutionsUpTo ( )
inline

Clears the value of the "populate_additional_solutions_up_to" field.

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

◆ ClearSolverSpecificParameters()

void OperationsResearch.MPModelRequest.ClearSolverSpecificParameters ( )
inline

Clears the value of the "solver_specific_parameters" field.

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

◆ ClearSolverTimeLimitSeconds()

void OperationsResearch.MPModelRequest.ClearSolverTimeLimitSeconds ( )
inline

Clears the value of the "solver_time_limit_seconds" field.

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

◆ ClearSolverType()

void OperationsResearch.MPModelRequest.ClearSolverType ( )
inline

Clears the value of the "solver_type" field.

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

◆ Clone()

MPModelRequest OperationsResearch.MPModelRequest.Clone ( )
inline

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

◆ Equals() [1/2]

bool OperationsResearch.MPModelRequest.Equals ( MPModelRequest other)
inline

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

◆ Equals() [2/2]

override bool OperationsResearch.MPModelRequest.Equals ( object other)
inline

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

◆ GetHashCode()

override int OperationsResearch.MPModelRequest.GetHashCode ( )
inline

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

◆ MergeFrom() [1/2]

void OperationsResearch.MPModelRequest.MergeFrom ( MPModelRequest other)
inline

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

◆ MergeFrom() [2/2]

void OperationsResearch.MPModelRequest.MergeFrom ( pb.CodedInputStream input)
inline

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

◆ ToString()

override string OperationsResearch.MPModelRequest.ToString ( )
inline

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

◆ WriteTo()

void OperationsResearch.MPModelRequest.WriteTo ( pb.CodedOutputStream output)
inline

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

Member Data Documentation

◆ EnableInternalSolverOutputFieldNumber

const int OperationsResearch.MPModelRequest.EnableInternalSolverOutputFieldNumber = 4
static

Field number for the "enable_internal_solver_output" field.

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

◆ IgnoreSolverSpecificParametersFailureFieldNumber

const int OperationsResearch.MPModelRequest.IgnoreSolverSpecificParametersFailureFieldNumber = 9
static

Field number for the "ignore_solver_specific_parameters_failure" field.

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

◆ ModelDeltaFieldNumber

const int OperationsResearch.MPModelRequest.ModelDeltaFieldNumber = 8
static

Field number for the "model_delta" field.

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

◆ ModelFieldNumber

const int OperationsResearch.MPModelRequest.ModelFieldNumber = 1
static

Field number for the "model" field.

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

◆ PopulateAdditionalSolutionsUpToFieldNumber

const int OperationsResearch.MPModelRequest.PopulateAdditionalSolutionsUpToFieldNumber = 11
static

Field number for the "populate_additional_solutions_up_to" field.

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

◆ SolverSpecificParametersFieldNumber

const int OperationsResearch.MPModelRequest.SolverSpecificParametersFieldNumber = 5
static

Field number for the "solver_specific_parameters" field.

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

◆ SolverTimeLimitSecondsFieldNumber

const int OperationsResearch.MPModelRequest.SolverTimeLimitSecondsFieldNumber = 3
static

Field number for the "solver_time_limit_seconds" field.

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

◆ SolverTypeFieldNumber

const int OperationsResearch.MPModelRequest.SolverTypeFieldNumber = 2
static

Field number for the "solver_type" field.

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

Property Documentation

◆ Descriptor

pbr.MessageDescriptor OperationsResearch.MPModelRequest.Descriptor
staticget

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

◆ EnableInternalSolverOutput

bool OperationsResearch.MPModelRequest.EnableInternalSolverOutput
getset

If this is set, then EnableOutput() will be set on the internal MPSolver that solves the model.

Warning
if you set this on a request to prod servers, it will be rejected and yield the RPC Application Error code MPSOLVER_SOLVER_TYPE_UNAVAILABLE.

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

◆ HasEnableInternalSolverOutput

bool OperationsResearch.MPModelRequest.HasEnableInternalSolverOutput
get

Gets whether the "enable_internal_solver_output" field is set.

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

◆ HasIgnoreSolverSpecificParametersFailure

bool OperationsResearch.MPModelRequest.HasIgnoreSolverSpecificParametersFailure
get

Gets whether the "ignore_solver_specific_parameters_failure" field is set.

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

◆ HasPopulateAdditionalSolutionsUpTo

bool OperationsResearch.MPModelRequest.HasPopulateAdditionalSolutionsUpTo
get

Gets whether the "populate_additional_solutions_up_to" field is set.

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

◆ HasSolverSpecificParameters

bool OperationsResearch.MPModelRequest.HasSolverSpecificParameters
get

Gets whether the "solver_specific_parameters" field is set.

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

◆ HasSolverTimeLimitSeconds

bool OperationsResearch.MPModelRequest.HasSolverTimeLimitSeconds
get

Gets whether the "solver_time_limit_seconds" field is set.

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

◆ HasSolverType

bool OperationsResearch.MPModelRequest.HasSolverType
get

Gets whether the "solver_type" field is set.

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

◆ IgnoreSolverSpecificParametersFailure

bool OperationsResearch.MPModelRequest.IgnoreSolverSpecificParametersFailure
getset

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

◆ Model

global.OperationsResearch.MPModelProto OperationsResearch.MPModelRequest.Model
getset

The model to be optimized by the server.

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

◆ ModelDelta

global.OperationsResearch.MPModelDeltaProto OperationsResearch.MPModelRequest.ModelDelta
getset

Advanced usage: model "delta". If used, "model" must be unset. See the definition of MPModelDeltaProto.

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

◆ Parser

pb.MessageParser<MPModelRequest> OperationsResearch.MPModelRequest.Parser
staticget

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

◆ PopulateAdditionalSolutionsUpTo

int OperationsResearch.MPModelRequest.PopulateAdditionalSolutionsUpTo
getset

Controls the recovery of additional solutions, if any, saved by the underlying solver back in the MPSolutionResponse.additional_solutions. The repeated field will be length min(populate_addition_solutions_up_to, #additional_solutions_available_in_underlying_solver) These additional solutions may have a worse objective than the main solution returned in the response.

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

◆ SolverSpecificParameters

string OperationsResearch.MPModelRequest.SolverSpecificParameters
getset

Advanced usage. Solver-specific parameters in the solver's own format, different for each solver. For example, if you use SCIP and you want to stop the solve earlier than the time limit if it reached a solution that is at most 1% away from the optimal, you can set this to "limits/gap=0.01".

Note however that there is no "security" mechanism in place so it is up to the client to make sure that the given options don't make the solve non thread safe or use up too much memory for instance. If the option format is not understood by the solver, the request will be rejected and yield an RPC Application error with code MPSOLVER_MODEL_INVALID_SOLVER_PARAMETERS, unless you have set ignore_solver_specific_parameters_failure=true (in which case they are simply ignored).

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

◆ SolverTimeLimitSeconds

double OperationsResearch.MPModelRequest.SolverTimeLimitSeconds
getset

Maximum time to be spent by the solver to solve 'model'. If the server is busy and the RPC's deadline_left is less than this, it will immediately give up and return an error, without even trying to solve.

The client can use this to have a guarantee on how much time the solver will spend on the problem (unless it finds and proves an optimal solution more quickly). If not specified, the time limit on the solver is the RPC's deadline_left.

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

◆ SolverType

global.OperationsResearch.MPModelRequest.Types.SolverType OperationsResearch.MPModelRequest.SolverType
getset

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

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