Class IterationStats.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<IterationStats.Builder>
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, 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 Details

    • 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 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:
      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.

    • getConvergenceInformationList

      public 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;
      Specified by:
      getConvergenceInformationList in interface IterationStatsOrBuilder

    • getConvergenceInformationCount

      public 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;
      Specified by:
      getConvergenceInformationCount in interface IterationStatsOrBuilder

    • getConvergenceInformation

      public 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;
      Specified by:
      getConvergenceInformation in interface IterationStatsOrBuilder

    • setConvergenceInformation

      public 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. This field is repeated since there
 might be several different points that are considered.
      repeated .operations_research.pdlp.ConvergenceInformation convergence_information = 2;

    • setConvergenceInformation

      public 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. This field is repeated since there
 might be several different points that are considered.
      repeated .operations_research.pdlp.ConvergenceInformation convergence_information = 2;

    • addConvergenceInformation

      public IterationStats.Builder addConvergenceInformation(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;

    • addConvergenceInformation

      public 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. This field is repeated since there
 might be several different points that are considered.
      repeated .operations_research.pdlp.ConvergenceInformation convergence_information = 2;

    • addConvergenceInformation

      public IterationStats.Builder addConvergenceInformation(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;

    • addConvergenceInformation

      public 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. This field is repeated since there
 might be several different points that are considered.
      repeated .operations_research.pdlp.ConvergenceInformation convergence_information = 2;

    • addAllConvergenceInformation

      public IterationStats.Builder addAllConvergenceInformation(Iterable<? extends 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;

    • clearConvergenceInformation

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

    • removeConvergenceInformation

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

    • getConvergenceInformationBuilder

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

    • getConvergenceInformationOrBuilder

      public 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;
      Specified by:
      getConvergenceInformationOrBuilder in interface IterationStatsOrBuilder

    • getConvergenceInformationOrBuilderList

      public 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;
      Specified by:
      getConvergenceInformationOrBuilderList in interface IterationStatsOrBuilder

    • addConvergenceInformationBuilder

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

    • addConvergenceInformationBuilder

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

    • getConvergenceInformationBuilderList

      public List<ConvergenceInformation.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;

    • getInfeasibilityInformationList

      public 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;
      Specified by:
      getInfeasibilityInformationList in interface IterationStatsOrBuilder

    • getInfeasibilityInformationCount

      public 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;
      Specified by:
      getInfeasibilityInformationCount in interface IterationStatsOrBuilder

    • getInfeasibilityInformation

      public 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;
      Specified by:
      getInfeasibilityInformation in interface IterationStatsOrBuilder

    • setInfeasibilityInformation

      public 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). This field is repeated since
 there might be several different points that could establish infeasibility.
      repeated .operations_research.pdlp.InfeasibilityInformation infeasibility_information = 3;

    • setInfeasibilityInformation

      public 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). This field is repeated since
 there might be several different points that could establish infeasibility.
      repeated .operations_research.pdlp.InfeasibilityInformation infeasibility_information = 3;

    • addInfeasibilityInformation

      public 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). This field is repeated since
 there might be several different points that could establish infeasibility.
      repeated .operations_research.pdlp.InfeasibilityInformation infeasibility_information = 3;

    • addInfeasibilityInformation

      public 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). This field is repeated since
 there might be several different points that could establish infeasibility.
      repeated .operations_research.pdlp.InfeasibilityInformation infeasibility_information = 3;

    • addInfeasibilityInformation

      public 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). This field is repeated since
 there might be several different points that could establish infeasibility.
      repeated .operations_research.pdlp.InfeasibilityInformation infeasibility_information = 3;

    • addInfeasibilityInformation

      public 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). This field is repeated since
 there might be several different points that could establish infeasibility.
      repeated .operations_research.pdlp.InfeasibilityInformation infeasibility_information = 3;

    • addAllInfeasibilityInformation

      public IterationStats.Builder addAllInfeasibilityInformation(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). This field is repeated since
 there might be several different points that could establish infeasibility.
      repeated .operations_research.pdlp.InfeasibilityInformation infeasibility_information = 3;

    • clearInfeasibilityInformation

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

    • removeInfeasibilityInformation

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

    • getInfeasibilityInformationBuilder

      public 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). This field is repeated since
 there might be several different points that could establish infeasibility.
      repeated .operations_research.pdlp.InfeasibilityInformation infeasibility_information = 3;

    • getInfeasibilityInformationOrBuilder

      public 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;
      Specified by:
      getInfeasibilityInformationOrBuilder in interface IterationStatsOrBuilder

    • getInfeasibilityInformationOrBuilderList

      public 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;
      Specified by:
      getInfeasibilityInformationOrBuilderList in interface IterationStatsOrBuilder

    • addInfeasibilityInformationBuilder

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

    • addInfeasibilityInformationBuilder

      public 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). This field is repeated since
 there might be several different points that could establish infeasibility.
      repeated .operations_research.pdlp.InfeasibilityInformation infeasibility_information = 3;

    • getInfeasibilityInformationBuilderList

      public 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). This field is repeated since
 there might be several different points that could establish infeasibility.
      repeated .operations_research.pdlp.InfeasibilityInformation infeasibility_information = 3;

    • getPointMetadataList

      public List<PointMetadata> getPointMetadataList()
       Auxiliary statistics for each type of point.
      repeated .operations_research.pdlp.PointMetadata point_metadata = 11;
      Specified by:
      getPointMetadataList in interface IterationStatsOrBuilder

    • getPointMetadataCount

      public int getPointMetadataCount()
       Auxiliary statistics for each type of point.
      repeated .operations_research.pdlp.PointMetadata point_metadata = 11;
      Specified by:
      getPointMetadataCount in interface IterationStatsOrBuilder

    • getPointMetadata

      public PointMetadata getPointMetadata(int index)
       Auxiliary statistics for each type of point.
      repeated .operations_research.pdlp.PointMetadata point_metadata = 11;
      Specified by:
      getPointMetadata in interface IterationStatsOrBuilder

    • setPointMetadata

      public IterationStats.Builder setPointMetadata(int index, PointMetadata value)
       Auxiliary statistics for each type of point.
      repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

    • setPointMetadata

      public IterationStats.Builder setPointMetadata(int index, PointMetadata.Builder builderForValue)
       Auxiliary statistics for each type of point.
      repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

    • addPointMetadata

      public IterationStats.Builder addPointMetadata(PointMetadata value)
       Auxiliary statistics for each type of point.
      repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

    • addPointMetadata

      public IterationStats.Builder addPointMetadata(int index, PointMetadata value)
       Auxiliary statistics for each type of point.
      repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

    • addPointMetadata

      public IterationStats.Builder addPointMetadata(PointMetadata.Builder builderForValue)
       Auxiliary statistics for each type of point.
      repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

    • addPointMetadata

      public IterationStats.Builder addPointMetadata(int index, PointMetadata.Builder builderForValue)
       Auxiliary statistics for each type of point.
      repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

    • addAllPointMetadata

      public IterationStats.Builder addAllPointMetadata(Iterable<? extends PointMetadata> values)
       Auxiliary statistics for each type of point.
      repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

    • clearPointMetadata

      public IterationStats.Builder clearPointMetadata()
       Auxiliary statistics for each type of point.
      repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

    • removePointMetadata

      public IterationStats.Builder removePointMetadata(int index)
       Auxiliary statistics for each type of point.
      repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

    • getPointMetadataBuilder

      public PointMetadata.Builder getPointMetadataBuilder(int index)
       Auxiliary statistics for each type of point.
      repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

    • getPointMetadataOrBuilder

      public PointMetadataOrBuilder getPointMetadataOrBuilder(int index)
       Auxiliary statistics for each type of point.
      repeated .operations_research.pdlp.PointMetadata point_metadata = 11;
      Specified by:
      getPointMetadataOrBuilder in interface IterationStatsOrBuilder

    • getPointMetadataOrBuilderList

      public List<? extends PointMetadataOrBuilder> getPointMetadataOrBuilderList()
       Auxiliary statistics for each type of point.
      repeated .operations_research.pdlp.PointMetadata point_metadata = 11;
      Specified by:
      getPointMetadataOrBuilderList in interface IterationStatsOrBuilder

    • addPointMetadataBuilder

      public PointMetadata.Builder addPointMetadataBuilder()
       Auxiliary statistics for each type of point.
      repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

    • addPointMetadataBuilder

      public PointMetadata.Builder addPointMetadataBuilder(int index)
       Auxiliary statistics for each type of point.
      repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

    • getPointMetadataBuilderList

      public List<PointMetadata.Builder> getPointMetadataBuilderList()
       Auxiliary statistics for each type of point.
      repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

    • hasCumulativeKktMatrixPasses

      public 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;
      Specified by:
      hasCumulativeKktMatrixPasses in interface IterationStatsOrBuilder
      Returns:
      Whether the cumulativeKktMatrixPasses field is set.

    • getCumulativeKktMatrixPasses

      public 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;
      Specified by:
      getCumulativeKktMatrixPasses in interface IterationStatsOrBuilder
      Returns:
      The cumulativeKktMatrixPasses.

    • setCumulativeKktMatrixPasses

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

    • clearCumulativeKktMatrixPasses

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

    • hasCumulativeRejectedSteps

      public 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;
      Specified by:
      hasCumulativeRejectedSteps in interface IterationStatsOrBuilder
      Returns:
      Whether the cumulativeRejectedSteps field is set.

    • getCumulativeRejectedSteps

      public 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;
      Specified by:
      getCumulativeRejectedSteps in interface IterationStatsOrBuilder
      Returns:
      The cumulativeRejectedSteps.

    • setCumulativeRejectedSteps

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

    • clearCumulativeRejectedSteps

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

    • hasCumulativeTimeSec

      public 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;
      Specified by:
      hasCumulativeTimeSec in interface IterationStatsOrBuilder
      Returns:
      Whether the cumulativeTimeSec field is set.

    • getCumulativeTimeSec

      public 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;
      Specified by:
      getCumulativeTimeSec in interface IterationStatsOrBuilder
      Returns:
      The cumulativeTimeSec.

    • setCumulativeTimeSec

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

    • clearCumulativeTimeSec

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

    • hasRestartUsed

      public 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;
      Specified by:
      hasRestartUsed in interface IterationStatsOrBuilder
      Returns:
      Whether the restartUsed field is set.

    • getRestartUsed

      public 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;
      Specified by:
      getRestartUsed in interface IterationStatsOrBuilder
      Returns:
      The restartUsed.

    • setRestartUsed

      public IterationStats.Builder setRestartUsed(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:
      value - The restartUsed to set.
      Returns:
      This builder for chaining.

    • clearRestartUsed

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

    • hasStepSize

      public 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;
      Specified by:
      hasStepSize in interface IterationStatsOrBuilder
      Returns:
      Whether the stepSize field is set.

    • getStepSize

      public 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;
      Specified by:
      getStepSize in interface IterationStatsOrBuilder
      Returns:
      The stepSize.

    • setStepSize

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

    • clearStepSize

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

    • hasPrimalWeight

      public 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;
      Specified by:
      hasPrimalWeight in interface IterationStatsOrBuilder
      Returns:
      Whether the primalWeight field is set.

    • getPrimalWeight

      public 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;
      Specified by:
      getPrimalWeight in interface IterationStatsOrBuilder
      Returns:
      The primalWeight.

    • setPrimalWeight

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

    • clearPrimalWeight

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