Class ConvergenceInformation

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.ortools.pdlp.ConvergenceInformation
All Implemented Interfaces:
ConvergenceInformationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ConvergenceInformation extends com.google.protobuf.GeneratedMessage implements ConvergenceInformationOrBuilder
 Information measuring how close a candidate is to establishing feasibility
 and optimality; see also TerminationCriteria.
Protobuf type operations_research.pdlp.ConvergenceInformation
See Also:

  • Field Details

    • CANDIDATE_TYPE_FIELD_NUMBER

      public static final int CANDIDATE_TYPE_FIELD_NUMBER
      See Also:

    • PRIMAL_OBJECTIVE_FIELD_NUMBER

      public static final int PRIMAL_OBJECTIVE_FIELD_NUMBER
      See Also:

    • DUAL_OBJECTIVE_FIELD_NUMBER

      public static final int DUAL_OBJECTIVE_FIELD_NUMBER
      See Also:

    • CORRECTED_DUAL_OBJECTIVE_FIELD_NUMBER

      public static final int CORRECTED_DUAL_OBJECTIVE_FIELD_NUMBER
      See Also:

    • L_INF_PRIMAL_RESIDUAL_FIELD_NUMBER

      public static final int L_INF_PRIMAL_RESIDUAL_FIELD_NUMBER
      See Also:

    • L2_PRIMAL_RESIDUAL_FIELD_NUMBER

      public static final int L2_PRIMAL_RESIDUAL_FIELD_NUMBER
      See Also:

    • L_INF_COMPONENTWISE_PRIMAL_RESIDUAL_FIELD_NUMBER

      public static final int L_INF_COMPONENTWISE_PRIMAL_RESIDUAL_FIELD_NUMBER
      See Also:

    • L_INF_DUAL_RESIDUAL_FIELD_NUMBER

      public static final int L_INF_DUAL_RESIDUAL_FIELD_NUMBER
      See Also:

    • L2_DUAL_RESIDUAL_FIELD_NUMBER

      public static final int L2_DUAL_RESIDUAL_FIELD_NUMBER
      See Also:

    • L_INF_COMPONENTWISE_DUAL_RESIDUAL_FIELD_NUMBER

      public static final int L_INF_COMPONENTWISE_DUAL_RESIDUAL_FIELD_NUMBER
      See Also:

    • L_INF_PRIMAL_VARIABLE_FIELD_NUMBER

      public static final int L_INF_PRIMAL_VARIABLE_FIELD_NUMBER
      See Also:

    • L2_PRIMAL_VARIABLE_FIELD_NUMBER

      public static final int L2_PRIMAL_VARIABLE_FIELD_NUMBER
      See Also:

    • L_INF_DUAL_VARIABLE_FIELD_NUMBER

      public static final int L_INF_DUAL_VARIABLE_FIELD_NUMBER
      See Also:

    • L2_DUAL_VARIABLE_FIELD_NUMBER

      public static final int L2_DUAL_VARIABLE_FIELD_NUMBER
      See Also:

  • 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

    • hasCandidateType

      public boolean hasCandidateType()
       Type of the candidate point described by this ConvergenceInformation.
      optional .operations_research.pdlp.PointType candidate_type = 1;
      Specified by:
      hasCandidateType in interface ConvergenceInformationOrBuilder
      Returns:
      Whether the candidateType field is set.

    • getCandidateType

      public PointType getCandidateType()
       Type of the candidate point described by this ConvergenceInformation.
      optional .operations_research.pdlp.PointType candidate_type = 1;
      Specified by:
      getCandidateType in interface ConvergenceInformationOrBuilder
      Returns:
      The candidateType.

    • hasPrimalObjective

      public boolean hasPrimalObjective()
       The primal objective. The primal need not be feasible.
      optional double primal_objective = 2;
      Specified by:
      hasPrimalObjective in interface ConvergenceInformationOrBuilder
      Returns:
      Whether the primalObjective field is set.

    • getPrimalObjective

      public double getPrimalObjective()
       The primal objective. The primal need not be feasible.
      optional double primal_objective = 2;
      Specified by:
      getPrimalObjective in interface ConvergenceInformationOrBuilder
      Returns:
      The primalObjective.

    • hasDualObjective

      public boolean hasDualObjective()
       The dual objective. The dual need not be feasible. The dual objective
 includes the contributions from reduced costs.
 NOTE: The definition of dual_objective changed in OR-tools version 9.8.
 See
 https://developers.google.com/optimization/lp/pdlp_math#reduced_costs_dual_residuals_and_the_corrected_dual_objective
 for details.
      optional double dual_objective = 3;
      Specified by:
      hasDualObjective in interface ConvergenceInformationOrBuilder
      Returns:
      Whether the dualObjective field is set.

    • getDualObjective

      public double getDualObjective()
       The dual objective. The dual need not be feasible. The dual objective
 includes the contributions from reduced costs.
 NOTE: The definition of dual_objective changed in OR-tools version 9.8.
 See
 https://developers.google.com/optimization/lp/pdlp_math#reduced_costs_dual_residuals_and_the_corrected_dual_objective
 for details.
      optional double dual_objective = 3;
      Specified by:
      getDualObjective in interface ConvergenceInformationOrBuilder
      Returns:
      The dualObjective.

    • hasCorrectedDualObjective

      public boolean hasCorrectedDualObjective()
       If possible (e.g., when all primal variables have lower and upper bounds),
 a correct dual bound. The value is negative infinity if no corrected dual
 bound is available.
      optional double corrected_dual_objective = 4;
      Specified by:
      hasCorrectedDualObjective in interface ConvergenceInformationOrBuilder
      Returns:
      Whether the correctedDualObjective field is set.

    • getCorrectedDualObjective

      public double getCorrectedDualObjective()
       If possible (e.g., when all primal variables have lower and upper bounds),
 a correct dual bound. The value is negative infinity if no corrected dual
 bound is available.
      optional double corrected_dual_objective = 4;
      Specified by:
      getCorrectedDualObjective in interface ConvergenceInformationOrBuilder
      Returns:
      The correctedDualObjective.

    • hasLInfPrimalResidual

      public boolean hasLInfPrimalResidual()
       The maximum violation of any primal constraint, i.e., the l_∞ norm of the
 violations.
      optional double l_inf_primal_residual = 5;
      Specified by:
      hasLInfPrimalResidual in interface ConvergenceInformationOrBuilder
      Returns:
      Whether the lInfPrimalResidual field is set.

    • getLInfPrimalResidual

      public double getLInfPrimalResidual()
       The maximum violation of any primal constraint, i.e., the l_∞ norm of the
 violations.
      optional double l_inf_primal_residual = 5;
      Specified by:
      getLInfPrimalResidual in interface ConvergenceInformationOrBuilder
      Returns:
      The lInfPrimalResidual.

    • hasL2PrimalResidual

      public boolean hasL2PrimalResidual()
       The l_2 norm of the violations of primal constraints.
      optional double l2_primal_residual = 6;
      Specified by:
      hasL2PrimalResidual in interface ConvergenceInformationOrBuilder
      Returns:
      Whether the l2PrimalResidual field is set.

    • getL2PrimalResidual

      public double getL2PrimalResidual()
       The l_2 norm of the violations of primal constraints.
      optional double l2_primal_residual = 6;
      Specified by:
      getL2PrimalResidual in interface ConvergenceInformationOrBuilder
      Returns:
      The l2PrimalResidual.

    • hasLInfComponentwisePrimalResidual

      public boolean hasLInfComponentwisePrimalResidual()
       The maximum relative violation of any primal constraint, with an absolute
 offset, i.e., the l_∞ norm of [violation / (eps_ratio + |bound|)] where
 eps_ratio = eps_optimal_primal_residual_absolute
 / eps_optimal_primal_residual_relative
 and bound is the violated bound.
      optional double l_inf_componentwise_primal_residual = 24;
      Specified by:
      hasLInfComponentwisePrimalResidual in interface ConvergenceInformationOrBuilder
      Returns:
      Whether the lInfComponentwisePrimalResidual field is set.

    • getLInfComponentwisePrimalResidual

      public double getLInfComponentwisePrimalResidual()
       The maximum relative violation of any primal constraint, with an absolute
 offset, i.e., the l_∞ norm of [violation / (eps_ratio + |bound|)] where
 eps_ratio = eps_optimal_primal_residual_absolute
 / eps_optimal_primal_residual_relative
 and bound is the violated bound.
      optional double l_inf_componentwise_primal_residual = 24;
      Specified by:
      getLInfComponentwisePrimalResidual in interface ConvergenceInformationOrBuilder
      Returns:
      The lInfComponentwisePrimalResidual.

    • hasLInfDualResidual

      public boolean hasLInfDualResidual()
       The maximum violation of any dual constraint, i.e., the l_∞ norm of the
 violations.
      optional double l_inf_dual_residual = 7;
      Specified by:
      hasLInfDualResidual in interface ConvergenceInformationOrBuilder
      Returns:
      Whether the lInfDualResidual field is set.

    • getLInfDualResidual

      public double getLInfDualResidual()
       The maximum violation of any dual constraint, i.e., the l_∞ norm of the
 violations.
      optional double l_inf_dual_residual = 7;
      Specified by:
      getLInfDualResidual in interface ConvergenceInformationOrBuilder
      Returns:
      The lInfDualResidual.

    • hasL2DualResidual

      public boolean hasL2DualResidual()
       The l_2 norm of the violations of dual constraints.
      optional double l2_dual_residual = 8;
      Specified by:
      hasL2DualResidual in interface ConvergenceInformationOrBuilder
      Returns:
      Whether the l2DualResidual field is set.

    • getL2DualResidual

      public double getL2DualResidual()
       The l_2 norm of the violations of dual constraints.
      optional double l2_dual_residual = 8;
      Specified by:
      getL2DualResidual in interface ConvergenceInformationOrBuilder
      Returns:
      The l2DualResidual.

    • hasLInfComponentwiseDualResidual

      public boolean hasLInfComponentwiseDualResidual()
       The maximum relative violation of any dual constraint, with an absolute
 offset, i.e., the l_∞ norm of [violation / (eps_ratio + |objective|)] where
 eps_ratio = eps_optimal_dual_residual_absolute
 / eps_optimal_dual_residual_relative
      optional double l_inf_componentwise_dual_residual = 25;
      Specified by:
      hasLInfComponentwiseDualResidual in interface ConvergenceInformationOrBuilder
      Returns:
      Whether the lInfComponentwiseDualResidual field is set.

    • getLInfComponentwiseDualResidual

      public double getLInfComponentwiseDualResidual()
       The maximum relative violation of any dual constraint, with an absolute
 offset, i.e., the l_∞ norm of [violation / (eps_ratio + |objective|)] where
 eps_ratio = eps_optimal_dual_residual_absolute
 / eps_optimal_dual_residual_relative
      optional double l_inf_componentwise_dual_residual = 25;
      Specified by:
      getLInfComponentwiseDualResidual in interface ConvergenceInformationOrBuilder
      Returns:
      The lInfComponentwiseDualResidual.

    • hasLInfPrimalVariable

      public boolean hasLInfPrimalVariable()
       The maximum absolute value of the primal variables, i.e., the l_∞ norm.
 This is useful to detect when the primal iterates are diverging. Divergence
 of the primal variables could be an algorithmic issue, or indicate that the
 dual is infeasible.
      optional double l_inf_primal_variable = 14;
      Specified by:
      hasLInfPrimalVariable in interface ConvergenceInformationOrBuilder
      Returns:
      Whether the lInfPrimalVariable field is set.

    • getLInfPrimalVariable

      public double getLInfPrimalVariable()
       The maximum absolute value of the primal variables, i.e., the l_∞ norm.
 This is useful to detect when the primal iterates are diverging. Divergence
 of the primal variables could be an algorithmic issue, or indicate that the
 dual is infeasible.
      optional double l_inf_primal_variable = 14;
      Specified by:
      getLInfPrimalVariable in interface ConvergenceInformationOrBuilder
      Returns:
      The lInfPrimalVariable.

    • hasL2PrimalVariable

      public boolean hasL2PrimalVariable()
       The l_2 norm of the primal variables.
      optional double l2_primal_variable = 15;
      Specified by:
      hasL2PrimalVariable in interface ConvergenceInformationOrBuilder
      Returns:
      Whether the l2PrimalVariable field is set.

    • getL2PrimalVariable

      public double getL2PrimalVariable()
       The l_2 norm of the primal variables.
      optional double l2_primal_variable = 15;
      Specified by:
      getL2PrimalVariable in interface ConvergenceInformationOrBuilder
      Returns:
      The l2PrimalVariable.

    • hasLInfDualVariable

      public boolean hasLInfDualVariable()
       The maximum absolute value of the dual variables, i.e., the l_∞ norm. This
 is useful to detect when the dual iterates are diverging. Divergence of the
 dual variables could be an algorithmic issue, or indicate the primal is
 infeasible.
      optional double l_inf_dual_variable = 16;
      Specified by:
      hasLInfDualVariable in interface ConvergenceInformationOrBuilder
      Returns:
      Whether the lInfDualVariable field is set.

    • getLInfDualVariable

      public double getLInfDualVariable()
       The maximum absolute value of the dual variables, i.e., the l_∞ norm. This
 is useful to detect when the dual iterates are diverging. Divergence of the
 dual variables could be an algorithmic issue, or indicate the primal is
 infeasible.
      optional double l_inf_dual_variable = 16;
      Specified by:
      getLInfDualVariable in interface ConvergenceInformationOrBuilder
      Returns:
      The lInfDualVariable.

    • hasL2DualVariable

      public boolean hasL2DualVariable()
       The l_2 norm of the dual variables.
      optional double l2_dual_variable = 17;
      Specified by:
      hasL2DualVariable in interface ConvergenceInformationOrBuilder
      Returns:
      Whether the l2DualVariable field is set.

    • getL2DualVariable

      public double getL2DualVariable()
       The l_2 norm of the dual variables.
      optional double l2_dual_variable = 17;
      Specified by:
      getL2DualVariable in interface ConvergenceInformationOrBuilder
      Returns:
      The l2DualVariable.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ConvergenceInformation parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ConvergenceInformation parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ConvergenceInformation parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ConvergenceInformation parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ConvergenceInformation parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ConvergenceInformation parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ConvergenceInformation parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ConvergenceInformation parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ConvergenceInformation parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ConvergenceInformation parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ConvergenceInformation parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ConvergenceInformation parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ConvergenceInformation.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ConvergenceInformation.Builder newBuilder()

    • newBuilder

      public static ConvergenceInformation.Builder newBuilder(ConvergenceInformation prototype)

    • toBuilder

      public ConvergenceInformation.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ConvergenceInformation.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ConvergenceInformation getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ConvergenceInformation> parser()

    • getParserForType

      public com.google.protobuf.Parser<ConvergenceInformation> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public ConvergenceInformation getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder