public interface IterationStatsOrBuilder
extends com.google.protobuf.MessageOrBuilder
Modifier and Type | Method and Description |
---|---|
ConvergenceInformation |
getConvergenceInformation(int index)
A set of statistics measuring how close a point is to establishing primal
and dual feasibility and optimality.
|
int |
getConvergenceInformationCount()
A set of statistics measuring how close a point is to establishing primal
and dual feasibility and optimality.
|
java.util.List<ConvergenceInformation> |
getConvergenceInformationList()
A set of statistics measuring how close a point is to establishing primal
and dual feasibility and optimality.
|
ConvergenceInformationOrBuilder |
getConvergenceInformationOrBuilder(int index)
A set of statistics measuring how close a point is to establishing primal
and dual feasibility and optimality.
|
java.util.List<? extends ConvergenceInformationOrBuilder> |
getConvergenceInformationOrBuilderList()
A set of statistics measuring how close a point is to establishing primal
and dual feasibility and optimality.
|
double |
getCumulativeKktMatrixPasses()
The cumulative number of passes through the KKT matrix since the start of
the solve.
|
int |
getCumulativeRejectedSteps()
The total number of rejected steps (e.g., within a line search procedure)
since the start of the solve.
|
double |
getCumulativeTimeSec()
The amount of time passed since we started solving the problem (see solver
log `solve_time_sec` which records total time).
|
InfeasibilityInformation |
getInfeasibilityInformation(int index)
A set of statistics measuring how close a point is to establishing primal
or dual infeasibility (i.e., has no solution).
|
int |
getInfeasibilityInformationCount()
A set of statistics measuring how close a point is to establishing primal
or dual infeasibility (i.e., has no solution).
|
java.util.List<InfeasibilityInformation> |
getInfeasibilityInformationList()
A set of statistics measuring how close a point is to establishing primal
or dual infeasibility (i.e., has no solution).
|
InfeasibilityInformationOrBuilder |
getInfeasibilityInformationOrBuilder(int index)
A set of statistics measuring how close a point is to establishing primal
or dual infeasibility (i.e., has no solution).
|
java.util.List<? extends InfeasibilityInformationOrBuilder> |
getInfeasibilityInformationOrBuilderList()
A set of statistics measuring how close a point is to establishing primal
or dual infeasibility (i.e., has no solution).
|
int |
getIterationNumber()
The iteration number at which these stats were recorded.
|
PointMetadata |
getPointMetadata(int index)
Auxiliary statistics for each type of point.
|
int |
getPointMetadataCount()
Auxiliary statistics for each type of point.
|
java.util.List<PointMetadata> |
getPointMetadataList()
Auxiliary statistics for each type of point.
|
PointMetadataOrBuilder |
getPointMetadataOrBuilder(int index)
Auxiliary statistics for each type of point.
|
java.util.List<? extends PointMetadataOrBuilder> |
getPointMetadataOrBuilderList()
Auxiliary statistics for each type of point.
|
double |
getPrimalWeight()
Primal weight controlling the relation between primal and dual step sizes.
|
RestartChoice |
getRestartUsed()
The kind of restart that occurred at this iteration, or NO_RESTART if a
restart did not occur.
|
double |
getStepSize()
Step size used at this iteration.
|
boolean |
hasCumulativeKktMatrixPasses()
The cumulative number of passes through the KKT matrix since the start of
the solve.
|
boolean |
hasCumulativeRejectedSteps()
The total number of rejected steps (e.g., within a line search procedure)
since the start of the solve.
|
boolean |
hasCumulativeTimeSec()
The amount of time passed since we started solving the problem (see solver
log `solve_time_sec` which records total time).
|
boolean |
hasIterationNumber()
The iteration number at which these stats were recorded.
|
boolean |
hasPrimalWeight()
Primal weight controlling the relation between primal and dual step sizes.
|
boolean |
hasRestartUsed()
The kind of restart that occurred at this iteration, or NO_RESTART if a
restart did not occur.
|
boolean |
hasStepSize()
Step size used at this iteration.
|
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
boolean 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;
int 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;
java.util.List<ConvergenceInformation> 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;
ConvergenceInformation 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;
int 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;
java.util.List<? extends ConvergenceInformationOrBuilder> 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;
ConvergenceInformationOrBuilder 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;
java.util.List<InfeasibilityInformation> 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;
InfeasibilityInformation 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;
int 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;
java.util.List<? extends InfeasibilityInformationOrBuilder> 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;
InfeasibilityInformationOrBuilder 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;
java.util.List<PointMetadata> getPointMetadataList()
Auxiliary statistics for each type of point.
repeated .operations_research.pdlp.PointMetadata point_metadata = 11;
PointMetadata getPointMetadata(int index)
Auxiliary statistics for each type of point.
repeated .operations_research.pdlp.PointMetadata point_metadata = 11;
int getPointMetadataCount()
Auxiliary statistics for each type of point.
repeated .operations_research.pdlp.PointMetadata point_metadata = 11;
java.util.List<? extends PointMetadataOrBuilder> getPointMetadataOrBuilderList()
Auxiliary statistics for each type of point.
repeated .operations_research.pdlp.PointMetadata point_metadata = 11;
PointMetadataOrBuilder getPointMetadataOrBuilder(int index)
Auxiliary statistics for each type of point.
repeated .operations_research.pdlp.PointMetadata point_metadata = 11;
boolean 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;
double 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;
boolean 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;
int 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;
boolean 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;
double 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;
boolean 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;
RestartChoice 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;
boolean 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;
double 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;
boolean 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;
double 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;
Copyright © 2025. All rights reserved.