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

Next id: 12. More...

Inheritance diagram for OperationsResearch.MPSolutionResponse:

Public Member Functions

 MPSolutionResponse ()
 
 MPSolutionResponse (MPSolutionResponse other)
 
MPSolutionResponse Clone ()
 
void ClearStatus ()
 Clears the value of the "status" field.
 
void ClearStatusStr ()
 Clears the value of the "status_str" field.
 
void ClearObjectiveValue ()
 Clears the value of the "objective_value" field.
 
void ClearBestObjectiveBound ()
 Clears the value of the "best_objective_bound" field.
 
void ClearSolverSpecificInfo ()
 Clears the value of the "solver_specific_info" field.
 
override bool Equals (object other)
 
bool Equals (MPSolutionResponse other)
 
override int GetHashCode ()
 
override string ToString ()
 
void WriteTo (pb::CodedOutputStream output)
 
int CalculateSize ()
 
void MergeFrom (MPSolutionResponse other)
 
void MergeFrom (pb::CodedInputStream input)
 

Static Public Attributes

const int StatusFieldNumber = 1
 Field number for the "status" field.
 
const int StatusStrFieldNumber = 7
 Field number for the "status_str" field.
 
const int ObjectiveValueFieldNumber = 2
 Field number for the "objective_value" field.
 
const int BestObjectiveBoundFieldNumber = 5
 Field number for the "best_objective_bound" field.
 
const int VariableValueFieldNumber = 3
 Field number for the "variable_value" field.
 
const int SolveInfoFieldNumber = 10
 Field number for the "solve_info" field.
 
const int SolverSpecificInfoFieldNumber = 11
 Field number for the "solver_specific_info" field.
 
const int DualValueFieldNumber = 4
 Field number for the "dual_value" field.
 
const int ReducedCostFieldNumber = 6
 Field number for the "reduced_cost" field.
 
const int AdditionalSolutionsFieldNumber = 8
 Field number for the "additional_solutions" field.
 

Properties

static pb::MessageParser< MPSolutionResponse > Parser [get]
 
static pbr::MessageDescriptor Descriptor [get]
 
global::OperationsResearch.MPSolverResponseStatus Status [get, set]
 Result of the optimization.
 
bool HasStatus [get]
 Gets whether the "status" field is set.
 
string StatusStr [get, set]
 Human-readable string giving more details about the status. For example, when the status is MPSOLVER_INVALID_MODE, this can hold a description of why the model is invalid. This isn't always filled: don't depend on its value or even its presence.
 
bool HasStatusStr [get]
 Gets whether the "status_str" field is set.
 
double ObjectiveValue [get, set]
 Objective value corresponding to the "variable_value" below, taking into account the source "objective_offset" and "objective_coefficient". This is set iff 'status' is OPTIMAL or FEASIBLE.
 
bool HasObjectiveValue [get]
 Gets whether the "objective_value" field is set.
 
double BestObjectiveBound [get, set]
 This field is only filled for MIP problems. For a minimization problem, this is a lower bound on the optimal objective value. For a maximization problem, it is an upper bound. It is only filled if the status is OPTIMAL or FEASIBLE. In the former case, best_objective_bound should be equal to objective_value (modulo numerical errors).
 
bool HasBestObjectiveBound [get]
 Gets whether the "best_objective_bound" field is set.
 
pbc::RepeatedField< double > VariableValue [get]
 Variable values in the same order as the MPModelProto::variable field. This is a dense representation. These are set iff 'status' is OPTIMAL or FEASIBLE.
 
global::OperationsResearch.MPSolveInfo SolveInfo [get, set]
 Contains extra information about the solve, populated if the underlying solver (and its interface) supports it. As of 2021/07/19 this is supported by SCIP and Gurobi proto solves.
 
pb::ByteString SolverSpecificInfo [get, set]
 Opaque solver-specific information. For the PDLP solver, this is a serialized pdlp::SolveLog proto.
 
bool HasSolverSpecificInfo [get]
 Gets whether the "solver_specific_info" field is set.
 
pbc::RepeatedField< double > DualValue [get]
 [Advanced usage.] Values of the dual variables values in the same order as the MPModelProto::constraint field. This is a dense representation. These are not set if the problem was solved with a MIP solver (even if it is actually a linear program). These are set iff 'status' is OPTIMAL or FEASIBLE.
 
pbc::RepeatedField< double > ReducedCost [get]
 [Advanced usage.] Values of the reduced cost of the variables in the same order as the MPModelProto::variable. This is a dense representation. These are not set if the problem was solved with a MIP solver (even if it is actually a linear program). These are set iff 'status' is OPTIMAL or FEASIBLE.
 
pbc::RepeatedField< global::OperationsResearch.MPSolution > AdditionalSolutions [get]
 [Advanced usage.] If MPModelRequest.populate_additional_solutions_up_to > 0, up to that number of additional solutions may be populated here, if available. These additional solutions are different than the main solution described by the above fields objective_value and variable_value.
 

Detailed Description

Next id: 12.

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

Constructor & Destructor Documentation

◆ MPSolutionResponse() [1/2]

OperationsResearch.MPSolutionResponse.MPSolutionResponse ( )
inline

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

◆ MPSolutionResponse() [2/2]

OperationsResearch.MPSolutionResponse.MPSolutionResponse ( MPSolutionResponse other)
inline

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

Member Function Documentation

◆ CalculateSize()

int OperationsResearch.MPSolutionResponse.CalculateSize ( )
inline

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

◆ ClearBestObjectiveBound()

void OperationsResearch.MPSolutionResponse.ClearBestObjectiveBound ( )
inline

Clears the value of the "best_objective_bound" field.

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

◆ ClearObjectiveValue()

void OperationsResearch.MPSolutionResponse.ClearObjectiveValue ( )
inline

Clears the value of the "objective_value" field.

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

◆ ClearSolverSpecificInfo()

void OperationsResearch.MPSolutionResponse.ClearSolverSpecificInfo ( )
inline

Clears the value of the "solver_specific_info" field.

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

◆ ClearStatus()

void OperationsResearch.MPSolutionResponse.ClearStatus ( )
inline

Clears the value of the "status" field.

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

◆ ClearStatusStr()

void OperationsResearch.MPSolutionResponse.ClearStatusStr ( )
inline

Clears the value of the "status_str" field.

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

◆ Clone()

MPSolutionResponse OperationsResearch.MPSolutionResponse.Clone ( )
inline

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

◆ Equals() [1/2]

bool OperationsResearch.MPSolutionResponse.Equals ( MPSolutionResponse other)
inline

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

◆ Equals() [2/2]

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

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

◆ GetHashCode()

override int OperationsResearch.MPSolutionResponse.GetHashCode ( )
inline

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

◆ MergeFrom() [1/2]

void OperationsResearch.MPSolutionResponse.MergeFrom ( MPSolutionResponse other)
inline

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

◆ MergeFrom() [2/2]

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

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

◆ ToString()

override string OperationsResearch.MPSolutionResponse.ToString ( )
inline

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

◆ WriteTo()

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

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

Member Data Documentation

◆ AdditionalSolutionsFieldNumber

const int OperationsResearch.MPSolutionResponse.AdditionalSolutionsFieldNumber = 8
static

Field number for the "additional_solutions" field.

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

◆ BestObjectiveBoundFieldNumber

const int OperationsResearch.MPSolutionResponse.BestObjectiveBoundFieldNumber = 5
static

Field number for the "best_objective_bound" field.

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

◆ DualValueFieldNumber

const int OperationsResearch.MPSolutionResponse.DualValueFieldNumber = 4
static

Field number for the "dual_value" field.

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

◆ ObjectiveValueFieldNumber

const int OperationsResearch.MPSolutionResponse.ObjectiveValueFieldNumber = 2
static

Field number for the "objective_value" field.

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

◆ ReducedCostFieldNumber

const int OperationsResearch.MPSolutionResponse.ReducedCostFieldNumber = 6
static

Field number for the "reduced_cost" field.

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

◆ SolveInfoFieldNumber

const int OperationsResearch.MPSolutionResponse.SolveInfoFieldNumber = 10
static

Field number for the "solve_info" field.

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

◆ SolverSpecificInfoFieldNumber

const int OperationsResearch.MPSolutionResponse.SolverSpecificInfoFieldNumber = 11
static

Field number for the "solver_specific_info" field.

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

◆ StatusFieldNumber

const int OperationsResearch.MPSolutionResponse.StatusFieldNumber = 1
static

Field number for the "status" field.

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

◆ StatusStrFieldNumber

const int OperationsResearch.MPSolutionResponse.StatusStrFieldNumber = 7
static

Field number for the "status_str" field.

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

◆ VariableValueFieldNumber

const int OperationsResearch.MPSolutionResponse.VariableValueFieldNumber = 3
static

Field number for the "variable_value" field.

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

Property Documentation

◆ AdditionalSolutions

pbc.RepeatedField<global.OperationsResearch.MPSolution> OperationsResearch.MPSolutionResponse.AdditionalSolutions
get

[Advanced usage.] If MPModelRequest.populate_additional_solutions_up_to > 0, up to that number of additional solutions may be populated here, if available. These additional solutions are different than the main solution described by the above fields objective_value and variable_value.

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

◆ BestObjectiveBound

double OperationsResearch.MPSolutionResponse.BestObjectiveBound
getset

This field is only filled for MIP problems. For a minimization problem, this is a lower bound on the optimal objective value. For a maximization problem, it is an upper bound. It is only filled if the status is OPTIMAL or FEASIBLE. In the former case, best_objective_bound should be equal to objective_value (modulo numerical errors).

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

◆ Descriptor

pbr.MessageDescriptor OperationsResearch.MPSolutionResponse.Descriptor
staticget

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

◆ DualValue

pbc.RepeatedField<double> OperationsResearch.MPSolutionResponse.DualValue
get

[Advanced usage.] Values of the dual variables values in the same order as the MPModelProto::constraint field. This is a dense representation. These are not set if the problem was solved with a MIP solver (even if it is actually a linear program). These are set iff 'status' is OPTIMAL or FEASIBLE.

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

◆ HasBestObjectiveBound

bool OperationsResearch.MPSolutionResponse.HasBestObjectiveBound
get

Gets whether the "best_objective_bound" field is set.

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

◆ HasObjectiveValue

bool OperationsResearch.MPSolutionResponse.HasObjectiveValue
get

Gets whether the "objective_value" field is set.

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

◆ HasSolverSpecificInfo

bool OperationsResearch.MPSolutionResponse.HasSolverSpecificInfo
get

Gets whether the "solver_specific_info" field is set.

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

◆ HasStatus

bool OperationsResearch.MPSolutionResponse.HasStatus
get

Gets whether the "status" field is set.

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

◆ HasStatusStr

bool OperationsResearch.MPSolutionResponse.HasStatusStr
get

Gets whether the "status_str" field is set.

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

◆ ObjectiveValue

double OperationsResearch.MPSolutionResponse.ObjectiveValue
getset

Objective value corresponding to the "variable_value" below, taking into account the source "objective_offset" and "objective_coefficient". This is set iff 'status' is OPTIMAL or FEASIBLE.

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

◆ Parser

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

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

◆ ReducedCost

pbc.RepeatedField<double> OperationsResearch.MPSolutionResponse.ReducedCost
get

[Advanced usage.] Values of the reduced cost of the variables in the same order as the MPModelProto::variable. This is a dense representation. These are not set if the problem was solved with a MIP solver (even if it is actually a linear program). These are set iff 'status' is OPTIMAL or FEASIBLE.

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

◆ SolveInfo

global.OperationsResearch.MPSolveInfo OperationsResearch.MPSolutionResponse.SolveInfo
getset

Contains extra information about the solve, populated if the underlying solver (and its interface) supports it. As of 2021/07/19 this is supported by SCIP and Gurobi proto solves.

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

◆ SolverSpecificInfo

pb.ByteString OperationsResearch.MPSolutionResponse.SolverSpecificInfo
getset

Opaque solver-specific information. For the PDLP solver, this is a serialized pdlp::SolveLog proto.

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

◆ Status

global.OperationsResearch.MPSolverResponseStatus OperationsResearch.MPSolutionResponse.Status
getset

Result of the optimization.

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

◆ StatusStr

string OperationsResearch.MPSolutionResponse.StatusStr
getset

Human-readable string giving more details about the status. For example, when the status is MPSOLVER_INVALID_MODE, this can hold a description of why the model is invalid. This isn't always filled: don't depend on its value or even its presence.

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

◆ VariableValue

pbc.RepeatedField<double> OperationsResearch.MPSolutionResponse.VariableValue
get

Variable values in the same order as the MPModelProto::variable field. This is a dense representation. These are set iff 'status' is OPTIMAL or FEASIBLE.

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

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