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 20 of file IterationStats.java.

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

Classes
class	Builder

Public Member Functions
boolean	hasIterationNumber ()
int	getIterationNumber ()
java.util.List< com.google.ortools.pdlp.ConvergenceInformation >	getConvergenceInformationList ()
java.util.List<? extends com.google.ortools.pdlp.ConvergenceInformationOrBuilder >	getConvergenceInformationOrBuilderList ()
int	getConvergenceInformationCount ()
com.google.ortools.pdlp.ConvergenceInformation	getConvergenceInformation (int index)
com.google.ortools.pdlp.ConvergenceInformationOrBuilder	getConvergenceInformationOrBuilder (int index)
java.util.List< com.google.ortools.pdlp.InfeasibilityInformation >	getInfeasibilityInformationList ()
java.util.List<? extends com.google.ortools.pdlp.InfeasibilityInformationOrBuilder >	getInfeasibilityInformationOrBuilderList ()
int	getInfeasibilityInformationCount ()
com.google.ortools.pdlp.InfeasibilityInformation	getInfeasibilityInformation (int index)
com.google.ortools.pdlp.InfeasibilityInformationOrBuilder	getInfeasibilityInformationOrBuilder (int index)
java.util.List< com.google.ortools.pdlp.PointMetadata >	getPointMetadataList ()
java.util.List<? extends com.google.ortools.pdlp.PointMetadataOrBuilder >	getPointMetadataOrBuilderList ()
int	getPointMetadataCount ()
com.google.ortools.pdlp.PointMetadata	getPointMetadata (int index)
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 ()
final boolean	isInitialized ()
void	writeTo (com.google.protobuf.CodedOutputStream output) throws java.io.IOException
int	getSerializedSize ()
boolean	equals (final java.lang.Object obj)
int	hashCode ()
Builder	newBuilderForType ()
Builder	toBuilder ()
com.google.protobuf.Parser< IterationStats >	getParserForType ()
com.google.ortools.pdlp.IterationStats	getDefaultInstanceForType ()

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

Static Public Attributes
static final int	ITERATION_NUMBER_FIELD_NUMBER = 1
static final int	CONVERGENCE_INFORMATION_FIELD_NUMBER = 2
static final int	INFEASIBILITY_INFORMATION_FIELD_NUMBER = 3
static final int	POINT_METADATA_FIELD_NUMBER = 11
static final int	CUMULATIVE_KKT_MATRIX_PASSES_FIELD_NUMBER = 4
static final int	CUMULATIVE_REJECTED_STEPS_FIELD_NUMBER = 5
static final int	CUMULATIVE_TIME_SEC_FIELD_NUMBER = 6
static final int	RESTART_USED_FIELD_NUMBER = 7
static final int	STEP_SIZE_FIELD_NUMBER = 8
static final int	PRIMAL_WEIGHT_FIELD_NUMBER = 9

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

Member Function Documentation

◆ equals()

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

Definition at line 583 of file IterationStats.java.

◆ getConvergenceInformation()

com.google.ortools.pdlp.ConvergenceInformation com.google.ortools.pdlp.IterationStats.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 145 of file IterationStats.java.

◆ getConvergenceInformationCount()

int com.google.ortools.pdlp.IterationStats.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 132 of file IterationStats.java.

◆ getConvergenceInformationList()

java.util.List< com.google.ortools.pdlp.ConvergenceInformation > com.google.ortools.pdlp.IterationStats.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 105 of file IterationStats.java.

◆ getConvergenceInformationOrBuilder()

com.google.ortools.pdlp.ConvergenceInformationOrBuilder com.google.ortools.pdlp.IterationStats.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 158 of file IterationStats.java.

◆ getConvergenceInformationOrBuilderList()

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

◆ getCumulativeKktMatrixPasses()

double com.google.ortools.pdlp.IterationStats.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 334 of file IterationStats.java.

◆ getCumulativeRejectedSteps()

int com.google.ortools.pdlp.IterationStats.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 363 of file IterationStats.java.

◆ getCumulativeTimeSec()

double com.google.ortools.pdlp.IterationStats.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 392 of file IterationStats.java.

◆ getDefaultInstance()

com.google.ortools.pdlp.IterationStats com.google.ortools.pdlp.IterationStats.getDefaultInstance ( )

static

Definition at line 2666 of file IterationStats.java.

◆ getDefaultInstanceForType()

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

Definition at line 2702 of file IterationStats.java.

◆ getDescriptor()

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

static

Definition at line 46 of file IterationStats.java.

◆ getInfeasibilityInformation()

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