com.google.ortools.pdlp.SolveLogOrBuilder Interface Reference

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

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.IterationStats >	getIterationStatsList ()
com.google.ortools.pdlp.IterationStats	getIterationStats (int index)
int	getIterationStatsCount ()
java.util.List<? extends com.google.ortools.pdlp.IterationStatsOrBuilder >	getIterationStatsOrBuilderList ()
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.FeasibilityPolishingDetails >	getFeasibilityPolishingDetailsList ()
com.google.ortools.pdlp.FeasibilityPolishingDetails	getFeasibilityPolishingDetails (int index)
int	getFeasibilityPolishingDetailsCount ()
java.util.List<? extends com.google.ortools.pdlp.FeasibilityPolishingDetailsOrBuilder >	getFeasibilityPolishingDetailsOrBuilderList ()
com.google.ortools.pdlp.FeasibilityPolishingDetailsOrBuilder	getFeasibilityPolishingDetailsOrBuilder (int index)

Detailed Description

Definition at line 7 of file SolveLogOrBuilder.java.

Member Function Documentation

getFeasibilityPolishingDetails()

com.google.ortools.pdlp.FeasibilityPolishingDetails com.google.ortools.pdlp.SolveLogOrBuilder.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;

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

getFeasibilityPolishingDetailsCount()

int com.google.ortools.pdlp.SolveLogOrBuilder.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;

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

getFeasibilityPolishingDetailsList()

java.util.List< com.google.ortools.pdlp.FeasibilityPolishingDetails > com.google.ortools.pdlp.SolveLogOrBuilder.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;

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

getFeasibilityPolishingDetailsOrBuilder()

com.google.ortools.pdlp.FeasibilityPolishingDetailsOrBuilder com.google.ortools.pdlp.SolveLogOrBuilder.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;

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

getFeasibilityPolishingDetailsOrBuilderList()

java.util.List<? extends com.google.ortools.pdlp.FeasibilityPolishingDetailsOrBuilder > com.google.ortools.pdlp.SolveLogOrBuilder.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;

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

getInstanceName()

java.lang.String com.google.ortools.pdlp.SolveLogOrBuilder.getInstanceName

(

)

The name of the optimization problem.

optional string instance_name = 1;

Returns

The instanceName.

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

getInstanceNameBytes()

com.google.protobuf.ByteString com.google.ortools.pdlp.SolveLogOrBuilder.getInstanceNameBytes

(

)

The name of the optimization problem.

optional string instance_name = 1;

Returns

The bytes for instanceName.

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

getIterationCount()

int com.google.ortools.pdlp.SolveLogOrBuilder.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.

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

getIterationStats()

com.google.ortools.pdlp.IterationStats com.google.ortools.pdlp.SolveLogOrBuilder.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;

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

getIterationStatsCount()

int com.google.ortools.pdlp.SolveLogOrBuilder.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;

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

getIterationStatsList()

java.util.List< com.google.ortools.pdlp.IterationStats > com.google.ortools.pdlp.SolveLogOrBuilder.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;

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

getIterationStatsOrBuilder()

com.google.ortools.pdlp.IterationStatsOrBuilder com.google.ortools.pdlp.SolveLogOrBuilder.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;

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

getIterationStatsOrBuilderList()

java.util.List<? extends com.google.ortools.pdlp.IterationStatsOrBuilder > com.google.ortools.pdlp.SolveLogOrBuilder.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;

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

getOriginalProblemStats()

com.google.ortools.pdlp.QuadraticProgramStats com.google.ortools.pdlp.SolveLogOrBuilder.getOriginalProblemStats

(

)

Statistics of the original problem.

optional .operations_research.pdlp.QuadraticProgramStats original_problem_stats = 11;

Returns

The originalProblemStats.

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

getOriginalProblemStatsOrBuilder()

com.google.ortools.pdlp.QuadraticProgramStatsOrBuilder com.google.ortools.pdlp.SolveLogOrBuilder.getOriginalProblemStatsOrBuilder

(

)

Statistics of the original problem.

optional .operations_research.pdlp.QuadraticProgramStats original_problem_stats = 11;

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

getParams()

com.google.ortools.pdlp.PrimalDualHybridGradientParams com.google.ortools.pdlp.SolveLogOrBuilder.getParams

(

)

If solved with PDLP, the parameters for this solve.

optional .operations_research.pdlp.PrimalDualHybridGradientParams params = 14;

Returns

The params.

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

getParamsOrBuilder()

com.google.ortools.pdlp.PrimalDualHybridGradientParamsOrBuilder com.google.ortools.pdlp.SolveLogOrBuilder.getParamsOrBuilder

(

)

If solved with PDLP, the parameters for this solve.

optional .operations_research.pdlp.PrimalDualHybridGradientParams params = 14;

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

getPreprocessedProblemStats()

com.google.ortools.pdlp.QuadraticProgramStats com.google.ortools.pdlp.SolveLogOrBuilder.getPreprocessedProblemStats

(

)

Statistics of the problem after preprocessing.

optional .operations_research.pdlp.QuadraticProgramStats preprocessed_problem_stats = 12;

Returns

The preprocessedProblemStats.

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

getPreprocessedProblemStatsOrBuilder()

com.google.ortools.pdlp.QuadraticProgramStatsOrBuilder com.google.ortools.pdlp.SolveLogOrBuilder.getPreprocessedProblemStatsOrBuilder

(

)

Statistics of the problem after preprocessing.

optional .operations_research.pdlp.QuadraticProgramStats preprocessed_problem_stats = 12;

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

getPreprocessingTimeSec()

double com.google.ortools.pdlp.SolveLogOrBuilder.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.

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

getSolutionStats()

com.google.ortools.pdlp.IterationStats com.google.ortools.pdlp.SolveLogOrBuilder.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.

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

getSolutionStatsOrBuilder()

com.google.ortools.pdlp.IterationStatsOrBuilder com.google.ortools.pdlp.SolveLogOrBuilder.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;

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

getSolutionType()

com.google.ortools.pdlp.PointType com.google.ortools.pdlp.SolveLogOrBuilder.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.

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

getSolveTimeSec()

double com.google.ortools.pdlp.SolveLogOrBuilder.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.

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

getTerminationReason()

com.google.ortools.pdlp.TerminationReason com.google.ortools.pdlp.SolveLogOrBuilder.getTerminationReason

(

)

The reason that the solve terminated.

optional .operations_research.pdlp.TerminationReason termination_reason = 3;

Returns

The terminationReason.

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

getTerminationString()

java.lang.String com.google.ortools.pdlp.SolveLogOrBuilder.getTerminationString

(

)

Optional extra information about the termination reason.

optional string termination_string = 4;

Returns

The terminationString.

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

getTerminationStringBytes()

com.google.protobuf.ByteString com.google.ortools.pdlp.SolveLogOrBuilder.getTerminationStringBytes

(

)

Optional extra information about the termination reason.

optional string termination_string = 4;

Returns

The bytes for terminationString.

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

hasInstanceName()

boolean com.google.ortools.pdlp.SolveLogOrBuilder.hasInstanceName

(

)

The name of the optimization problem.

optional string instance_name = 1;

Returns

Whether the instanceName field is set.

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

hasIterationCount()

boolean com.google.ortools.pdlp.SolveLogOrBuilder.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.

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

hasOriginalProblemStats()

boolean com.google.ortools.pdlp.SolveLogOrBuilder.hasOriginalProblemStats

(

)

Statistics of the original problem.

optional .operations_research.pdlp.QuadraticProgramStats original_problem_stats = 11;

Returns

Whether the originalProblemStats field is set.

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

hasParams()

boolean com.google.ortools.pdlp.SolveLogOrBuilder.hasParams

(

)

If solved with PDLP, the parameters for this solve.

optional .operations_research.pdlp.PrimalDualHybridGradientParams params = 14;

Returns

Whether the params field is set.

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

hasPreprocessedProblemStats()

boolean com.google.ortools.pdlp.SolveLogOrBuilder.hasPreprocessedProblemStats

(

)

Statistics of the problem after preprocessing.

optional .operations_research.pdlp.QuadraticProgramStats preprocessed_problem_stats = 12;

Returns

Whether the preprocessedProblemStats field is set.

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

hasPreprocessingTimeSec()

boolean com.google.ortools.pdlp.SolveLogOrBuilder.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.

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

hasSolutionStats()

boolean com.google.ortools.pdlp.SolveLogOrBuilder.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.

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

hasSolutionType()

boolean com.google.ortools.pdlp.SolveLogOrBuilder.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.

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

hasSolveTimeSec()

boolean com.google.ortools.pdlp.SolveLogOrBuilder.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.

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

hasTerminationReason()

boolean com.google.ortools.pdlp.SolveLogOrBuilder.hasTerminationReason

(

)

The reason that the solve terminated.

optional .operations_research.pdlp.TerminationReason termination_reason = 3;

Returns

Whether the terminationReason field is set.

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

hasTerminationString()

boolean com.google.ortools.pdlp.SolveLogOrBuilder.hasTerminationString

(

)

Optional extra information about the termination reason.

optional string termination_string = 4;

Returns

Whether the terminationString field is set.

Implemented in com.google.ortools.pdlp.SolveLog.Builder, and com.google.ortools.pdlp.SolveLog.

---

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

• build/java/ortools-java/src/main/java/com/google/ortools/pdlp/SolveLogOrBuilder.java