Google OR-Tools v9.14
a fast and portable software suite for combinatorial optimization
Loading...
Searching...
No Matches
com.google.ortools.pdlp.SolveLog Class Reference

Detailed Description

Protobuf type operations_research.pdlp.SolveLog

Definition at line 12 of file SolveLog.java.

Inheritance diagram for com.google.ortools.pdlp.SolveLog:
com.google.ortools.pdlp.SolveLogOrBuilder

Classes

class  Builder

Public Member Functions

boolean hasInstanceName ()
java.lang.String getInstanceName ()
com.google.protobuf.ByteString getInstanceNameBytes ()
boolean hasParams ()
com.google.ortools.pdlp.PrimalDualHybridGradientParams getParams ()
com.google.ortools.pdlp.PrimalDualHybridGradientParamsOrBuilder getParamsOrBuilder ()
boolean hasTerminationReason ()
com.google.ortools.pdlp.TerminationReason getTerminationReason ()
boolean hasTerminationString ()
java.lang.String getTerminationString ()
com.google.protobuf.ByteString getTerminationStringBytes ()
boolean hasIterationCount ()
int getIterationCount ()
boolean hasPreprocessingTimeSec ()
double getPreprocessingTimeSec ()
boolean hasSolveTimeSec ()
double getSolveTimeSec ()
boolean hasSolutionStats ()
com.google.ortools.pdlp.IterationStats getSolutionStats ()
com.google.ortools.pdlp.IterationStatsOrBuilder getSolutionStatsOrBuilder ()
boolean hasSolutionType ()
com.google.ortools.pdlp.PointType getSolutionType ()
java.util.List< com.google.ortools.pdlp.IterationStatsgetIterationStatsList ()
java.util.List<? extends com.google.ortools.pdlp.IterationStatsOrBuildergetIterationStatsOrBuilderList ()
int getIterationStatsCount ()
com.google.ortools.pdlp.IterationStats getIterationStats (int index)
com.google.ortools.pdlp.IterationStatsOrBuilder getIterationStatsOrBuilder (int index)
boolean hasOriginalProblemStats ()
com.google.ortools.pdlp.QuadraticProgramStats getOriginalProblemStats ()
com.google.ortools.pdlp.QuadraticProgramStatsOrBuilder getOriginalProblemStatsOrBuilder ()
boolean hasPreprocessedProblemStats ()
com.google.ortools.pdlp.QuadraticProgramStats getPreprocessedProblemStats ()
com.google.ortools.pdlp.QuadraticProgramStatsOrBuilder getPreprocessedProblemStatsOrBuilder ()
java.util.List< com.google.ortools.pdlp.FeasibilityPolishingDetailsgetFeasibilityPolishingDetailsList ()
java.util.List<? extends com.google.ortools.pdlp.FeasibilityPolishingDetailsOrBuildergetFeasibilityPolishingDetailsOrBuilderList ()
int getFeasibilityPolishingDetailsCount ()
com.google.ortools.pdlp.FeasibilityPolishingDetails getFeasibilityPolishingDetails (int index)
com.google.ortools.pdlp.FeasibilityPolishingDetailsOrBuilder getFeasibilityPolishingDetailsOrBuilder (int index)
final boolean isInitialized ()
void writeTo (com.google.protobuf.CodedOutputStream output) throws java.io.IOException
int getSerializedSize ()
boolean equals (final java.lang.Object obj)
int hashCode ()
Builder newBuilderForType ()
Builder toBuilder ()
com.google.protobuf.Parser< SolveLoggetParserForType ()
com.google.ortools.pdlp.SolveLog getDefaultInstanceForType ()

Static Public Member Functions

static final com.google.protobuf.Descriptors.Descriptor getDescriptor ()
static com.google.ortools.pdlp.SolveLog parseFrom (java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.pdlp.SolveLog parseFrom (java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.pdlp.SolveLog parseFrom (com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.pdlp.SolveLog parseFrom (com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.pdlp.SolveLog parseFrom (byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.pdlp.SolveLog parseFrom (byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.pdlp.SolveLog parseFrom (java.io.InputStream input) throws java.io.IOException
static com.google.ortools.pdlp.SolveLog parseFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
static com.google.ortools.pdlp.SolveLog parseDelimitedFrom (java.io.InputStream input) throws java.io.IOException
static com.google.ortools.pdlp.SolveLog parseDelimitedFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
static com.google.ortools.pdlp.SolveLog parseFrom (com.google.protobuf.CodedInputStream input) throws java.io.IOException
static com.google.ortools.pdlp.SolveLog parseFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
static Builder newBuilder ()
static Builder newBuilder (com.google.ortools.pdlp.SolveLog prototype)
static com.google.ortools.pdlp.SolveLog getDefaultInstance ()
static com.google.protobuf.Parser< SolveLogparser ()

Static Public Attributes

static final int INSTANCE_NAME_FIELD_NUMBER = 1
static final int PARAMS_FIELD_NUMBER = 14
static final int TERMINATION_REASON_FIELD_NUMBER = 3
static final int TERMINATION_STRING_FIELD_NUMBER = 4
static final int ITERATION_COUNT_FIELD_NUMBER = 5
static final int PREPROCESSING_TIME_SEC_FIELD_NUMBER = 13
static final int SOLVE_TIME_SEC_FIELD_NUMBER = 6
static final int SOLUTION_STATS_FIELD_NUMBER = 8
static final int SOLUTION_TYPE_FIELD_NUMBER = 10
static final int ITERATION_STATS_FIELD_NUMBER = 7
static final int ORIGINAL_PROBLEM_STATS_FIELD_NUMBER = 11
static final int PREPROCESSED_PROBLEM_STATS_FIELD_NUMBER = 12
static final int FEASIBILITY_POLISHING_DETAILS_FIELD_NUMBER = 15

Protected Member Functions

com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable ()
Builder newBuilderForType (com.google.protobuf.GeneratedMessage.BuilderParent parent)

Member Function Documentation

◆ equals()

boolean com.google.ortools.pdlp.SolveLog.equals ( final java.lang.Object obj)

Definition at line 796 of file SolveLog.java.

◆ getDefaultInstance()

com.google.ortools.pdlp.SolveLog com.google.ortools.pdlp.SolveLog.getDefaultInstance ( )
static

Definition at line 3493 of file SolveLog.java.

◆ getDefaultInstanceForType()

com.google.ortools.pdlp.SolveLog com.google.ortools.pdlp.SolveLog.getDefaultInstanceForType ( )

Definition at line 3529 of file SolveLog.java.

◆ getDescriptor()

final com.google.protobuf.Descriptors.Descriptor com.google.ortools.pdlp.SolveLog.getDescriptor ( )
static

Definition at line 40 of file SolveLog.java.

◆ getFeasibilityPolishingDetails()

com.google.ortools.pdlp.FeasibilityPolishingDetails com.google.ortools.pdlp.SolveLog.getFeasibilityPolishingDetails ( int index)
If solving with `use_feasibility_polishing`, details about the primal and
dual feasibility polishing phases.

repeated .operations_research.pdlp.FeasibilityPolishingDetails feasibility_polishing_details = 15;

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 661 of file SolveLog.java.

◆ getFeasibilityPolishingDetailsCount()

int com.google.ortools.pdlp.SolveLog.getFeasibilityPolishingDetailsCount ( )
If solving with `use_feasibility_polishing`, details about the primal and
dual feasibility polishing phases.

repeated .operations_research.pdlp.FeasibilityPolishingDetails feasibility_polishing_details = 15;

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 649 of file SolveLog.java.

◆ getFeasibilityPolishingDetailsList()

java.util.List< com.google.ortools.pdlp.FeasibilityPolishingDetails > com.google.ortools.pdlp.SolveLog.getFeasibilityPolishingDetailsList ( )
If solving with `use_feasibility_polishing`, details about the primal and
dual feasibility polishing phases.

repeated .operations_research.pdlp.FeasibilityPolishingDetails feasibility_polishing_details = 15;

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 624 of file SolveLog.java.

◆ getFeasibilityPolishingDetailsOrBuilder()

com.google.ortools.pdlp.FeasibilityPolishingDetailsOrBuilder com.google.ortools.pdlp.SolveLog.getFeasibilityPolishingDetailsOrBuilder ( int index)
If solving with `use_feasibility_polishing`, details about the primal and
dual feasibility polishing phases.

repeated .operations_research.pdlp.FeasibilityPolishingDetails feasibility_polishing_details = 15;

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 673 of file SolveLog.java.

◆ getFeasibilityPolishingDetailsOrBuilderList()

java.util.List<? extends com.google.ortools.pdlp.FeasibilityPolishingDetailsOrBuilder > com.google.ortools.pdlp.SolveLog.getFeasibilityPolishingDetailsOrBuilderList ( )
If solving with `use_feasibility_polishing`, details about the primal and
dual feasibility polishing phases.

repeated .operations_research.pdlp.FeasibilityPolishingDetails feasibility_polishing_details = 15;

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 637 of file SolveLog.java.

◆ getInstanceName()

java.lang.String com.google.ortools.pdlp.SolveLog.getInstanceName ( )
The name of the optimization problem.

optional string instance_name = 1;

Returns
The instanceName.

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 77 of file SolveLog.java.

◆ getInstanceNameBytes()

com.google.protobuf.ByteString com.google.ortools.pdlp.SolveLog.getInstanceNameBytes ( )
The name of the optimization problem.

optional string instance_name = 1;

Returns
The bytes for instanceName.

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 101 of file SolveLog.java.

◆ getIterationCount()

int com.google.ortools.pdlp.SolveLog.getIterationCount ( )
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.

optional int32 iteration_count = 5;

Returns
The iterationCount.

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 266 of file SolveLog.java.

◆ getIterationStats()

com.google.ortools.pdlp.IterationStats com.google.ortools.pdlp.SolveLog.getIterationStats ( int index)
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).

repeated .operations_research.pdlp.IterationStats iteration_stats = 7;

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 513 of file SolveLog.java.

◆ getIterationStatsCount()

int com.google.ortools.pdlp.SolveLog.getIterationStatsCount ( )
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).

repeated .operations_research.pdlp.IterationStats iteration_stats = 7;

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 495 of file SolveLog.java.

◆ getIterationStatsList()

java.util.List< com.google.ortools.pdlp.IterationStats > com.google.ortools.pdlp.SolveLog.getIterationStatsList ( )
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).

repeated .operations_research.pdlp.IterationStats iteration_stats = 7;

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 458 of file SolveLog.java.

◆ getIterationStatsOrBuilder()

com.google.ortools.pdlp.IterationStatsOrBuilder com.google.ortools.pdlp.SolveLog.getIterationStatsOrBuilder ( int index)
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).

repeated .operations_research.pdlp.IterationStats iteration_stats = 7;

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 531 of file SolveLog.java.

◆ getIterationStatsOrBuilderList()

java.util.List<? extends com.google.ortools.pdlp.IterationStatsOrBuilder > com.google.ortools.pdlp.SolveLog.getIterationStatsOrBuilderList ( )
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).

repeated .operations_research.pdlp.IterationStats iteration_stats = 7;

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 477 of file SolveLog.java.

◆ getOriginalProblemStats()

com.google.ortools.pdlp.QuadraticProgramStats com.google.ortools.pdlp.SolveLog.getOriginalProblemStats ( )
Statistics of the original problem.

optional .operations_research.pdlp.QuadraticProgramStats original_problem_stats = 11;

Returns
The originalProblemStats.

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 559 of file SolveLog.java.

◆ getOriginalProblemStatsOrBuilder()

com.google.ortools.pdlp.QuadraticProgramStatsOrBuilder com.google.ortools.pdlp.SolveLog.getOriginalProblemStatsOrBuilder ( )
Statistics of the original problem.

optional .operations_research.pdlp.QuadraticProgramStats original_problem_stats = 11;

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 570 of file SolveLog.java.

◆ getParams()

com.google.ortools.pdlp.PrimalDualHybridGradientParams com.google.ortools.pdlp.SolveLog.getParams ( )
If solved with PDLP, the parameters for this solve.

optional .operations_research.pdlp.PrimalDualHybridGradientParams params = 14;

Returns
The params.

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 137 of file SolveLog.java.

◆ getParamsOrBuilder()

com.google.ortools.pdlp.PrimalDualHybridGradientParamsOrBuilder com.google.ortools.pdlp.SolveLog.getParamsOrBuilder ( )
If solved with PDLP, the parameters for this solve.

optional .operations_research.pdlp.PrimalDualHybridGradientParams params = 14;

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 148 of file SolveLog.java.

◆ getParserForType()

com.google.protobuf.Parser< SolveLog > com.google.ortools.pdlp.SolveLog.getParserForType ( )

Definition at line 3524 of file SolveLog.java.

◆ getPreprocessedProblemStats()

com.google.ortools.pdlp.QuadraticProgramStats com.google.ortools.pdlp.SolveLog.getPreprocessedProblemStats ( )
Statistics of the problem after preprocessing.

optional .operations_research.pdlp.QuadraticProgramStats preprocessed_problem_stats = 12;

Returns
The preprocessedProblemStats.

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 597 of file SolveLog.java.

◆ getPreprocessedProblemStatsOrBuilder()

com.google.ortools.pdlp.QuadraticProgramStatsOrBuilder com.google.ortools.pdlp.SolveLog.getPreprocessedProblemStatsOrBuilder ( )
Statistics of the problem after preprocessing.

optional .operations_research.pdlp.QuadraticProgramStats preprocessed_problem_stats = 12;

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 608 of file SolveLog.java.

◆ getPreprocessingTimeSec()

double com.google.ortools.pdlp.SolveLog.getPreprocessingTimeSec ( )
Time for preprocessing (everything before iteration 0). This is also
included in `solve_time_sec`.

optional double preprocessing_time_sec = 13;

Returns
The preprocessingTimeSec.

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 295 of file SolveLog.java.

◆ getSerializedSize()

int com.google.ortools.pdlp.SolveLog.getSerializedSize ( )

Definition at line 735 of file SolveLog.java.

◆ getSolutionStats()

com.google.ortools.pdlp.IterationStats com.google.ortools.pdlp.SolveLog.getSolutionStats ( )
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.

optional .operations_research.pdlp.IterationStats solution_stats = 8;

Returns
The solutionStats.

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 367 of file SolveLog.java.

◆ getSolutionStatsOrBuilder()

com.google.ortools.pdlp.IterationStatsOrBuilder com.google.ortools.pdlp.SolveLog.getSolutionStatsOrBuilder ( )
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.

optional .operations_research.pdlp.IterationStats solution_stats = 8;

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 384 of file SolveLog.java.

◆ getSolutionType()

com.google.ortools.pdlp.PointType com.google.ortools.pdlp.SolveLog.getSolutionType ( )
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.

optional .operations_research.pdlp.PointType solution_type = 10;

Returns
The solutionType.

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 435 of file SolveLog.java.

◆ getSolveTimeSec()

double com.google.ortools.pdlp.SolveLog.getSolveTimeSec ( )
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.

optional double solve_time_sec = 6;

Returns
The solveTimeSec.

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 328 of file SolveLog.java.

◆ getTerminationReason()

com.google.ortools.pdlp.TerminationReason com.google.ortools.pdlp.SolveLog.getTerminationReason ( )
The reason that the solve terminated.

optional .operations_research.pdlp.TerminationReason termination_reason = 3;

Returns
The terminationReason.

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 173 of file SolveLog.java.

◆ getTerminationString()

java.lang.String com.google.ortools.pdlp.SolveLog.getTerminationString ( )
Optional extra information about the termination reason.

optional string termination_string = 4;

Returns
The terminationString.

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 202 of file SolveLog.java.

◆ getTerminationStringBytes()

com.google.protobuf.ByteString com.google.ortools.pdlp.SolveLog.getTerminationStringBytes ( )
Optional extra information about the termination reason.

optional string termination_string = 4;

Returns
The bytes for terminationString.

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 226 of file SolveLog.java.

◆ hashCode()

int com.google.ortools.pdlp.SolveLog.hashCode ( )

Definition at line 869 of file SolveLog.java.

◆ hasInstanceName()

boolean com.google.ortools.pdlp.SolveLog.hasInstanceName ( )
The name of the optimization problem.

optional string instance_name = 1;

Returns
Whether the instanceName field is set.

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 65 of file SolveLog.java.

◆ hasIterationCount()

boolean com.google.ortools.pdlp.SolveLog.hasIterationCount ( )
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.

optional int32 iteration_count = 5;

Returns
Whether the iterationCount field is set.

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 252 of file SolveLog.java.

◆ hasOriginalProblemStats()

boolean com.google.ortools.pdlp.SolveLog.hasOriginalProblemStats ( )
Statistics of the original problem.

optional .operations_research.pdlp.QuadraticProgramStats original_problem_stats = 11;

Returns
Whether the originalProblemStats field is set.

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 547 of file SolveLog.java.

◆ hasParams()

boolean com.google.ortools.pdlp.SolveLog.hasParams ( )
If solved with PDLP, the parameters for this solve.

optional .operations_research.pdlp.PrimalDualHybridGradientParams params = 14;

Returns
Whether the params field is set.

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 125 of file SolveLog.java.

◆ hasPreprocessedProblemStats()

boolean com.google.ortools.pdlp.SolveLog.hasPreprocessedProblemStats ( )
Statistics of the problem after preprocessing.

optional .operations_research.pdlp.QuadraticProgramStats preprocessed_problem_stats = 12;

Returns
Whether the preprocessedProblemStats field is set.

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 585 of file SolveLog.java.

◆ hasPreprocessingTimeSec()

boolean com.google.ortools.pdlp.SolveLog.hasPreprocessingTimeSec ( )
Time for preprocessing (everything before iteration 0). This is also
included in `solve_time_sec`.

optional double preprocessing_time_sec = 13;

Returns
Whether the preprocessingTimeSec field is set.

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 282 of file SolveLog.java.

◆ hasSolutionStats()

boolean com.google.ortools.pdlp.SolveLog.hasSolutionStats ( )
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.

optional .operations_research.pdlp.IterationStats solution_stats = 8;

Returns
Whether the solutionStats field is set.

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 349 of file SolveLog.java.

◆ hasSolutionType()

boolean com.google.ortools.pdlp.SolveLog.hasSolutionType ( )
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.

optional .operations_research.pdlp.PointType solution_type = 10;

Returns
Whether the solutionType field is set.

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 411 of file SolveLog.java.

◆ hasSolveTimeSec()

boolean com.google.ortools.pdlp.SolveLog.hasSolveTimeSec ( )
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.

optional double solve_time_sec = 6;

Returns
Whether the solveTimeSec field is set.

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 313 of file SolveLog.java.

◆ hasTerminationReason()

boolean com.google.ortools.pdlp.SolveLog.hasTerminationReason ( )
The reason that the solve terminated.

optional .operations_research.pdlp.TerminationReason termination_reason = 3;

Returns
Whether the terminationReason field is set.

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 162 of file SolveLog.java.

◆ hasTerminationString()

boolean com.google.ortools.pdlp.SolveLog.hasTerminationString ( )
Optional extra information about the termination reason.

optional string termination_string = 4;

Returns
Whether the terminationString field is set.

Implements com.google.ortools.pdlp.SolveLogOrBuilder.

Definition at line 190 of file SolveLog.java.

◆ internalGetFieldAccessorTable()

com.google.protobuf.GeneratedMessage.FieldAccessorTable com.google.ortools.pdlp.SolveLog.internalGetFieldAccessorTable ( )
protected

Definition at line 46 of file SolveLog.java.

◆ isInitialized()

final boolean com.google.ortools.pdlp.SolveLog.isInitialized ( )

Definition at line 680 of file SolveLog.java.

◆ newBuilder() [1/2]

Builder com.google.ortools.pdlp.SolveLog.newBuilder ( )
static

Definition at line 1008 of file SolveLog.java.

◆ newBuilder() [2/2]

Builder com.google.ortools.pdlp.SolveLog.newBuilder ( com.google.ortools.pdlp.SolveLog prototype)
static

Definition at line 1011 of file SolveLog.java.

◆ newBuilderForType() [1/2]

Builder com.google.ortools.pdlp.SolveLog.newBuilderForType ( )

Definition at line 1007 of file SolveLog.java.

◆ newBuilderForType() [2/2]

Builder com.google.ortools.pdlp.SolveLog.newBuilderForType ( com.google.protobuf.GeneratedMessage.BuilderParent parent)
protected

Definition at line 1021 of file SolveLog.java.

◆ parseDelimitedFrom() [1/2]

com.google.ortools.pdlp.SolveLog com.google.ortools.pdlp.SolveLog.parseDelimitedFrom ( java.io.InputStream input) throws java.io.IOException
static

Definition at line 979 of file SolveLog.java.

◆ parseDelimitedFrom() [2/2]

com.google.ortools.pdlp.SolveLog com.google.ortools.pdlp.SolveLog.parseDelimitedFrom ( java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry ) throws java.io.IOException
static

Definition at line 985 of file SolveLog.java.

◆ parseFrom() [1/10]

com.google.ortools.pdlp.SolveLog com.google.ortools.pdlp.SolveLog.parseFrom ( byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 956 of file SolveLog.java.

◆ parseFrom() [2/10]

com.google.ortools.pdlp.SolveLog com.google.ortools.pdlp.SolveLog.parseFrom ( byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry ) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 960 of file SolveLog.java.

◆ parseFrom() [3/10]

com.google.ortools.pdlp.SolveLog com.google.ortools.pdlp.SolveLog.parseFrom ( com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 945 of file SolveLog.java.

◆ parseFrom() [4/10]

com.google.ortools.pdlp.SolveLog com.google.ortools.pdlp.SolveLog.parseFrom ( com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry ) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 950 of file SolveLog.java.

◆ parseFrom() [5/10]

com.google.ortools.pdlp.SolveLog com.google.ortools.pdlp.SolveLog.parseFrom ( com.google.protobuf.CodedInputStream input) throws java.io.IOException
static

Definition at line 992 of file SolveLog.java.

◆ parseFrom() [6/10]

com.google.ortools.pdlp.SolveLog com.google.ortools.pdlp.SolveLog.parseFrom ( com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry ) throws java.io.IOException
static

Definition at line 998 of file SolveLog.java.

◆ parseFrom() [7/10]

com.google.ortools.pdlp.SolveLog com.google.ortools.pdlp.SolveLog.parseFrom ( java.io.InputStream input) throws java.io.IOException
static

Definition at line 966 of file SolveLog.java.

◆ parseFrom() [8/10]

com.google.ortools.pdlp.SolveLog com.google.ortools.pdlp.SolveLog.parseFrom ( java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry ) throws java.io.IOException
static

Definition at line 971 of file SolveLog.java.

◆ parseFrom() [9/10]

com.google.ortools.pdlp.SolveLog com.google.ortools.pdlp.SolveLog.parseFrom ( java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 934 of file SolveLog.java.

◆ parseFrom() [10/10]

com.google.ortools.pdlp.SolveLog com.google.ortools.pdlp.SolveLog.parseFrom ( java.nio.ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry ) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 939 of file SolveLog.java.

◆ parser()

com.google.protobuf.Parser< SolveLog > com.google.ortools.pdlp.SolveLog.parser ( )
static

Definition at line 3519 of file SolveLog.java.

◆ toBuilder()

Builder com.google.ortools.pdlp.SolveLog.toBuilder ( )

Definition at line 1015 of file SolveLog.java.

◆ writeTo()

void com.google.ortools.pdlp.SolveLog.writeTo ( com.google.protobuf.CodedOutputStream output) throws java.io.IOException

Definition at line 690 of file SolveLog.java.

Member Data Documentation

◆ FEASIBILITY_POLISHING_DETAILS_FIELD_NUMBER

final int com.google.ortools.pdlp.SolveLog.FEASIBILITY_POLISHING_DETAILS_FIELD_NUMBER = 15
static

Definition at line 612 of file SolveLog.java.

◆ INSTANCE_NAME_FIELD_NUMBER

final int com.google.ortools.pdlp.SolveLog.INSTANCE_NAME_FIELD_NUMBER = 1
static

Definition at line 53 of file SolveLog.java.

◆ ITERATION_COUNT_FIELD_NUMBER

final int com.google.ortools.pdlp.SolveLog.ITERATION_COUNT_FIELD_NUMBER = 5
static

Definition at line 239 of file SolveLog.java.

◆ ITERATION_STATS_FIELD_NUMBER

final int com.google.ortools.pdlp.SolveLog.ITERATION_STATS_FIELD_NUMBER = 7
static

Definition at line 440 of file SolveLog.java.

◆ ORIGINAL_PROBLEM_STATS_FIELD_NUMBER

final int com.google.ortools.pdlp.SolveLog.ORIGINAL_PROBLEM_STATS_FIELD_NUMBER = 11
static

Definition at line 536 of file SolveLog.java.

◆ PARAMS_FIELD_NUMBER

final int com.google.ortools.pdlp.SolveLog.PARAMS_FIELD_NUMBER = 14
static

Definition at line 114 of file SolveLog.java.

◆ PREPROCESSED_PROBLEM_STATS_FIELD_NUMBER

final int com.google.ortools.pdlp.SolveLog.PREPROCESSED_PROBLEM_STATS_FIELD_NUMBER = 12
static

Definition at line 574 of file SolveLog.java.

◆ PREPROCESSING_TIME_SEC_FIELD_NUMBER

final int com.google.ortools.pdlp.SolveLog.PREPROCESSING_TIME_SEC_FIELD_NUMBER = 13
static

Definition at line 270 of file SolveLog.java.

◆ SOLUTION_STATS_FIELD_NUMBER

final int com.google.ortools.pdlp.SolveLog.SOLUTION_STATS_FIELD_NUMBER = 8
static

Definition at line 332 of file SolveLog.java.

◆ SOLUTION_TYPE_FIELD_NUMBER

final int com.google.ortools.pdlp.SolveLog.SOLUTION_TYPE_FIELD_NUMBER = 10
static

Definition at line 388 of file SolveLog.java.

◆ SOLVE_TIME_SEC_FIELD_NUMBER

final int com.google.ortools.pdlp.SolveLog.SOLVE_TIME_SEC_FIELD_NUMBER = 6
static

Definition at line 299 of file SolveLog.java.

◆ TERMINATION_REASON_FIELD_NUMBER

final int com.google.ortools.pdlp.SolveLog.TERMINATION_REASON_FIELD_NUMBER = 3
static

Definition at line 152 of file SolveLog.java.

◆ TERMINATION_STRING_FIELD_NUMBER

final int com.google.ortools.pdlp.SolveLog.TERMINATION_STRING_FIELD_NUMBER = 4
static

Definition at line 178 of file SolveLog.java.


The documentation for this class was generated from the following file:
  • build/java/ortools-java/src/main/java/com/google/ortools/pdlp/SolveLog.java