IterationStats (com.google.ortools:ortools-java 9.12.9999 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessage
    - - com.google.ortools.pdlp.IterationStats

All Implemented Interfaces:: IterationStatsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable

public final class IterationStats
extends com.google.protobuf.GeneratedMessage
implements IterationStatsOrBuilder

 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

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`IterationStats.Builder` All values in IterationStats assume that the primal quadratic program is a minimization problem and the dual is a maximization problem.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CONVERGENCE_INFORMATION_FIELD_NUMBER`
`static int`	`CUMULATIVE_KKT_MATRIX_PASSES_FIELD_NUMBER`
`static int`	`CUMULATIVE_REJECTED_STEPS_FIELD_NUMBER`
`static int`	`CUMULATIVE_TIME_SEC_FIELD_NUMBER`
`static int`	`INFEASIBILITY_INFORMATION_FIELD_NUMBER`
`static int`	`ITERATION_NUMBER_FIELD_NUMBER`
`static int`	`POINT_METADATA_FIELD_NUMBER`
`static int`	`PRIMAL_WEIGHT_FIELD_NUMBER`
`static int`	`RESTART_USED_FIELD_NUMBER`
`static int`	`STEP_SIZE_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`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).
`static IterationStats`	`getDefaultInstance()`
`IterationStats`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`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.
`com.google.protobuf.Parser<IterationStats>`	`getParserForType()`
`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.
`int`	`getSerializedSize()`
`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).
`int`	`hashCode()`
`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.
`protected com.google.protobuf.GeneratedMessage.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static IterationStats.Builder`	`newBuilder()`
`static IterationStats.Builder`	`newBuilder(IterationStats prototype)`
`IterationStats.Builder`	`newBuilderForType()`
`protected IterationStats.Builder`	`newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)`
`static IterationStats`	`parseDelimitedFrom(java.io.InputStream input)`
`static IterationStats`	`parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static IterationStats`	`parseFrom(byte[] data)`
`static IterationStats`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static IterationStats`	`parseFrom(java.nio.ByteBuffer data)`
`static IterationStats`	`parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static IterationStats`	`parseFrom(com.google.protobuf.ByteString data)`
`static IterationStats`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static IterationStats`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static IterationStats`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static IterationStats`	`parseFrom(java.io.InputStream input)`
`static IterationStats`	`parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<IterationStats>`	`parser()`
`IterationStats.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- ITERATION_NUMBER_FIELD_NUMBER
```
public static final int ITERATION_NUMBER_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CONVERGENCE_INFORMATION_FIELD_NUMBER
```
public static final int CONVERGENCE_INFORMATION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- INFEASIBILITY_INFORMATION_FIELD_NUMBER
```
public static final int INFEASIBILITY_INFORMATION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- POINT_METADATA_FIELD_NUMBER
```
public static final int POINT_METADATA_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CUMULATIVE_KKT_MATRIX_PASSES_FIELD_NUMBER
```
public static final int CUMULATIVE_KKT_MATRIX_PASSES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CUMULATIVE_REJECTED_STEPS_FIELD_NUMBER
```
public static final int CUMULATIVE_REJECTED_STEPS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CUMULATIVE_TIME_SEC_FIELD_NUMBER
```
public static final int CUMULATIVE_TIME_SEC_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- RESTART_USED_FIELD_NUMBER
```
public static final int RESTART_USED_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- STEP_SIZE_FIELD_NUMBER
```
public static final int STEP_SIZE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PRIMAL_WEIGHT_FIELD_NUMBER
```
public static final int PRIMAL_WEIGHT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

getDescriptor

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

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

hasIterationNumber

public 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;

Specified by:: hasIterationNumber in interface IterationStatsOrBuilder
Returns:: Whether the iterationNumber field is set.

getIterationNumber

public 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;

Specified by:: getIterationNumber in interface IterationStatsOrBuilder
Returns:: The iterationNumber.