Google OR-Tools v9.12
a fast and portable software suite for combinatorial optimization
Loading...
Searching...
No Matches
com.google.ortools.pdlp.IterationStats.Builder Class Reference
Inheritance diagram for com.google.ortools.pdlp.IterationStats.Builder:
com.google.ortools.pdlp.IterationStatsOrBuilder

Public Member Functions

Builder clear ()
 
com.google.protobuf.Descriptors.Descriptor getDescriptorForType ()
 
com.google.ortools.pdlp.IterationStats getDefaultInstanceForType ()
 
com.google.ortools.pdlp.IterationStats build ()
 
com.google.ortools.pdlp.IterationStats buildPartial ()
 
Builder mergeFrom (com.google.protobuf.Message other)
 
Builder mergeFrom (com.google.ortools.pdlp.IterationStats other)
 
final boolean isInitialized ()
 
Builder mergeFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
 
boolean hasIterationNumber ()
 
int getIterationNumber ()
 
Builder setIterationNumber (int value)
 
Builder clearIterationNumber ()
 
java.util.List< com.google.ortools.pdlp.ConvergenceInformationgetConvergenceInformationList ()
 
int getConvergenceInformationCount ()
 
com.google.ortools.pdlp.ConvergenceInformation getConvergenceInformation (int index)
 
Builder setConvergenceInformation (int index, com.google.ortools.pdlp.ConvergenceInformation value)
 
Builder setConvergenceInformation (int index, com.google.ortools.pdlp.ConvergenceInformation.Builder builderForValue)
 
Builder addConvergenceInformation (com.google.ortools.pdlp.ConvergenceInformation value)
 
Builder addConvergenceInformation (int index, com.google.ortools.pdlp.ConvergenceInformation value)
 
Builder addConvergenceInformation (com.google.ortools.pdlp.ConvergenceInformation.Builder builderForValue)
 
Builder addConvergenceInformation (int index, com.google.ortools.pdlp.ConvergenceInformation.Builder builderForValue)
 
Builder addAllConvergenceInformation (java.lang.Iterable<? extends com.google.ortools.pdlp.ConvergenceInformation > values)
 
Builder clearConvergenceInformation ()
 
Builder removeConvergenceInformation (int index)
 
com.google.ortools.pdlp.ConvergenceInformation.Builder getConvergenceInformationBuilder (int index)
 
com.google.ortools.pdlp.ConvergenceInformationOrBuilder getConvergenceInformationOrBuilder (int index)
 
java.util.List<? extends com.google.ortools.pdlp.ConvergenceInformationOrBuildergetConvergenceInformationOrBuilderList ()
 
com.google.ortools.pdlp.ConvergenceInformation.Builder addConvergenceInformationBuilder ()
 
com.google.ortools.pdlp.ConvergenceInformation.Builder addConvergenceInformationBuilder (int index)
 
java.util.List< com.google.ortools.pdlp.ConvergenceInformation.BuildergetConvergenceInformationBuilderList ()
 
java.util.List< com.google.ortools.pdlp.InfeasibilityInformationgetInfeasibilityInformationList ()
 
int getInfeasibilityInformationCount ()
 
com.google.ortools.pdlp.InfeasibilityInformation getInfeasibilityInformation (int index)
 
Builder setInfeasibilityInformation (int index, com.google.ortools.pdlp.InfeasibilityInformation value)
 
Builder setInfeasibilityInformation (int index, com.google.ortools.pdlp.InfeasibilityInformation.Builder builderForValue)
 
Builder addInfeasibilityInformation (com.google.ortools.pdlp.InfeasibilityInformation value)
 
Builder addInfeasibilityInformation (int index, com.google.ortools.pdlp.InfeasibilityInformation value)
 
Builder addInfeasibilityInformation (com.google.ortools.pdlp.InfeasibilityInformation.Builder builderForValue)
 
Builder addInfeasibilityInformation (int index, com.google.ortools.pdlp.InfeasibilityInformation.Builder builderForValue)
 
Builder addAllInfeasibilityInformation (java.lang.Iterable<? extends com.google.ortools.pdlp.InfeasibilityInformation > values)
 
Builder clearInfeasibilityInformation ()
 
Builder removeInfeasibilityInformation (int index)
 
com.google.ortools.pdlp.InfeasibilityInformation.Builder getInfeasibilityInformationBuilder (int index)
 
com.google.ortools.pdlp.InfeasibilityInformationOrBuilder getInfeasibilityInformationOrBuilder (int index)
 
java.util.List<? extends com.google.ortools.pdlp.InfeasibilityInformationOrBuildergetInfeasibilityInformationOrBuilderList ()
 
com.google.ortools.pdlp.InfeasibilityInformation.Builder addInfeasibilityInformationBuilder ()
 
com.google.ortools.pdlp.InfeasibilityInformation.Builder addInfeasibilityInformationBuilder (int index)
 
java.util.List< com.google.ortools.pdlp.InfeasibilityInformation.BuildergetInfeasibilityInformationBuilderList ()
 
java.util.List< com.google.ortools.pdlp.PointMetadatagetPointMetadataList ()
 
int getPointMetadataCount ()
 
com.google.ortools.pdlp.PointMetadata getPointMetadata (int index)
 
Builder setPointMetadata (int index, com.google.ortools.pdlp.PointMetadata value)
 
Builder setPointMetadata (int index, com.google.ortools.pdlp.PointMetadata.Builder builderForValue)
 
Builder addPointMetadata (com.google.ortools.pdlp.PointMetadata value)
 
Builder addPointMetadata (int index, com.google.ortools.pdlp.PointMetadata value)
 
Builder addPointMetadata (com.google.ortools.pdlp.PointMetadata.Builder builderForValue)
 
Builder addPointMetadata (int index, com.google.ortools.pdlp.PointMetadata.Builder builderForValue)
 
Builder addAllPointMetadata (java.lang.Iterable<? extends com.google.ortools.pdlp.PointMetadata > values)
 
Builder clearPointMetadata ()
 
Builder removePointMetadata (int index)
 
com.google.ortools.pdlp.PointMetadata.Builder getPointMetadataBuilder (int index)
 
com.google.ortools.pdlp.PointMetadataOrBuilder getPointMetadataOrBuilder (int index)
 
java.util.List<? extends com.google.ortools.pdlp.PointMetadataOrBuildergetPointMetadataOrBuilderList ()
 
com.google.ortools.pdlp.PointMetadata.Builder addPointMetadataBuilder ()
 
com.google.ortools.pdlp.PointMetadata.Builder addPointMetadataBuilder (int index)
 
java.util.List< com.google.ortools.pdlp.PointMetadata.BuildergetPointMetadataBuilderList ()
 
boolean hasCumulativeKktMatrixPasses ()
 
double getCumulativeKktMatrixPasses ()
 
Builder setCumulativeKktMatrixPasses (double value)
 
Builder clearCumulativeKktMatrixPasses ()
 
boolean hasCumulativeRejectedSteps ()
 
int getCumulativeRejectedSteps ()
 
Builder setCumulativeRejectedSteps (int value)
 
Builder clearCumulativeRejectedSteps ()
 
boolean hasCumulativeTimeSec ()
 
double getCumulativeTimeSec ()
 
Builder setCumulativeTimeSec (double value)
 
Builder clearCumulativeTimeSec ()
 
boolean hasRestartUsed ()
 
com.google.ortools.pdlp.RestartChoice getRestartUsed ()
 
Builder setRestartUsed (com.google.ortools.pdlp.RestartChoice value)
 
Builder clearRestartUsed ()
 
boolean hasStepSize ()
 
double getStepSize ()
 
Builder setStepSize (double value)
 
Builder clearStepSize ()
 
boolean hasPrimalWeight ()
 
double getPrimalWeight ()
 
Builder setPrimalWeight (double value)
 
Builder clearPrimalWeight ()
 

Static Public Member Functions

static final com.google.protobuf.Descriptors.Descriptor getDescriptor ()
 

Protected Member Functions

com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable ()
 

Detailed Description

All values in IterationStats assume that the primal quadratic program is a
minimization problem and the dual is a maximization problem. Problems should
be transformed to this form if they are not already in this form. The dual
vector is defined to be the vector of multipliers on the linear constraints,
that is, excluding dual multipliers on variable bounds (reduced costs).

Protobuf type operations_research.pdlp.IterationStats

Definition at line 798 of file IterationStats.java.

Member Function Documentation

◆ addAllConvergenceInformation()

Builder com.google.ortools.pdlp.IterationStats.Builder.addAllConvergenceInformation ( java.lang.Iterable<? extends com.google.ortools.pdlp.ConvergenceInformation > values)
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;

Definition at line 1453 of file IterationStats.java.

◆ addAllInfeasibilityInformation()

Builder com.google.ortools.pdlp.IterationStats.Builder.addAllInfeasibilityInformation ( java.lang.Iterable<? extends com.google.ortools.pdlp.InfeasibilityInformation > values)
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;

Definition at line 1801 of file IterationStats.java.

◆ addAllPointMetadata()

Builder com.google.ortools.pdlp.IterationStats.Builder.addAllPointMetadata ( java.lang.Iterable<? extends com.google.ortools.pdlp.PointMetadata > values)
Auxiliary statistics for each type of point.

repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

Definition at line 2129 of file IterationStats.java.

◆ addConvergenceInformation() [1/4]

Builder com.google.ortools.pdlp.IterationStats.Builder.addConvergenceInformation ( com.google.ortools.pdlp.ConvergenceInformation value)
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;

Definition at line 1368 of file IterationStats.java.

◆ addConvergenceInformation() [2/4]

Builder com.google.ortools.pdlp.IterationStats.Builder.addConvergenceInformation ( com.google.ortools.pdlp.ConvergenceInformation.Builder builderForValue)
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;

Definition at line 1413 of file IterationStats.java.

◆ addConvergenceInformation() [3/4]

Builder com.google.ortools.pdlp.IterationStats.Builder.addConvergenceInformation ( int index,
com.google.ortools.pdlp.ConvergenceInformation value )
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;

Definition at line 1390 of file IterationStats.java.

◆ addConvergenceInformation() [4/4]

Builder com.google.ortools.pdlp.IterationStats.Builder.addConvergenceInformation ( int index,
com.google.ortools.pdlp.ConvergenceInformation.Builder builderForValue )
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;

Definition at line 1433 of file IterationStats.java.

◆ addConvergenceInformationBuilder() [1/2]

com.google.ortools.pdlp.ConvergenceInformation.Builder com.google.ortools.pdlp.IterationStats.Builder.addConvergenceInformationBuilder ( )
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;

Definition at line 1558 of file IterationStats.java.

◆ addConvergenceInformationBuilder() [2/2]

com.google.ortools.pdlp.ConvergenceInformation.Builder com.google.ortools.pdlp.IterationStats.Builder.addConvergenceInformationBuilder ( 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;

Definition at line 1571 of file IterationStats.java.

◆ addInfeasibilityInformation() [1/4]

Builder com.google.ortools.pdlp.IterationStats.Builder.addInfeasibilityInformation ( com.google.ortools.pdlp.InfeasibilityInformation value)
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;

Definition at line 1716 of file IterationStats.java.

◆ addInfeasibilityInformation() [2/4]

Builder com.google.ortools.pdlp.IterationStats.Builder.addInfeasibilityInformation ( com.google.ortools.pdlp.InfeasibilityInformation.Builder builderForValue)
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;

Definition at line 1761 of file IterationStats.java.

◆ addInfeasibilityInformation() [3/4]

Builder com.google.ortools.pdlp.IterationStats.Builder.addInfeasibilityInformation ( int index,
com.google.ortools.pdlp.InfeasibilityInformation value )
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;

Definition at line 1738 of file IterationStats.java.

◆ addInfeasibilityInformation() [4/4]

Builder com.google.ortools.pdlp.IterationStats.Builder.addInfeasibilityInformation ( int index,
com.google.ortools.pdlp.InfeasibilityInformation.Builder builderForValue )
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;

Definition at line 1781 of file IterationStats.java.

◆ addInfeasibilityInformationBuilder() [1/2]

com.google.ortools.pdlp.InfeasibilityInformation.Builder com.google.ortools.pdlp.IterationStats.Builder.addInfeasibilityInformationBuilder ( )
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;

Definition at line 1906 of file IterationStats.java.

◆ addInfeasibilityInformationBuilder() [2/2]

com.google.ortools.pdlp.InfeasibilityInformation.Builder com.google.ortools.pdlp.IterationStats.Builder.addInfeasibilityInformationBuilder ( 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;

Definition at line 1919 of file IterationStats.java.

◆ addPointMetadata() [1/4]

Builder com.google.ortools.pdlp.IterationStats.Builder.addPointMetadata ( com.google.ortools.pdlp.PointMetadata value)
Auxiliary statistics for each type of point.

repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

Definition at line 2052 of file IterationStats.java.

◆ addPointMetadata() [2/4]

Builder com.google.ortools.pdlp.IterationStats.Builder.addPointMetadata ( com.google.ortools.pdlp.PointMetadata.Builder builderForValue)
Auxiliary statistics for each type of point.

repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

Definition at line 2093 of file IterationStats.java.

◆ addPointMetadata() [3/4]

Builder com.google.ortools.pdlp.IterationStats.Builder.addPointMetadata ( int index,
com.google.ortools.pdlp.PointMetadata value )
Auxiliary statistics for each type of point.

repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

Definition at line 2072 of file IterationStats.java.

◆ addPointMetadata() [4/4]

Builder com.google.ortools.pdlp.IterationStats.Builder.addPointMetadata ( int index,
com.google.ortools.pdlp.PointMetadata.Builder builderForValue )
Auxiliary statistics for each type of point.

repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

Definition at line 2111 of file IterationStats.java.

◆ addPointMetadataBuilder() [1/2]

com.google.ortools.pdlp.PointMetadata.Builder com.google.ortools.pdlp.IterationStats.Builder.addPointMetadataBuilder ( )
Auxiliary statistics for each type of point.

repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

Definition at line 2222 of file IterationStats.java.

◆ addPointMetadataBuilder() [2/2]

com.google.ortools.pdlp.PointMetadata.Builder com.google.ortools.pdlp.IterationStats.Builder.addPointMetadataBuilder ( int index)
Auxiliary statistics for each type of point.

repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

Definition at line 2233 of file IterationStats.java.

◆ build()

com.google.ortools.pdlp.IterationStats com.google.ortools.pdlp.IterationStats.Builder.build ( )

Definition at line 872 of file IterationStats.java.

◆ buildPartial()

com.google.ortools.pdlp.IterationStats com.google.ortools.pdlp.IterationStats.Builder.buildPartial ( )

Definition at line 881 of file IterationStats.java.

◆ clear()

Builder com.google.ortools.pdlp.IterationStats.Builder.clear ( )

Definition at line 826 of file IterationStats.java.

◆ clearConvergenceInformation()

Builder com.google.ortools.pdlp.IterationStats.Builder.clearConvergenceInformation ( )
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;

Definition at line 1474 of file IterationStats.java.

◆ clearCumulativeKktMatrixPasses()

Builder com.google.ortools.pdlp.IterationStats.Builder.clearCumulativeKktMatrixPasses ( )
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
This builder for chaining.

Definition at line 2345 of file IterationStats.java.

◆ clearCumulativeRejectedSteps()

Builder com.google.ortools.pdlp.IterationStats.Builder.clearCumulativeRejectedSteps ( )
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
This builder for chaining.

Definition at line 2405 of file IterationStats.java.

◆ clearCumulativeTimeSec()

Builder com.google.ortools.pdlp.IterationStats.Builder.clearCumulativeTimeSec ( )
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
This builder for chaining.

Definition at line 2465 of file IterationStats.java.

◆ clearInfeasibilityInformation()

Builder com.google.ortools.pdlp.IterationStats.Builder.clearInfeasibilityInformation ( )
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;

Definition at line 1822 of file IterationStats.java.

◆ clearIterationNumber()

Builder com.google.ortools.pdlp.IterationStats.Builder.clearIterationNumber ( )
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
This builder for chaining.

Definition at line 1249 of file IterationStats.java.

◆ clearPointMetadata()

Builder com.google.ortools.pdlp.IterationStats.Builder.clearPointMetadata ( )
Auxiliary statistics for each type of point.

repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

Definition at line 2148 of file IterationStats.java.

◆ clearPrimalWeight()

Builder com.google.ortools.pdlp.IterationStats.Builder.clearPrimalWeight ( )
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
This builder for chaining.

Definition at line 2651 of file IterationStats.java.

◆ clearRestartUsed()

Builder com.google.ortools.pdlp.IterationStats.Builder.clearRestartUsed ( )
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
This builder for chaining.

Definition at line 2527 of file IterationStats.java.

◆ clearStepSize()

Builder com.google.ortools.pdlp.IterationStats.Builder.clearStepSize ( )
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
This builder for chaining.

Definition at line 2591 of file IterationStats.java.

◆ getConvergenceInformation()

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

Implements com.google.ortools.pdlp.IterationStatsOrBuilder.

Definition at line 1309 of file IterationStats.java.

◆ getConvergenceInformationBuilder()

com.google.ortools.pdlp.ConvergenceInformation.Builder com.google.ortools.pdlp.IterationStats.Builder.getConvergenceInformationBuilder ( 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;

Definition at line 1512 of file IterationStats.java.

◆ getConvergenceInformationBuilderList()

java.util.List< com.google.ortools.pdlp.ConvergenceInformation.Builder > com.google.ortools.pdlp.IterationStats.Builder.getConvergenceInformationBuilderList ( )
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;

Definition at line 1586 of file IterationStats.java.

◆ getConvergenceInformationCount()

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

Implements com.google.ortools.pdlp.IterationStatsOrBuilder.

Definition at line 1293 of file IterationStats.java.

◆ getConvergenceInformationList()

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

Implements com.google.ortools.pdlp.IterationStatsOrBuilder.

Definition at line 1277 of file IterationStats.java.

◆ getConvergenceInformationOrBuilder()

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

Implements com.google.ortools.pdlp.IterationStatsOrBuilder.

Definition at line 1525 of file IterationStats.java.

◆ getConvergenceInformationOrBuilderList()

java.util.List<? extends com.google.ortools.pdlp.ConvergenceInformationOrBuilder > com.google.ortools.pdlp.IterationStats.Builder.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;

Implements com.google.ortools.pdlp.IterationStatsOrBuilder.

Definition at line 1542 of file IterationStats.java.

◆ getCumulativeKktMatrixPasses()

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

Implements com.google.ortools.pdlp.IterationStatsOrBuilder.

Definition at line 2302 of file IterationStats.java.

◆ getCumulativeRejectedSteps()

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

Implements com.google.ortools.pdlp.IterationStatsOrBuilder.

Definition at line 2376 of file IterationStats.java.

◆ getCumulativeTimeSec()

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

Implements com.google.ortools.pdlp.IterationStatsOrBuilder.

Definition at line 2436 of file IterationStats.java.

◆ getDefaultInstanceForType()

com.google.ortools.pdlp.IterationStats com.google.ortools.pdlp.IterationStats.Builder.getDefaultInstanceForType ( )

Definition at line 867 of file IterationStats.java.

◆ getDescriptor()

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

Definition at line 803 of file IterationStats.java.

◆ getDescriptorForType()

com.google.protobuf.Descriptors.Descriptor com.google.ortools.pdlp.IterationStats.Builder.getDescriptorForType ( )

Definition at line 862 of file IterationStats.java.

◆ getInfeasibilityInformation()

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

Implements com.google.ortools.pdlp.IterationStatsOrBuilder.

Definition at line 1657 of file IterationStats.java.

◆ getInfeasibilityInformationBuilder()

com.google.ortools.pdlp.InfeasibilityInformation.Builder com.google.ortools.pdlp.IterationStats.Builder.getInfeasibilityInformationBuilder ( 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;

Definition at line 1860 of file IterationStats.java.

◆ getInfeasibilityInformationBuilderList()

java.util.List< com.google.ortools.pdlp.InfeasibilityInformation.Builder > com.google.ortools.pdlp.IterationStats.Builder.getInfeasibilityInformationBuilderList ( )
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;

Definition at line 1934 of file IterationStats.java.

◆ getInfeasibilityInformationCount()

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

Implements com.google.ortools.pdlp.IterationStatsOrBuilder.

Definition at line 1641 of file IterationStats.java.

◆ getInfeasibilityInformationList()

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

Implements com.google.ortools.pdlp.IterationStatsOrBuilder.

Definition at line 1625 of file IterationStats.java.

◆ getInfeasibilityInformationOrBuilder()

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

Implements com.google.ortools.pdlp.IterationStatsOrBuilder.

Definition at line 1873 of file IterationStats.java.

◆ getInfeasibilityInformationOrBuilderList()

java.util.List<? extends com.google.ortools.pdlp.InfeasibilityInformationOrBuilder > com.google.ortools.pdlp.IterationStats.Builder.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;

Implements com.google.ortools.pdlp.IterationStatsOrBuilder.

Definition at line 1890 of file IterationStats.java.

◆ getIterationNumber()

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

Implements com.google.ortools.pdlp.IterationStatsOrBuilder.

Definition at line 1216 of file IterationStats.java.

◆ getPointMetadata()

com.google.ortools.pdlp.PointMetadata com.google.ortools.pdlp.IterationStats.Builder.getPointMetadata ( int index)
Auxiliary statistics for each type of point.

repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

Implements com.google.ortools.pdlp.IterationStatsOrBuilder.

Definition at line 1999 of file IterationStats.java.

◆ getPointMetadataBuilder()

com.google.ortools.pdlp.PointMetadata.Builder com.google.ortools.pdlp.IterationStats.Builder.getPointMetadataBuilder ( int index)
Auxiliary statistics for each type of point.

repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

Definition at line 2182 of file IterationStats.java.

◆ getPointMetadataBuilderList()

java.util.List< com.google.ortools.pdlp.PointMetadata.Builder > com.google.ortools.pdlp.IterationStats.Builder.getPointMetadataBuilderList ( )
Auxiliary statistics for each type of point.

repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

Definition at line 2246 of file IterationStats.java.

◆ getPointMetadataCount()

int com.google.ortools.pdlp.IterationStats.Builder.getPointMetadataCount ( )
Auxiliary statistics for each type of point.

repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

Implements com.google.ortools.pdlp.IterationStatsOrBuilder.

Definition at line 1985 of file IterationStats.java.

◆ getPointMetadataList()

java.util.List< com.google.ortools.pdlp.PointMetadata > com.google.ortools.pdlp.IterationStats.Builder.getPointMetadataList ( )
Auxiliary statistics for each type of point.

repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

Implements com.google.ortools.pdlp.IterationStatsOrBuilder.

Definition at line 1971 of file IterationStats.java.

◆ getPointMetadataOrBuilder()

com.google.ortools.pdlp.PointMetadataOrBuilder com.google.ortools.pdlp.IterationStats.Builder.getPointMetadataOrBuilder ( int index)
Auxiliary statistics for each type of point.

repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

Implements com.google.ortools.pdlp.IterationStatsOrBuilder.

Definition at line 2193 of file IterationStats.java.

◆ getPointMetadataOrBuilderList()

java.util.List<? extends com.google.ortools.pdlp.PointMetadataOrBuilder > com.google.ortools.pdlp.IterationStats.Builder.getPointMetadataOrBuilderList ( )
Auxiliary statistics for each type of point.

repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

Implements com.google.ortools.pdlp.IterationStatsOrBuilder.

Definition at line 2208 of file IterationStats.java.

◆ getPrimalWeight()

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

Implements com.google.ortools.pdlp.IterationStatsOrBuilder.

Definition at line 2622 of file IterationStats.java.

◆ getRestartUsed()

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

Implements com.google.ortools.pdlp.IterationStatsOrBuilder.

Definition at line 2495 of file IterationStats.java.

◆ getStepSize()

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

Implements com.google.ortools.pdlp.IterationStatsOrBuilder.

Definition at line 2560 of file IterationStats.java.

◆ hasCumulativeKktMatrixPasses()

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

Implements com.google.ortools.pdlp.IterationStatsOrBuilder.

Definition at line 2282 of file IterationStats.java.

◆ hasCumulativeRejectedSteps()

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

Implements com.google.ortools.pdlp.IterationStatsOrBuilder.

Definition at line 2363 of file IterationStats.java.

◆ hasCumulativeTimeSec()

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

Implements com.google.ortools.pdlp.IterationStatsOrBuilder.

Definition at line 2423 of file IterationStats.java.

◆ hasIterationNumber()

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

Implements com.google.ortools.pdlp.IterationStatsOrBuilder.

Definition at line 1201 of file IterationStats.java.

◆ hasPrimalWeight()

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

Implements com.google.ortools.pdlp.IterationStatsOrBuilder.

Definition at line 2609 of file IterationStats.java.

◆ hasRestartUsed()

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

Implements com.google.ortools.pdlp.IterationStatsOrBuilder.

Definition at line 2482 of file IterationStats.java.

◆ hasStepSize()

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

Implements com.google.ortools.pdlp.IterationStatsOrBuilder.

Definition at line 2546 of file IterationStats.java.

◆ internalGetFieldAccessorTable()

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

Definition at line 809 of file IterationStats.java.

◆ isInitialized()

final boolean com.google.ortools.pdlp.IterationStats.Builder.isInitialized ( )

Definition at line 1070 of file IterationStats.java.

◆ mergeFrom() [1/3]

Builder com.google.ortools.pdlp.IterationStats.Builder.mergeFrom ( com.google.ortools.pdlp.IterationStats other)

Definition at line 963 of file IterationStats.java.

◆ mergeFrom() [2/3]

Builder com.google.ortools.pdlp.IterationStats.Builder.mergeFrom ( com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry ) throws java.io.IOException

Definition at line 1075 of file IterationStats.java.

◆ mergeFrom() [3/3]

Builder com.google.ortools.pdlp.IterationStats.Builder.mergeFrom ( com.google.protobuf.Message other)

Definition at line 954 of file IterationStats.java.

◆ removeConvergenceInformation()

Builder com.google.ortools.pdlp.IterationStats.Builder.removeConvergenceInformation ( 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;

Definition at line 1493 of file IterationStats.java.

◆ removeInfeasibilityInformation()

Builder com.google.ortools.pdlp.IterationStats.Builder.removeInfeasibilityInformation ( 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;

Definition at line 1841 of file IterationStats.java.

◆ removePointMetadata()

Builder com.google.ortools.pdlp.IterationStats.Builder.removePointMetadata ( int index)
Auxiliary statistics for each type of point.

repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

Definition at line 2165 of file IterationStats.java.

◆ setConvergenceInformation() [1/2]

Builder com.google.ortools.pdlp.IterationStats.Builder.setConvergenceInformation ( int index,
com.google.ortools.pdlp.ConvergenceInformation value )
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;

Definition at line 1325 of file IterationStats.java.

◆ setConvergenceInformation() [2/2]

Builder com.google.ortools.pdlp.IterationStats.Builder.setConvergenceInformation ( int index,
com.google.ortools.pdlp.ConvergenceInformation.Builder builderForValue )
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;

Definition at line 1348 of file IterationStats.java.

◆ setCumulativeKktMatrixPasses()

Builder com.google.ortools.pdlp.IterationStats.Builder.setCumulativeKktMatrixPasses ( double value)
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;

Parameters
valueThe cumulativeKktMatrixPasses to set.
Returns
This builder for chaining.

Definition at line 2322 of file IterationStats.java.

◆ setCumulativeRejectedSteps()

Builder com.google.ortools.pdlp.IterationStats.Builder.setCumulativeRejectedSteps ( int value)
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;

Parameters
valueThe cumulativeRejectedSteps to set.
Returns
This builder for chaining.

Definition at line 2389 of file IterationStats.java.

◆ setCumulativeTimeSec()

Builder com.google.ortools.pdlp.IterationStats.Builder.setCumulativeTimeSec ( double value)
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;

Parameters
valueThe cumulativeTimeSec to set.
Returns
This builder for chaining.

Definition at line 2449 of file IterationStats.java.

◆ setInfeasibilityInformation() [1/2]

Builder com.google.ortools.pdlp.IterationStats.Builder.setInfeasibilityInformation ( int index,
com.google.ortools.pdlp.InfeasibilityInformation value )
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;

Definition at line 1673 of file IterationStats.java.

◆ setInfeasibilityInformation() [2/2]

Builder com.google.ortools.pdlp.IterationStats.Builder.setInfeasibilityInformation ( int index,
com.google.ortools.pdlp.InfeasibilityInformation.Builder builderForValue )
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;

Definition at line 1696 of file IterationStats.java.

◆ setIterationNumber()

Builder com.google.ortools.pdlp.IterationStats.Builder.setIterationNumber ( int value)
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;

Parameters
valueThe iterationNumber to set.
Returns
This builder for chaining.

Definition at line 1231 of file IterationStats.java.

◆ setPointMetadata() [1/2]

Builder com.google.ortools.pdlp.IterationStats.Builder.setPointMetadata ( int index,
com.google.ortools.pdlp.PointMetadata value )
Auxiliary statistics for each type of point.

repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

Definition at line 2013 of file IterationStats.java.

◆ setPointMetadata() [2/2]

Builder com.google.ortools.pdlp.IterationStats.Builder.setPointMetadata ( int index,
com.google.ortools.pdlp.PointMetadata.Builder builderForValue )
Auxiliary statistics for each type of point.

repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

Definition at line 2034 of file IterationStats.java.

◆ setPrimalWeight()

Builder com.google.ortools.pdlp.IterationStats.Builder.setPrimalWeight ( double value)
Primal weight controlling the relation between primal and dual step sizes.
See field 'step_size' for a detailed description.

optional double primal_weight = 9;

Parameters
valueThe primalWeight to set.
Returns
This builder for chaining.

Definition at line 2635 of file IterationStats.java.

◆ setRestartUsed()

Builder com.google.ortools.pdlp.IterationStats.Builder.setRestartUsed ( com.google.ortools.pdlp.RestartChoice value)
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;

Parameters
valueThe restartUsed to set.
Returns
This builder for chaining.

Definition at line 2509 of file IterationStats.java.

◆ setStepSize()

Builder com.google.ortools.pdlp.IterationStats.Builder.setStepSize ( double value)
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;

Parameters
valueThe stepSize to set.
Returns
This builder for chaining.

Definition at line 2574 of file IterationStats.java.


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