Package operations_research.pdlp

Class SolveLogOuterClass.ConvergenceInformation

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, SolveLogOuterClass.ConvergenceInformationOrBuilder
    Enclosing class:
    SolveLogOuterClass
    public static final class SolveLogOuterClass.ConvergenceInformation
extends com.google.protobuf.GeneratedMessageV3
implements SolveLogOuterClass.ConvergenceInformationOrBuilder
     Information measuring how close a candidate is to establishing feasibility
 and optimality; see also TerminationCriteria.
    Protobuf type operations_research.pdlp.ConvergenceInformation
    See Also:
    Serialized Form

    • Field Detail

      • CANDIDATE_TYPE_FIELD_NUMBER

        public static final int CANDIDATE_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PRIMAL_OBJECTIVE_FIELD_NUMBER

        public static final int PRIMAL_OBJECTIVE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DUAL_OBJECTIVE_FIELD_NUMBER

        public static final int DUAL_OBJECTIVE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CORRECTED_DUAL_OBJECTIVE_FIELD_NUMBER

        public static final int CORRECTED_DUAL_OBJECTIVE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • L_INF_PRIMAL_RESIDUAL_FIELD_NUMBER

        public static final int L_INF_PRIMAL_RESIDUAL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • L2_PRIMAL_RESIDUAL_FIELD_NUMBER

        public static final int L2_PRIMAL_RESIDUAL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • L_INF_COMPONENTWISE_PRIMAL_RESIDUAL_FIELD_NUMBER

        public static final int L_INF_COMPONENTWISE_PRIMAL_RESIDUAL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • L_INF_DUAL_RESIDUAL_FIELD_NUMBER

        public static final int L_INF_DUAL_RESIDUAL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • L2_DUAL_RESIDUAL_FIELD_NUMBER

        public static final int L2_DUAL_RESIDUAL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • L_INF_COMPONENTWISE_DUAL_RESIDUAL_FIELD_NUMBER

        public static final int L_INF_COMPONENTWISE_DUAL_RESIDUAL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • L_INF_PRIMAL_VARIABLE_FIELD_NUMBER

        public static final int L_INF_PRIMAL_VARIABLE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • L2_PRIMAL_VARIABLE_FIELD_NUMBER

        public static final int L2_PRIMAL_VARIABLE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • L_INF_DUAL_VARIABLE_FIELD_NUMBER

        public static final int L_INF_DUAL_VARIABLE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • L2_DUAL_VARIABLE_FIELD_NUMBER

        public static final int L2_DUAL_VARIABLE_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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 SolveLogOuterClass.ConvergenceInformationOrBuilder
        Returns:
        Whether the candidateType field is set.

      • 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 SolveLogOuterClass.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 SolveLogOuterClass.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 SolveLogOuterClass.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 SolveLogOuterClass.ConvergenceInformationOrBuilder
        Returns:
        The correctedDualObjective.

      • 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 SolveLogOuterClass.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 SolveLogOuterClass.ConvergenceInformationOrBuilder
        Returns:
        The lInfComponentwisePrimalResidual.

      • 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 SolveLogOuterClass.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 SolveLogOuterClass.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 SolveLogOuterClass.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 SolveLogOuterClass.ConvergenceInformationOrBuilder
        Returns:
        The lInfPrimalVariable.

      • 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 SolveLogOuterClass.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 SolveLogOuterClass.ConvergenceInformationOrBuilder
        Returns:
        The lInfDualVariable.

      • isInitialized

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

      • writeTo

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

      • getSerializedSize

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

      • equals

        public boolean equals​(java.lang.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 SolveLogOuterClass.ConvergenceInformation parseFrom​(java.nio.ByteBuffer data)
                                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static SolveLogOuterClass.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 SolveLogOuterClass.ConvergenceInformation parseFrom​(byte[] data)
                                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • newBuilderForType

        protected SolveLogOuterClass.ConvergenceInformation.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<SolveLogOuterClass.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.GeneratedMessageV3

      • getDefaultInstanceForType

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