Interface MPModelRequestOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
MPModelRequest
,MPModelRequest.Builder
@Generated
public interface MPModelRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionboolean
If this is set, then EnableOutput() will be set on the internal MPSolver that solves the model.boolean
optional bool ignore_solver_specific_parameters_failure = 9 [default = false];
getModel()
The model to be optimized by the server.Advanced usage: model "delta".Advanced usage: model "delta".The model to be optimized by the server.int
Controls the recovery of additional solutions, if any, saved by the underlying solver back in the MPSolutionResponse.additional_solutions.Advanced usage.com.google.protobuf.ByteString
Advanced usage.double
Maximum time to be spent by the solver to solve 'model'.optional .operations_research.MPModelRequest.SolverType solver_type = 2 [default = GLOP_LINEAR_PROGRAMMING];
boolean
If this is set, then EnableOutput() will be set on the internal MPSolver that solves the model.boolean
optional bool ignore_solver_specific_parameters_failure = 9 [default = false];
boolean
hasModel()
The model to be optimized by the server.boolean
Advanced usage: model "delta".boolean
Controls the recovery of additional solutions, if any, saved by the underlying solver back in the MPSolutionResponse.additional_solutions.boolean
Advanced usage.boolean
Maximum time to be spent by the solver to solve 'model'.boolean
optional .operations_research.MPModelRequest.SolverType solver_type = 2 [default = GLOP_LINEAR_PROGRAMMING];
Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
hasModel
boolean hasModel()The model to be optimized by the server.
optional .operations_research.MPModelProto model = 1;
- Returns:
- Whether the model field is set.
-
getModel
MPModelProto getModel()The model to be optimized by the server.
optional .operations_research.MPModelProto model = 1;
- Returns:
- The model.
-
getModelOrBuilder
MPModelProtoOrBuilder getModelOrBuilder()The model to be optimized by the server.
optional .operations_research.MPModelProto model = 1;
-
hasSolverType
boolean hasSolverType()optional .operations_research.MPModelRequest.SolverType solver_type = 2 [default = GLOP_LINEAR_PROGRAMMING];
- Returns:
- Whether the solverType field is set.
-
getSolverType
MPModelRequest.SolverType getSolverType()optional .operations_research.MPModelRequest.SolverType solver_type = 2 [default = GLOP_LINEAR_PROGRAMMING];
- Returns:
- The solverType.
-
hasSolverTimeLimitSeconds
boolean hasSolverTimeLimitSeconds()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.
optional double solver_time_limit_seconds = 3;
- Returns:
- Whether the solverTimeLimitSeconds field is set.
-
getSolverTimeLimitSeconds
double getSolverTimeLimitSeconds()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.
optional double solver_time_limit_seconds = 3;
- Returns:
- The solverTimeLimitSeconds.
-
hasEnableInternalSolverOutput
boolean hasEnableInternalSolverOutput()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.
optional bool enable_internal_solver_output = 4 [default = false];
- Returns:
- Whether the enableInternalSolverOutput field is set.
-
getEnableInternalSolverOutput
boolean getEnableInternalSolverOutput()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.
optional bool enable_internal_solver_output = 4 [default = false];
- Returns:
- The enableInternalSolverOutput.
-
hasSolverSpecificParameters
boolean hasSolverSpecificParameters()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).
optional string solver_specific_parameters = 5;
- Returns:
- Whether the solverSpecificParameters field is set.
-
getSolverSpecificParameters
String getSolverSpecificParameters()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).
optional string solver_specific_parameters = 5;
- Returns:
- The solverSpecificParameters.
-
getSolverSpecificParametersBytes
com.google.protobuf.ByteString getSolverSpecificParametersBytes()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).
optional string solver_specific_parameters = 5;
- Returns:
- The bytes for solverSpecificParameters.
-
hasIgnoreSolverSpecificParametersFailure
boolean hasIgnoreSolverSpecificParametersFailure()optional bool ignore_solver_specific_parameters_failure = 9 [default = false];
- Returns:
- Whether the ignoreSolverSpecificParametersFailure field is set.
-
getIgnoreSolverSpecificParametersFailure
boolean getIgnoreSolverSpecificParametersFailure()optional bool ignore_solver_specific_parameters_failure = 9 [default = false];
- Returns:
- The ignoreSolverSpecificParametersFailure.
-
hasModelDelta
boolean hasModelDelta()Advanced usage: model "delta". If used, "model" must be unset. See the definition of MPModelDeltaProto.
optional .operations_research.MPModelDeltaProto model_delta = 8;
- Returns:
- Whether the modelDelta field is set.
-
getModelDelta
MPModelDeltaProto getModelDelta()Advanced usage: model "delta". If used, "model" must be unset. See the definition of MPModelDeltaProto.
optional .operations_research.MPModelDeltaProto model_delta = 8;
- Returns:
- The modelDelta.
-
getModelDeltaOrBuilder
MPModelDeltaProtoOrBuilder getModelDeltaOrBuilder()Advanced usage: model "delta". If used, "model" must be unset. See the definition of MPModelDeltaProto.
optional .operations_research.MPModelDeltaProto model_delta = 8;
-
hasPopulateAdditionalSolutionsUpTo
boolean hasPopulateAdditionalSolutionsUpTo()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.
optional int32 populate_additional_solutions_up_to = 11 [default = 0];
- Returns:
- Whether the populateAdditionalSolutionsUpTo field is set.
-
getPopulateAdditionalSolutionsUpTo
int getPopulateAdditionalSolutionsUpTo()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.
optional int32 populate_additional_solutions_up_to = 11 [default = 0];
- Returns:
- The populateAdditionalSolutionsUpTo.
-