Google OR-Tools v9.12
a fast and portable software suite for combinatorial optimization
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Properties | List of all members
Google.OrTools.PDLP.SolveLog Class Referencesealed
Inheritance diagram for Google.OrTools.PDLP.SolveLog:

Public Member Functions

 SolveLog ()
 
 SolveLog (SolveLog other)
 
SolveLog Clone ()
 
void ClearInstanceName ()
 Clears the value of the "instance_name" field.
 
void ClearTerminationReason ()
 Clears the value of the "termination_reason" field.
 
void ClearTerminationString ()
 Clears the value of the "termination_string" field.
 
void ClearIterationCount ()
 Clears the value of the "iteration_count" field.
 
void ClearPreprocessingTimeSec ()
 Clears the value of the "preprocessing_time_sec" field.
 
void ClearSolveTimeSec ()
 Clears the value of the "solve_time_sec" field.
 
void ClearSolutionType ()
 Clears the value of the "solution_type" field.
 
override bool Equals (object other)
 
bool Equals (SolveLog other)
 
override int GetHashCode ()
 
override string ToString ()
 
void WriteTo (pb::CodedOutputStream output)
 
int CalculateSize ()
 
void MergeFrom (SolveLog other)
 
void MergeFrom (pb::CodedInputStream input)
 

Static Public Attributes

const int InstanceNameFieldNumber = 1
 Field number for the "instance_name" field.
 
const int ParamsFieldNumber = 14
 Field number for the "params" field.
 
const int TerminationReasonFieldNumber = 3
 Field number for the "termination_reason" field.
 
const int TerminationStringFieldNumber = 4
 Field number for the "termination_string" field.
 
const int IterationCountFieldNumber = 5
 Field number for the "iteration_count" field.
 
const int PreprocessingTimeSecFieldNumber = 13
 Field number for the "preprocessing_time_sec" field.
 
const int SolveTimeSecFieldNumber = 6
 Field number for the "solve_time_sec" field.
 
const int SolutionStatsFieldNumber = 8
 Field number for the "solution_stats" field.
 
const int SolutionTypeFieldNumber = 10
 Field number for the "solution_type" field.
 
const int IterationStatsFieldNumber = 7
 Field number for the "iteration_stats" field.
 
const int OriginalProblemStatsFieldNumber = 11
 Field number for the "original_problem_stats" field.
 
const int PreprocessedProblemStatsFieldNumber = 12
 Field number for the "preprocessed_problem_stats" field.
 
const int FeasibilityPolishingDetailsFieldNumber = 15
 Field number for the "feasibility_polishing_details" field.
 

Properties

static pb::MessageParser< SolveLog > Parser [get]
 
static pbr::MessageDescriptor Descriptor [get]
 
string InstanceName [get, set]
 The name of the optimization problem.
 
bool HasInstanceName [get]
 Gets whether the "instance_name" field is set.
 
global::Google.OrTools.PDLP.PrimalDualHybridGradientParams Params [get, set]
 If solved with PDLP, the parameters for this solve.
 
global::Google.OrTools.PDLP.TerminationReason TerminationReason [get, set]
 The reason that the solve terminated.
 
bool HasTerminationReason [get]
 Gets whether the "termination_reason" field is set.
 
string TerminationString [get, set]
 Optional extra information about the termination reason.
 
bool HasTerminationString [get]
 Gets whether the "termination_string" field is set.
 
int IterationCount [get, set]
 The total number of iterations during the solve. For a solve with use_feasibility_polishing this count includes the iterations from the feasibility polishing phases.
 
bool HasIterationCount [get]
 Gets whether the "iteration_count" field is set.
 
double PreprocessingTimeSec [get, set]
 Time for preprocessing (everything before iteration 0). This is also included in solve_time_sec.
 
bool HasPreprocessingTimeSec [get]
 Gets whether the "preprocessing_time_sec" field is set.
 
double SolveTimeSec [get, set]
 The runtime of the solve. Note: This should not be used for comparing methods unless care is taken to control for noise in runtime measurement. For a solve with use_feasibility_polishing this count includes the iterations from the feasibility polishing phases.
 
bool HasSolveTimeSec [get]
 Gets whether the "solve_time_sec" field is set.
 
global::Google.OrTools.PDLP.IterationStats SolutionStats [get, set]
 The IterationStats for the final iteration of the solver. For a solve with use_feasibility_polishing, the work metrics (iteration_count, cumulative_kkt_matrix_passes, etc.) will include the work done in the feasibility polishing phases.
 
global::Google.OrTools.PDLP.PointType SolutionType [get, set]
 The type of the output point that the solver returned. The quality of the point is reported in the corresponding entry of solution_stats.convergence_information and/or solution_stats.infeasibility_information. If termination_reason is TERMINATION_REASON_OPTIMAL, it's guaranteed that the corresponding entry of solution_stats.convergence_information satisfies the optimality conditions. Similarly, if termination_reason is either TERMINATION_REASON_PRIMAL_INFEASIBLE or TERMINATION_REASON_DUAL_INFEASIBLE the corresponding entry of solution_stats.infeasibility_information satisifes conditions for declaring primal or dual infeasibility, respectively. If termination_reason is anything else, e.g. TERMINATION_REASON_TIME_LIMIT or TERMINATION_REASON_PRIMAL_OR_DUAL_INFEASIBLE, the solution may not satisfy the optimality or infeasibility conditions.
 
bool HasSolutionType [get]
 Gets whether the "solution_type" field is set.
 
pbc::RepeatedField< global::Google.OrTools.PDLP.IterationStats > IterationStats [get]
 A history of iteration stats for the solve. The iteration_number fields should be in increasing order. The frequency at which these stats should be recorded is not specified. This field is "more" optional than the others because it often significantly increases the size of the message, and because the information may not be available for third-party solvers. For a solve with use_feasibility_polishing, these iteration stats will only reflect the work done in the main iterations (not the feasibility polishing phases).
 
global::Google.OrTools.PDLP.QuadraticProgramStats OriginalProblemStats [get, set]
 Statistics of the original problem.
 
global::Google.OrTools.PDLP.QuadraticProgramStats PreprocessedProblemStats [get, set]
 Statistics of the problem after preprocessing.
 
pbc::RepeatedField< global::Google.OrTools.PDLP.FeasibilityPolishingDetails > FeasibilityPolishingDetails [get]
 If solving with use_feasibility_polishing, details about the primal and dual feasibility polishing phases.
 

Detailed Description

Definition at line 5336 of file SolveLog.pb.cs.

Constructor & Destructor Documentation

◆ SolveLog() [1/2]

Google.OrTools.PDLP.SolveLog.SolveLog ( )
inline

Definition at line 5362 of file SolveLog.pb.cs.

◆ SolveLog() [2/2]

Google.OrTools.PDLP.SolveLog.SolveLog ( SolveLog other)
inline

Definition at line 5370 of file SolveLog.pb.cs.

Member Function Documentation

◆ CalculateSize()

int Google.OrTools.PDLP.SolveLog.CalculateSize ( )
inline

Definition at line 5899 of file SolveLog.pb.cs.

◆ ClearInstanceName()

void Google.OrTools.PDLP.SolveLog.ClearInstanceName ( )
inline

Clears the value of the "instance_name" field.

Definition at line 5419 of file SolveLog.pb.cs.

◆ ClearIterationCount()

void Google.OrTools.PDLP.SolveLog.ClearIterationCount ( )
inline

Clears the value of the "iteration_count" field.

Definition at line 5525 of file SolveLog.pb.cs.

◆ ClearPreprocessingTimeSec()

void Google.OrTools.PDLP.SolveLog.ClearPreprocessingTimeSec ( )
inline

Clears the value of the "preprocessing_time_sec" field.

Definition at line 5556 of file SolveLog.pb.cs.

◆ ClearSolutionType()

void Google.OrTools.PDLP.SolveLog.ClearSolutionType ( )
inline

Clears the value of the "solution_type" field.

Definition at line 5653 of file SolveLog.pb.cs.

◆ ClearSolveTimeSec()

void Google.OrTools.PDLP.SolveLog.ClearSolveTimeSec ( )
inline

Clears the value of the "solve_time_sec" field.

Definition at line 5589 of file SolveLog.pb.cs.

◆ ClearTerminationReason()

void Google.OrTools.PDLP.SolveLog.ClearTerminationReason ( )
inline

Clears the value of the "termination_reason" field.

Definition at line 5464 of file SolveLog.pb.cs.

◆ ClearTerminationString()

void Google.OrTools.PDLP.SolveLog.ClearTerminationString ( )
inline

Clears the value of the "termination_string" field.

Definition at line 5493 of file SolveLog.pb.cs.

◆ Clone()

SolveLog Google.OrTools.PDLP.SolveLog.Clone ( )
inline

Definition at line 5390 of file SolveLog.pb.cs.

◆ Equals() [1/2]

override bool Google.OrTools.PDLP.SolveLog.Equals ( object other)
inline

Definition at line 5725 of file SolveLog.pb.cs.

◆ Equals() [2/2]

bool Google.OrTools.PDLP.SolveLog.Equals ( SolveLog other)
inline

Definition at line 5731 of file SolveLog.pb.cs.

◆ GetHashCode()

override int Google.OrTools.PDLP.SolveLog.GetHashCode ( )
inline

Definition at line 5756 of file SolveLog.pb.cs.

◆ MergeFrom() [1/2]

void Google.OrTools.PDLP.SolveLog.MergeFrom ( pb.CodedInputStream input)
inline

Definition at line 6000 of file SolveLog.pb.cs.

◆ MergeFrom() [2/2]

void Google.OrTools.PDLP.SolveLog.MergeFrom ( SolveLog other)
inline

Definition at line 5944 of file SolveLog.pb.cs.

◆ ToString()

override string Google.OrTools.PDLP.SolveLog.ToString ( )
inline

Definition at line 5779 of file SolveLog.pb.cs.

◆ WriteTo()

void Google.OrTools.PDLP.SolveLog.WriteTo ( pb.CodedOutputStream output)
inline

Definition at line 5785 of file SolveLog.pb.cs.

Member Data Documentation

◆ FeasibilityPolishingDetailsFieldNumber

const int Google.OrTools.PDLP.SolveLog.FeasibilityPolishingDetailsFieldNumber = 15
static

Field number for the "feasibility_polishing_details" field.

Definition at line 5709 of file SolveLog.pb.cs.

◆ InstanceNameFieldNumber

const int Google.OrTools.PDLP.SolveLog.InstanceNameFieldNumber = 1
static

Field number for the "instance_name" field.

Definition at line 5395 of file SolveLog.pb.cs.

◆ IterationCountFieldNumber

const int Google.OrTools.PDLP.SolveLog.IterationCountFieldNumber = 5
static

Field number for the "iteration_count" field.

Definition at line 5498 of file SolveLog.pb.cs.

◆ IterationStatsFieldNumber

const int Google.OrTools.PDLP.SolveLog.IterationStatsFieldNumber = 7
static

Field number for the "iteration_stats" field.

Definition at line 5658 of file SolveLog.pb.cs.

◆ OriginalProblemStatsFieldNumber

const int Google.OrTools.PDLP.SolveLog.OriginalProblemStatsFieldNumber = 11
static

Field number for the "original_problem_stats" field.

Definition at line 5679 of file SolveLog.pb.cs.

◆ ParamsFieldNumber

const int Google.OrTools.PDLP.SolveLog.ParamsFieldNumber = 14
static

Field number for the "params" field.

Definition at line 5424 of file SolveLog.pb.cs.

◆ PreprocessedProblemStatsFieldNumber

const int Google.OrTools.PDLP.SolveLog.PreprocessedProblemStatsFieldNumber = 12
static

Field number for the "preprocessed_problem_stats" field.

Definition at line 5694 of file SolveLog.pb.cs.

◆ PreprocessingTimeSecFieldNumber

const int Google.OrTools.PDLP.SolveLog.PreprocessingTimeSecFieldNumber = 13
static

Field number for the "preprocessing_time_sec" field.

Definition at line 5530 of file SolveLog.pb.cs.

◆ SolutionStatsFieldNumber

const int Google.OrTools.PDLP.SolveLog.SolutionStatsFieldNumber = 8
static

Field number for the "solution_stats" field.

Definition at line 5594 of file SolveLog.pb.cs.

◆ SolutionTypeFieldNumber

const int Google.OrTools.PDLP.SolveLog.SolutionTypeFieldNumber = 10
static

Field number for the "solution_type" field.

Definition at line 5615 of file SolveLog.pb.cs.

◆ SolveTimeSecFieldNumber

const int Google.OrTools.PDLP.SolveLog.SolveTimeSecFieldNumber = 6
static

Field number for the "solve_time_sec" field.

Definition at line 5561 of file SolveLog.pb.cs.

◆ TerminationReasonFieldNumber

const int Google.OrTools.PDLP.SolveLog.TerminationReasonFieldNumber = 3
static

Field number for the "termination_reason" field.

Definition at line 5439 of file SolveLog.pb.cs.

◆ TerminationStringFieldNumber

const int Google.OrTools.PDLP.SolveLog.TerminationStringFieldNumber = 4
static

Field number for the "termination_string" field.

Definition at line 5469 of file SolveLog.pb.cs.

Property Documentation

◆ Descriptor

pbr.MessageDescriptor Google.OrTools.PDLP.SolveLog.Descriptor
staticget

Definition at line 5350 of file SolveLog.pb.cs.

◆ FeasibilityPolishingDetails

pbc.RepeatedField<global.Google.OrTools.PDLP.FeasibilityPolishingDetails> Google.OrTools.PDLP.SolveLog.FeasibilityPolishingDetails
get

If solving with use_feasibility_polishing, details about the primal and dual feasibility polishing phases.

Definition at line 5719 of file SolveLog.pb.cs.

◆ HasInstanceName

bool Google.OrTools.PDLP.SolveLog.HasInstanceName
get

Gets whether the "instance_name" field is set.

Definition at line 5413 of file SolveLog.pb.cs.

◆ HasIterationCount

bool Google.OrTools.PDLP.SolveLog.HasIterationCount
get

Gets whether the "iteration_count" field is set.

Definition at line 5519 of file SolveLog.pb.cs.

◆ HasPreprocessingTimeSec

bool Google.OrTools.PDLP.SolveLog.HasPreprocessingTimeSec
get

Gets whether the "preprocessing_time_sec" field is set.

Definition at line 5550 of file SolveLog.pb.cs.

◆ HasSolutionType

bool Google.OrTools.PDLP.SolveLog.HasSolutionType
get

Gets whether the "solution_type" field is set.

Definition at line 5647 of file SolveLog.pb.cs.

◆ HasSolveTimeSec

bool Google.OrTools.PDLP.SolveLog.HasSolveTimeSec
get

Gets whether the "solve_time_sec" field is set.

Definition at line 5583 of file SolveLog.pb.cs.

◆ HasTerminationReason

bool Google.OrTools.PDLP.SolveLog.HasTerminationReason
get

Gets whether the "termination_reason" field is set.

Definition at line 5458 of file SolveLog.pb.cs.

◆ HasTerminationString

bool Google.OrTools.PDLP.SolveLog.HasTerminationString
get

Gets whether the "termination_string" field is set.

Definition at line 5487 of file SolveLog.pb.cs.

◆ InstanceName

string Google.OrTools.PDLP.SolveLog.InstanceName
getset

The name of the optimization problem.

Definition at line 5404 of file SolveLog.pb.cs.

◆ IterationCount

int Google.OrTools.PDLP.SolveLog.IterationCount
getset

The total number of iterations during the solve. For a solve with use_feasibility_polishing this count includes the iterations from the feasibility polishing phases.

Definition at line 5509 of file SolveLog.pb.cs.

◆ IterationStats

pbc.RepeatedField<global.Google.OrTools.PDLP.IterationStats> Google.OrTools.PDLP.SolveLog.IterationStats
get

A history of iteration stats for the solve. The iteration_number fields should be in increasing order. The frequency at which these stats should be recorded is not specified. This field is "more" optional than the others because it often significantly increases the size of the message, and because the information may not be available for third-party solvers. For a solve with use_feasibility_polishing, these iteration stats will only reflect the work done in the main iterations (not the feasibility polishing phases).

Definition at line 5674 of file SolveLog.pb.cs.

◆ OriginalProblemStats

global.Google.OrTools.PDLP.QuadraticProgramStats Google.OrTools.PDLP.SolveLog.OriginalProblemStats
getset

Statistics of the original problem.

Definition at line 5686 of file SolveLog.pb.cs.

◆ Params

global.Google.OrTools.PDLP.PrimalDualHybridGradientParams Google.OrTools.PDLP.SolveLog.Params
getset

If solved with PDLP, the parameters for this solve.

Definition at line 5431 of file SolveLog.pb.cs.

◆ Parser

pb.MessageParser<SolveLog> Google.OrTools.PDLP.SolveLog.Parser
staticget

Definition at line 5346 of file SolveLog.pb.cs.

◆ PreprocessedProblemStats

global.Google.OrTools.PDLP.QuadraticProgramStats Google.OrTools.PDLP.SolveLog.PreprocessedProblemStats
getset

Statistics of the problem after preprocessing.

Definition at line 5701 of file SolveLog.pb.cs.

◆ PreprocessingTimeSec

double Google.OrTools.PDLP.SolveLog.PreprocessingTimeSec
getset

Time for preprocessing (everything before iteration 0). This is also included in solve_time_sec.

Definition at line 5540 of file SolveLog.pb.cs.

◆ SolutionStats

global.Google.OrTools.PDLP.IterationStats Google.OrTools.PDLP.SolveLog.SolutionStats
getset

The IterationStats for the final iteration of the solver. For a solve with use_feasibility_polishing, the work metrics (iteration_count, cumulative_kkt_matrix_passes, etc.) will include the work done in the feasibility polishing phases.

Note
Regardless of preprocessing (i.e. scaling or presolve) the optimality or infeasibility information is evaluated with respect to the original problem.

Definition at line 5607 of file SolveLog.pb.cs.

◆ SolutionType

global.Google.OrTools.PDLP.PointType Google.OrTools.PDLP.SolveLog.SolutionType
getset

The type of the output point that the solver returned. The quality of the point is reported in the corresponding entry of solution_stats.convergence_information and/or solution_stats.infeasibility_information. If termination_reason is TERMINATION_REASON_OPTIMAL, it's guaranteed that the corresponding entry of solution_stats.convergence_information satisfies the optimality conditions. Similarly, if termination_reason is either TERMINATION_REASON_PRIMAL_INFEASIBLE or TERMINATION_REASON_DUAL_INFEASIBLE the corresponding entry of solution_stats.infeasibility_information satisifes conditions for declaring primal or dual infeasibility, respectively. If termination_reason is anything else, e.g. TERMINATION_REASON_TIME_LIMIT or TERMINATION_REASON_PRIMAL_OR_DUAL_INFEASIBLE, the solution may not satisfy the optimality or infeasibility conditions.

Definition at line 5637 of file SolveLog.pb.cs.

◆ SolveTimeSec

double Google.OrTools.PDLP.SolveLog.SolveTimeSec
getset

The runtime of the solve. Note: This should not be used for comparing methods unless care is taken to control for noise in runtime measurement. For a solve with use_feasibility_polishing this count includes the iterations from the feasibility polishing phases.

Definition at line 5573 of file SolveLog.pb.cs.

◆ TerminationReason

global.Google.OrTools.PDLP.TerminationReason Google.OrTools.PDLP.SolveLog.TerminationReason
getset

The reason that the solve terminated.

Definition at line 5448 of file SolveLog.pb.cs.

◆ TerminationString

string Google.OrTools.PDLP.SolveLog.TerminationString
getset

Optional extra information about the termination reason.

Definition at line 5478 of file SolveLog.pb.cs.

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