Java Reference
Java Reference
Detailed Description
Definition at line 6 of file MPModelRequestOrBuilder.java.
Public Member Functions | |
| boolean | hasModel () |
| com.google.ortools.linearsolver.MPModelProto | getModel () |
| com.google.ortools.linearsolver.MPModelProtoOrBuilder | getModelOrBuilder () |
| boolean | hasSolverType () |
optional .operations_research.MPModelRequest.SolverType solver_type = 2; More... | |
| com.google.ortools.linearsolver.MPModelRequest.SolverType | getSolverType () |
optional .operations_research.MPModelRequest.SolverType solver_type = 2; More... | |
| boolean | hasSolverTimeLimitSeconds () |
| double | getSolverTimeLimitSeconds () |
| boolean | hasEnableInternalSolverOutput () |
| boolean | getEnableInternalSolverOutput () |
| boolean | hasSolverSpecificParameters () |
| java.lang.String | getSolverSpecificParameters () |
| com.google.protobuf.ByteString | getSolverSpecificParametersBytes () |
| boolean | hasModelDelta () |
| com.google.ortools.linearsolver.MPModelDeltaProto | getModelDelta () |
| com.google.ortools.linearsolver.MPModelDeltaProtoOrBuilder | getModelDeltaOrBuilder () |
Member Function Documentation
◆ 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.
Implemented in MPModelRequest.Builder, and MPModelRequest.
◆ getModel()
| com.google.ortools.linearsolver.MPModelProto getModel | ( | ) |
The model to be optimized by the server.
optional .operations_research.MPModelProto model = 1;
- Returns
- The model.
Implemented in MPModelRequest.Builder, and MPModelRequest.
◆ getModelDelta()
| com.google.ortools.linearsolver.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.
Implemented in MPModelRequest.Builder, and MPModelRequest.
◆ getModelDeltaOrBuilder()
| com.google.ortools.linearsolver.MPModelDeltaProtoOrBuilder getModelDeltaOrBuilder | ( | ) |
Advanced usage: model "delta". If used, "model" must be unset. See the definition of MPModelDeltaProto.
optional .operations_research.MPModelDeltaProto model_delta = 8;
Implemented in MPModelRequest.Builder, and MPModelRequest.
◆ getModelOrBuilder()
| com.google.ortools.linearsolver.MPModelProtoOrBuilder getModelOrBuilder | ( | ) |
The model to be optimized by the server.
optional .operations_research.MPModelProto model = 1;
Implemented in MPModelRequest.Builder, and MPModelRequest.
◆ getSolverSpecificParameters()
| java.lang.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.
optional string solver_specific_parameters = 5;
- Returns
- The solverSpecificParameters.
Implemented in MPModelRequest.Builder, and MPModelRequest.
◆ 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.
optional string solver_specific_parameters = 5;
- Returns
- The bytes for solverSpecificParameters.
Implemented in MPModelRequest.Builder, and MPModelRequest.
◆ 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.
Implemented in MPModelRequest.Builder, and MPModelRequest.
◆ getSolverType()
| com.google.ortools.linearsolver.MPModelRequest.SolverType getSolverType | ( | ) |
optional .operations_research.MPModelRequest.SolverType solver_type = 2;
- Returns
- The solverType.
Implemented in MPModelRequest.Builder, and MPModelRequest.
◆ 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.
Implemented in MPModelRequest.Builder, and MPModelRequest.
◆ hasModel()
| boolean hasModel | ( | ) |
The model to be optimized by the server.
optional .operations_research.MPModelProto model = 1;
- Returns
- Whether the model field is set.
Implemented in MPModelRequest.Builder, and MPModelRequest.
◆ 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.
Implemented in MPModelRequest.Builder, and MPModelRequest.
◆ 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.
optional string solver_specific_parameters = 5;
- Returns
- Whether the solverSpecificParameters field is set.
Implemented in MPModelRequest.Builder, and MPModelRequest.
◆ 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.
Implemented in MPModelRequest.Builder, and MPModelRequest.
◆ hasSolverType()
| boolean hasSolverType | ( | ) |
optional .operations_research.MPModelRequest.SolverType solver_type = 2;
- Returns
- Whether the solverType field is set.
Implemented in MPModelRequest.Builder, and MPModelRequest.
The documentation for this interface was generated from the following file: