com.google.ortools.pdlp.IterationStatsOrBuilder Interface Reference

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

Public Member Functions
boolean	hasIterationNumber ()
int	getIterationNumber ()
java.util.List< com.google.ortools.pdlp.ConvergenceInformation >	getConvergenceInformationList ()
com.google.ortools.pdlp.ConvergenceInformation	getConvergenceInformation (int index)
int	getConvergenceInformationCount ()
java.util.List<? extends com.google.ortools.pdlp.ConvergenceInformationOrBuilder >	getConvergenceInformationOrBuilderList ()
com.google.ortools.pdlp.ConvergenceInformationOrBuilder	getConvergenceInformationOrBuilder (int index)
java.util.List< com.google.ortools.pdlp.InfeasibilityInformation >	getInfeasibilityInformationList ()
com.google.ortools.pdlp.InfeasibilityInformation	getInfeasibilityInformation (int index)
int	getInfeasibilityInformationCount ()
java.util.List<? extends com.google.ortools.pdlp.InfeasibilityInformationOrBuilder >	getInfeasibilityInformationOrBuilderList ()
com.google.ortools.pdlp.InfeasibilityInformationOrBuilder	getInfeasibilityInformationOrBuilder (int index)
java.util.List< com.google.ortools.pdlp.PointMetadata >	getPointMetadataList ()
com.google.ortools.pdlp.PointMetadata	getPointMetadata (int index)
int	getPointMetadataCount ()
java.util.List<? extends com.google.ortools.pdlp.PointMetadataOrBuilder >	getPointMetadataOrBuilderList ()
com.google.ortools.pdlp.PointMetadataOrBuilder	getPointMetadataOrBuilder (int index)
boolean	hasCumulativeKktMatrixPasses ()
double	getCumulativeKktMatrixPasses ()
boolean	hasCumulativeRejectedSteps ()
int	getCumulativeRejectedSteps ()
boolean	hasCumulativeTimeSec ()
double	getCumulativeTimeSec ()
boolean	hasRestartUsed ()
com.google.ortools.pdlp.RestartChoice	getRestartUsed ()
boolean	hasStepSize ()
double	getStepSize ()
boolean	hasPrimalWeight ()
double	getPrimalWeight ()

Detailed Description

Definition at line 7 of file IterationStatsOrBuilder.java.

Member Function Documentation

getConvergenceInformation()

com.google.ortools.pdlp.ConvergenceInformation com.google.ortools.pdlp.IterationStatsOrBuilder.getConvergenceInformation

(

int

index

)

A set of statistics measuring how close a point is to establishing primal
and dual feasibility and optimality. This field is repeated since there
might be several different points that are considered.

repeated .operations_research.pdlp.ConvergenceInformation convergence_information = 2;

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

getConvergenceInformationCount()

int com.google.ortools.pdlp.IterationStatsOrBuilder.getConvergenceInformationCount

(

)

A set of statistics measuring how close a point is to establishing primal
and dual feasibility and optimality. This field is repeated since there
might be several different points that are considered.

repeated .operations_research.pdlp.ConvergenceInformation convergence_information = 2;

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

getConvergenceInformationList()

java.util.List< com.google.ortools.pdlp.ConvergenceInformation > com.google.ortools.pdlp.IterationStatsOrBuilder.getConvergenceInformationList

(

)

A set of statistics measuring how close a point is to establishing primal
and dual feasibility and optimality. This field is repeated since there
might be several different points that are considered.

repeated .operations_research.pdlp.ConvergenceInformation convergence_information = 2;

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

getConvergenceInformationOrBuilder()

com.google.ortools.pdlp.ConvergenceInformationOrBuilder com.google.ortools.pdlp.IterationStatsOrBuilder.getConvergenceInformationOrBuilder

(

int

index

)

A set of statistics measuring how close a point is to establishing primal
and dual feasibility and optimality. This field is repeated since there
might be several different points that are considered.

repeated .operations_research.pdlp.ConvergenceInformation convergence_information = 2;

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

getConvergenceInformationOrBuilderList()

java.util.List<? extends com.google.ortools.pdlp.ConvergenceInformationOrBuilder > com.google.ortools.pdlp.IterationStatsOrBuilder.getConvergenceInformationOrBuilderList

(

)

A set of statistics measuring how close a point is to establishing primal
and dual feasibility and optimality. This field is repeated since there
might be several different points that are considered.

repeated .operations_research.pdlp.ConvergenceInformation convergence_information = 2;

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

getCumulativeKktMatrixPasses()

double com.google.ortools.pdlp.IterationStatsOrBuilder.getCumulativeKktMatrixPasses

(

)

The cumulative number of passes through the KKT matrix since the start of
the solve. One pass is a multply by the constraint matrix, its transpose
and the matrix that defines the quadratic part of the objective.

For example, each iteration of mirror saddle prox contributes 2.0 to this
sum. This is a float because it can include fractional passes through the
data. For example, in an active set method we may only use a submatrix with
20% of the nonzeros of the KKT matrix at each iteration in which case 0.2
would be added to the total.

optional double cumulative_kkt_matrix_passes = 4;

Returns

The cumulativeKktMatrixPasses.

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

getCumulativeRejectedSteps()

int com.google.ortools.pdlp.IterationStatsOrBuilder.getCumulativeRejectedSteps

(

)

The total number of rejected steps (e.g., within a line search procedure)
since the start of the solve.

optional int32 cumulative_rejected_steps = 5;

Returns

The cumulativeRejectedSteps.

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

getCumulativeTimeSec()

double com.google.ortools.pdlp.IterationStatsOrBuilder.getCumulativeTimeSec

(

)

The amount of time passed since we started solving the problem (see solver
log `solve_time_sec` which records total time).

optional double cumulative_time_sec = 6;

Returns

The cumulativeTimeSec.

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

getInfeasibilityInformation()

com.google.ortools.pdlp.InfeasibilityInformation com.google.ortools.pdlp.IterationStatsOrBuilder.getInfeasibilityInformation

(

int

index

)

A set of statistics measuring how close a point is to establishing primal
or dual infeasibility (i.e., has no solution). This field is repeated since
there might be several different points that could establish infeasibility.

repeated .operations_research.pdlp.InfeasibilityInformation infeasibility_information = 3;

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

getInfeasibilityInformationCount()

int com.google.ortools.pdlp.IterationStatsOrBuilder.getInfeasibilityInformationCount

(

)

A set of statistics measuring how close a point is to establishing primal
or dual infeasibility (i.e., has no solution). This field is repeated since
there might be several different points that could establish infeasibility.

repeated .operations_research.pdlp.InfeasibilityInformation infeasibility_information = 3;

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

getInfeasibilityInformationList()

java.util.List< com.google.ortools.pdlp.InfeasibilityInformation > com.google.ortools.pdlp.IterationStatsOrBuilder.getInfeasibilityInformationList

(

)

A set of statistics measuring how close a point is to establishing primal
or dual infeasibility (i.e., has no solution). This field is repeated since
there might be several different points that could establish infeasibility.

repeated .operations_research.pdlp.InfeasibilityInformation infeasibility_information = 3;

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

getInfeasibilityInformationOrBuilder()

com.google.ortools.pdlp.InfeasibilityInformationOrBuilder com.google.ortools.pdlp.IterationStatsOrBuilder.getInfeasibilityInformationOrBuilder

(

int

index

)

A set of statistics measuring how close a point is to establishing primal
or dual infeasibility (i.e., has no solution). This field is repeated since
there might be several different points that could establish infeasibility.

repeated .operations_research.pdlp.InfeasibilityInformation infeasibility_information = 3;

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

getInfeasibilityInformationOrBuilderList()

java.util.List<? extends com.google.ortools.pdlp.InfeasibilityInformationOrBuilder > com.google.ortools.pdlp.IterationStatsOrBuilder.getInfeasibilityInformationOrBuilderList

(

)

A set of statistics measuring how close a point is to establishing primal
or dual infeasibility (i.e., has no solution). This field is repeated since
there might be several different points that could establish infeasibility.

repeated .operations_research.pdlp.InfeasibilityInformation infeasibility_information = 3;

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

getIterationNumber()

int com.google.ortools.pdlp.IterationStatsOrBuilder.getIterationNumber

(

)

The iteration number at which these stats were recorded. By convention,
iteration counts start at 1, and the stats correspond to the solution
*after* the iteration. Therefore stats from iteration 0 are the stats at
the starting point.

optional int32 iteration_number = 1;

Returns

The iterationNumber.

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

getPointMetadata()

com.google.ortools.pdlp.PointMetadata com.google.ortools.pdlp.IterationStatsOrBuilder.getPointMetadata

(

int

index

)

Auxiliary statistics for each type of point.

repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

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

getPointMetadataCount()

int com.google.ortools.pdlp.IterationStatsOrBuilder.getPointMetadataCount

(

)

Auxiliary statistics for each type of point.

repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

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

getPointMetadataList()

java.util.List< com.google.ortools.pdlp.PointMetadata > com.google.ortools.pdlp.IterationStatsOrBuilder.getPointMetadataList

(

)

Auxiliary statistics for each type of point.

repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

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

getPointMetadataOrBuilder()

com.google.ortools.pdlp.PointMetadataOrBuilder com.google.ortools.pdlp.IterationStatsOrBuilder.getPointMetadataOrBuilder

(

int

index

)

Auxiliary statistics for each type of point.

repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

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

getPointMetadataOrBuilderList()

java.util.List<? extends com.google.ortools.pdlp.PointMetadataOrBuilder > com.google.ortools.pdlp.IterationStatsOrBuilder.getPointMetadataOrBuilderList

(

)

Auxiliary statistics for each type of point.

repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

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

getPrimalWeight()

double com.google.ortools.pdlp.IterationStatsOrBuilder.getPrimalWeight

(

)

Primal weight controlling the relation between primal and dual step sizes.
See field 'step_size' for a detailed description.

optional double primal_weight = 9;

Returns

The primalWeight.

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

getRestartUsed()

com.google.ortools.pdlp.RestartChoice com.google.ortools.pdlp.IterationStatsOrBuilder.getRestartUsed

(

)

The kind of restart that occurred at this iteration, or NO_RESTART if a
restart did not occur.

optional .operations_research.pdlp.RestartChoice restart_used = 7;

Returns

The restartUsed.

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

getStepSize()

double com.google.ortools.pdlp.IterationStatsOrBuilder.getStepSize

(

)

Step size used at this iteration. Note that the step size used for the
primal update is step_size / primal_weight, while the one used for the dual
update is step_size * primal_weight.

optional double step_size = 8;

Returns

The stepSize.

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

hasCumulativeKktMatrixPasses()

boolean com.google.ortools.pdlp.IterationStatsOrBuilder.hasCumulativeKktMatrixPasses

(

)

The cumulative number of passes through the KKT matrix since the start of
the solve. One pass is a multply by the constraint matrix, its transpose
and the matrix that defines the quadratic part of the objective.

For example, each iteration of mirror saddle prox contributes 2.0 to this
sum. This is a float because it can include fractional passes through the
data. For example, in an active set method we may only use a submatrix with
20% of the nonzeros of the KKT matrix at each iteration in which case 0.2
would be added to the total.

optional double cumulative_kkt_matrix_passes = 4;

Returns

Whether the cumulativeKktMatrixPasses field is set.

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

hasCumulativeRejectedSteps()

boolean com.google.ortools.pdlp.IterationStatsOrBuilder.hasCumulativeRejectedSteps

(

)

The total number of rejected steps (e.g., within a line search procedure)
since the start of the solve.

optional int32 cumulative_rejected_steps = 5;

Returns

Whether the cumulativeRejectedSteps field is set.

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

hasCumulativeTimeSec()

boolean com.google.ortools.pdlp.IterationStatsOrBuilder.hasCumulativeTimeSec

(

)

The amount of time passed since we started solving the problem (see solver
log `solve_time_sec` which records total time).

optional double cumulative_time_sec = 6;

Returns

Whether the cumulativeTimeSec field is set.

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

hasIterationNumber()

boolean com.google.ortools.pdlp.IterationStatsOrBuilder.hasIterationNumber

(

)

The iteration number at which these stats were recorded. By convention,
iteration counts start at 1, and the stats correspond to the solution
*after* the iteration. Therefore stats from iteration 0 are the stats at
the starting point.

optional int32 iteration_number = 1;

Returns

Whether the iterationNumber field is set.

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

hasPrimalWeight()

boolean com.google.ortools.pdlp.IterationStatsOrBuilder.hasPrimalWeight

(

)

Primal weight controlling the relation between primal and dual step sizes.
See field 'step_size' for a detailed description.

optional double primal_weight = 9;

Returns

Whether the primalWeight field is set.

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

hasRestartUsed()

boolean com.google.ortools.pdlp.IterationStatsOrBuilder.hasRestartUsed

(

)

The kind of restart that occurred at this iteration, or NO_RESTART if a
restart did not occur.

optional .operations_research.pdlp.RestartChoice restart_used = 7;

Returns

Whether the restartUsed field is set.

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

hasStepSize()

boolean com.google.ortools.pdlp.IterationStatsOrBuilder.hasStepSize

(

)

Step size used at this iteration. Note that the step size used for the
primal update is step_size / primal_weight, while the one used for the dual
update is step_size * primal_weight.

optional double step_size = 8;

Returns

Whether the stepSize field is set.

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

---

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

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