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

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessage.Builder<IterationStats.Builder>
    - - com.google.ortools.pdlp.IterationStats.Builder

All Implemented Interfaces:: IterationStatsOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable

Enclosing class:: IterationStats

public static final class IterationStats.Builder
extends com.google.protobuf.GeneratedMessage.Builder<IterationStats.Builder>
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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IterationStats.Builder`	`addAllConvergenceInformation(java.lang.Iterable<? extends ConvergenceInformation> values)` A set of statistics measuring how close a point is to establishing primal and dual feasibility and optimality.
`IterationStats.Builder`	`addAllInfeasibilityInformation(java.lang.Iterable<? extends InfeasibilityInformation> values)` A set of statistics measuring how close a point is to establishing primal or dual infeasibility (i.e., has no solution).
`IterationStats.Builder`	`addAllPointMetadata(java.lang.Iterable<? extends PointMetadata> values)` Auxiliary statistics for each type of point.
`IterationStats.Builder`	`addConvergenceInformation(ConvergenceInformation.Builder builderForValue)` A set of statistics measuring how close a point is to establishing primal and dual feasibility and optimality.
`IterationStats.Builder`	`addConvergenceInformation(ConvergenceInformation value)` A set of statistics measuring how close a point is to establishing primal and dual feasibility and optimality.
`IterationStats.Builder`	`addConvergenceInformation(int index, ConvergenceInformation.Builder builderForValue)` A set of statistics measuring how close a point is to establishing primal and dual feasibility and optimality.
`IterationStats.Builder`	`addConvergenceInformation(int index, ConvergenceInformation value)` A set of statistics measuring how close a point is to establishing primal and dual feasibility and optimality.
`ConvergenceInformation.Builder`	`addConvergenceInformationBuilder()` A set of statistics measuring how close a point is to establishing primal and dual feasibility and optimality.
`ConvergenceInformation.Builder`	`addConvergenceInformationBuilder(int index)` A set of statistics measuring how close a point is to establishing primal and dual feasibility and optimality.
`IterationStats.Builder`	`addInfeasibilityInformation(InfeasibilityInformation.Builder builderForValue)` A set of statistics measuring how close a point is to establishing primal or dual infeasibility (i.e., has no solution).
`IterationStats.Builder`	`addInfeasibilityInformation(InfeasibilityInformation value)` A set of statistics measuring how close a point is to establishing primal or dual infeasibility (i.e., has no solution).
`IterationStats.Builder`	`addInfeasibilityInformation(int index, InfeasibilityInformation.Builder builderForValue)` A set of statistics measuring how close a point is to establishing primal or dual infeasibility (i.e., has no solution).
`IterationStats.Builder`	`addInfeasibilityInformation(int index, InfeasibilityInformation value)` A set of statistics measuring how close a point is to establishing primal or dual infeasibility (i.e., has no solution).
`InfeasibilityInformation.Builder`	`addInfeasibilityInformationBuilder()` A set of statistics measuring how close a point is to establishing primal or dual infeasibility (i.e., has no solution).
`InfeasibilityInformation.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).
`IterationStats.Builder`	`addPointMetadata(int index, PointMetadata.Builder builderForValue)` Auxiliary statistics for each type of point.
`IterationStats.Builder`	`addPointMetadata(int index, PointMetadata value)` Auxiliary statistics for each type of point.
`IterationStats.Builder`	`addPointMetadata(PointMetadata.Builder builderForValue)` Auxiliary statistics for each type of point.
`IterationStats.Builder`	`addPointMetadata(PointMetadata value)` Auxiliary statistics for each type of point.
`PointMetadata.Builder`	`addPointMetadataBuilder()` Auxiliary statistics for each type of point.
`PointMetadata.Builder`	`addPointMetadataBuilder(int index)` Auxiliary statistics for each type of point.
`IterationStats`	`build()`
`IterationStats`	`buildPartial()`
`IterationStats.Builder`	`clear()`
`IterationStats.Builder`	`clearConvergenceInformation()` A set of statistics measuring how close a point is to establishing primal and dual feasibility and optimality.
`IterationStats.Builder`	`clearCumulativeKktMatrixPasses()` The cumulative number of passes through the KKT matrix since the start of the solve.
`IterationStats.Builder`	`clearCumulativeRejectedSteps()` The total number of rejected steps (e.g., within a line search procedure) since the start of the solve.
`IterationStats.Builder`	`clearCumulativeTimeSec()` The amount of time passed since we started solving the problem (see solver log `solve_time_sec` which records total time).
`IterationStats.Builder`	`clearInfeasibilityInformation()` A set of statistics measuring how close a point is to establishing primal or dual infeasibility (i.e., has no solution).
`IterationStats.Builder`	`clearIterationNumber()` The iteration number at which these stats were recorded.
`IterationStats.Builder`	`clearPointMetadata()` Auxiliary statistics for each type of point.
`IterationStats.Builder`	`clearPrimalWeight()` Primal weight controlling the relation between primal and dual step sizes.
`IterationStats.Builder`	`clearRestartUsed()` The kind of restart that occurred at this iteration, or NO_RESTART if a restart did not occur.
`IterationStats.Builder`	`clearStepSize()` Step size used at this iteration.
`ConvergenceInformation`	`getConvergenceInformation(int index)` A set of statistics measuring how close a point is to establishing primal and dual feasibility and optimality.
`ConvergenceInformation.Builder`	`getConvergenceInformationBuilder(int index)` A set of statistics measuring how close a point is to establishing primal and dual feasibility and optimality.
`java.util.List<ConvergenceInformation.Builder>`	`getConvergenceInformationBuilderList()` 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).
`IterationStats`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`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).
`InfeasibilityInformation.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).
`java.util.List<InfeasibilityInformation.Builder>`	`getInfeasibilityInformationBuilderList()` 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.
`PointMetadata.Builder`	`getPointMetadataBuilder(int index)` Auxiliary statistics for each type of point.
`java.util.List<PointMetadata.Builder>`	`getPointMetadataBuilderList()` 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.
`protected com.google.protobuf.GeneratedMessage.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`IterationStats.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`IterationStats.Builder`	`mergeFrom(IterationStats other)`
`IterationStats.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`IterationStats.Builder`	`removeConvergenceInformation(int index)` A set of statistics measuring how close a point is to establishing primal and dual feasibility and optimality.
`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).
`IterationStats.Builder`	`removePointMetadata(int index)` Auxiliary statistics for each type of point.
`IterationStats.Builder`	`setConvergenceInformation(int index, ConvergenceInformation.Builder builderForValue)` A set of statistics measuring how close a point is to establishing primal and dual feasibility and optimality.
`IterationStats.Builder`	`setConvergenceInformation(int index, ConvergenceInformation value)` A set of statistics measuring how close a point is to establishing primal and dual feasibility and optimality.
`IterationStats.Builder`	`setCumulativeKktMatrixPasses(double value)` The cumulative number of passes through the KKT matrix since the start of the solve.
`IterationStats.Builder`	`setCumulativeRejectedSteps(int value)` The total number of rejected steps (e.g., within a line search procedure) since the start of the solve.
`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).
`IterationStats.Builder`	`setInfeasibilityInformation(int index, InfeasibilityInformation.Builder builderForValue)` A set of statistics measuring how close a point is to establishing primal or dual infeasibility (i.e., has no solution).
`IterationStats.Builder`	`setInfeasibilityInformation(int index, InfeasibilityInformation value)` A set of statistics measuring how close a point is to establishing primal or dual infeasibility (i.e., has no solution).
`IterationStats.Builder`	`setIterationNumber(int value)` The iteration number at which these stats were recorded.
`IterationStats.Builder`	`setPointMetadata(int index, PointMetadata.Builder builderForValue)` Auxiliary statistics for each type of point.
`IterationStats.Builder`	`setPointMetadata(int index, PointMetadata value)` Auxiliary statistics for each type of point.
`IterationStats.Builder`	`setPrimalWeight(double value)` Primal weight controlling the relation between primal and dual step sizes.
`IterationStats.Builder`	`setRestartUsed(RestartChoice value)` The kind of restart that occurred at this iteration, or NO_RESTART if a restart did not occur.
`IterationStats.Builder`	`setStepSize(double value)` Step size used at this iteration.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

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

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

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

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.Builder<IterationStats.Builder>

clear
```
public IterationStats.Builder clear()
```
Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<IterationStats.Builder>

getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<IterationStats.Builder>

getDefaultInstanceForType
```
public IterationStats getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public IterationStats build()
```
Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial
```
public IterationStats buildPartial()
```
Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom
```
public IterationStats.Builder mergeFrom(com.google.protobuf.Message other)
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<IterationStats.Builder>

mergeFrom

public IterationStats.Builder mergeFrom(IterationStats other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<IterationStats.Builder>

mergeFrom
```
public IterationStats.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws java.io.IOException
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<IterationStats.Builder>

Throws:

java.io.IOException

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.

setIterationNumber

public 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:: value - The iterationNumber to set.
Returns:: This builder for chaining.

clearIterationNumber

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