com.google.ortools.linearsolver.MPModelRequestOrBuilder Interface Reference

Inheritance diagram for com.google.ortools.linearsolver.MPModelRequestOrBuilder:

Public Member Functions
boolean	hasModel ()
com.google.ortools.linearsolver.MPModelProto	getModel ()
com.google.ortools.linearsolver.MPModelProtoOrBuilder	getModelOrBuilder ()
boolean	hasSolverType ()
com.google.ortools.linearsolver.MPModelRequest.SolverType	getSolverType ()
boolean	hasSolverTimeLimitSeconds ()
double	getSolverTimeLimitSeconds ()
boolean	hasEnableInternalSolverOutput ()
boolean	getEnableInternalSolverOutput ()
boolean	hasSolverSpecificParameters ()
java.lang.String	getSolverSpecificParameters ()
com.google.protobuf.ByteString	getSolverSpecificParametersBytes ()
boolean	hasIgnoreSolverSpecificParametersFailure ()
boolean	getIgnoreSolverSpecificParametersFailure ()
boolean	hasModelDelta ()
com.google.ortools.linearsolver.MPModelDeltaProto	getModelDelta ()
com.google.ortools.linearsolver.MPModelDeltaProtoOrBuilder	getModelDeltaOrBuilder ()
boolean	hasPopulateAdditionalSolutionsUpTo ()
int	getPopulateAdditionalSolutionsUpTo ()

Detailed Description

Definition at line 7 of file MPModelRequestOrBuilder.java.

Member Function Documentation

getEnableInternalSolverOutput()

boolean com.google.ortools.linearsolver.MPModelRequestOrBuilder.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 com.google.ortools.linearsolver.MPModelRequest.Builder, and com.google.ortools.linearsolver.MPModelRequest.

getIgnoreSolverSpecificParametersFailure()

boolean com.google.ortools.linearsolver.MPModelRequestOrBuilder.getIgnoreSolverSpecificParametersFailure

(

)

optional bool ignore_solver_specific_parameters_failure = 9 [default = false];

Returns

The ignoreSolverSpecificParametersFailure.

Implemented in com.google.ortools.linearsolver.MPModelRequest.Builder, and com.google.ortools.linearsolver.MPModelRequest.

getModel()

com.google.ortools.linearsolver.MPModelProto com.google.ortools.linearsolver.MPModelRequestOrBuilder.getModel

(

)

The model to be optimized by the server.

optional .operations_research.MPModelProto model = 1;

Returns

The model.

Implemented in com.google.ortools.linearsolver.MPModelRequest.Builder, and com.google.ortools.linearsolver.MPModelRequest.

getModelDelta()

com.google.ortools.linearsolver.MPModelDeltaProto com.google.ortools.linearsolver.MPModelRequestOrBuilder.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 com.google.ortools.linearsolver.MPModelRequest.Builder, and com.google.ortools.linearsolver.MPModelRequest.

getModelDeltaOrBuilder()

com.google.ortools.linearsolver.MPModelDeltaProtoOrBuilder com.google.ortools.linearsolver.MPModelRequestOrBuilder.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 com.google.ortools.linearsolver.MPModelRequest.Builder, and com.google.ortools.linearsolver.MPModelRequest.

getModelOrBuilder()

com.google.ortools.linearsolver.MPModelProtoOrBuilder com.google.ortools.linearsolver.MPModelRequestOrBuilder.getModelOrBuilder

(

)

The model to be optimized by the server.

optional .operations_research.MPModelProto model = 1;

Implemented in com.google.ortools.linearsolver.MPModelRequest.Builder, and com.google.ortools.linearsolver.MPModelRequest.

getPopulateAdditionalSolutionsUpTo()

int com.google.ortools.linearsolver.MPModelRequestOrBuilder.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.

Implemented in com.google.ortools.linearsolver.MPModelRequest.Builder, and com.google.ortools.linearsolver.MPModelRequest.

getSolverSpecificParameters()

java.lang.String com.google.ortools.linearsolver.MPModelRequestOrBuilder.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.

Implemented in com.google.ortools.linearsolver.MPModelRequest.Builder, and com.google.ortools.linearsolver.MPModelRequest.

getSolverSpecificParametersBytes()

com.google.protobuf.ByteString com.google.ortools.linearsolver.MPModelRequestOrBuilder.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.

Implemented in com.google.ortools.linearsolver.MPModelRequest.Builder, and com.google.ortools.linearsolver.MPModelRequest.

getSolverTimeLimitSeconds()

double com.google.ortools.linearsolver.MPModelRequestOrBuilder.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 com.google.ortools.linearsolver.MPModelRequest.Builder, and com.google.ortools.linearsolver.MPModelRequest.

getSolverType()

com.google.ortools.linearsolver.MPModelRequest.SolverType com.google.ortools.linearsolver.MPModelRequestOrBuilder.getSolverType

(

)

optional .operations_research.MPModelRequest.SolverType solver_type = 2 [default = GLOP_LINEAR_PROGRAMMING];

Returns

The solverType.

Implemented in com.google.ortools.linearsolver.MPModelRequest.Builder, and com.google.ortools.linearsolver.MPModelRequest.

hasEnableInternalSolverOutput()

boolean com.google.ortools.linearsolver.MPModelRequestOrBuilder.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 com.google.ortools.linearsolver.MPModelRequest.Builder, and com.google.ortools.linearsolver.MPModelRequest.

hasIgnoreSolverSpecificParametersFailure()

boolean com.google.ortools.linearsolver.MPModelRequestOrBuilder.hasIgnoreSolverSpecificParametersFailure

(

)

optional bool ignore_solver_specific_parameters_failure = 9 [default = false];

Returns

Whether the ignoreSolverSpecificParametersFailure field is set.

Implemented in com.google.ortools.linearsolver.MPModelRequest.Builder, and com.google.ortools.linearsolver.MPModelRequest.

hasModel()

boolean com.google.ortools.linearsolver.MPModelRequestOrBuilder.hasModel

(

)

The model to be optimized by the server.

optional .operations_research.MPModelProto model = 1;

Returns

Whether the model field is set.

Implemented in com.google.ortools.linearsolver.MPModelRequest.Builder, and com.google.ortools.linearsolver.MPModelRequest.

hasModelDelta()

boolean com.google.ortools.linearsolver.MPModelRequestOrBuilder.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 com.google.ortools.linearsolver.MPModelRequest.Builder, and com.google.ortools.linearsolver.MPModelRequest.

hasPopulateAdditionalSolutionsUpTo()

boolean com.google.ortools.linearsolver.MPModelRequestOrBuilder.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.

Implemented in com.google.ortools.linearsolver.MPModelRequest.Builder, and com.google.ortools.linearsolver.MPModelRequest.

hasSolverSpecificParameters()

boolean com.google.ortools.linearsolver.MPModelRequestOrBuilder.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.

Implemented in com.google.ortools.linearsolver.MPModelRequest.Builder, and com.google.ortools.linearsolver.MPModelRequest.

hasSolverTimeLimitSeconds()

boolean com.google.ortools.linearsolver.MPModelRequestOrBuilder.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 com.google.ortools.linearsolver.MPModelRequest.Builder, and com.google.ortools.linearsolver.MPModelRequest.

hasSolverType()

boolean com.google.ortools.linearsolver.MPModelRequestOrBuilder.hasSolverType

(

)

optional .operations_research.MPModelRequest.SolverType solver_type = 2 [default = GLOP_LINEAR_PROGRAMMING];

Returns

Whether the solverType field is set.

Implemented in com.google.ortools.linearsolver.MPModelRequest.Builder, and com.google.ortools.linearsolver.MPModelRequest.

---

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

• build/java/ortools-java/src/main/java/com/google/ortools/linearsolver/MPModelRequestOrBuilder.java