Package operations_research.pdlp

Class SolveLogOuterClass.ConvergenceInformation.Builder

    • Method Detail

      • 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.Builder<SolveLogOuterClass.ConvergenceInformation.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.GeneratedMessageV3.Builder<SolveLogOuterClass.ConvergenceInformation.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<SolveLogOuterClass.ConvergenceInformation.Builder>

      • mergeFrom

        public SolveLogOuterClass.ConvergenceInformation.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<SolveLogOuterClass.ConvergenceInformation.Builder>
        Throws:
        java.io.IOException

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

      • clearCandidateType

        public SolveLogOuterClass.ConvergenceInformation.Builder clearCandidateType()
         Type of the candidate point described by this ConvergenceInformation.
        optional .operations_research.pdlp.PointType candidate_type = 1;
        Returns:
        This builder for chaining.

      • setPrimalObjective

        public SolveLogOuterClass.ConvergenceInformation.Builder setPrimalObjective​(double value)
         The primal objective. The primal need not be feasible.
        optional double primal_objective = 2;
        Parameters:
        value - The primalObjective to set.
        Returns:
        This builder for chaining.

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

      • setDualObjective

        public SolveLogOuterClass.ConvergenceInformation.Builder setDualObjective​(double value)
         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;
        Parameters:
        value - The dualObjective to set.
        Returns:
        This builder for chaining.

      • clearDualObjective

        public SolveLogOuterClass.ConvergenceInformation.Builder clearDualObjective()
         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;
        Returns:
        This builder for chaining.

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

      • setCorrectedDualObjective

        public SolveLogOuterClass.ConvergenceInformation.Builder setCorrectedDualObjective​(double value)
         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;
        Parameters:
        value - The correctedDualObjective to set.
        Returns:
        This builder for chaining.

      • clearCorrectedDualObjective

        public SolveLogOuterClass.ConvergenceInformation.Builder clearCorrectedDualObjective()
         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;
        Returns:
        This builder for chaining.

      • setLInfPrimalResidual

        public SolveLogOuterClass.ConvergenceInformation.Builder setLInfPrimalResidual​(double value)
         The maximum violation of any primal constraint, i.e., the l_∞ norm of the
 violations.
        optional double l_inf_primal_residual = 5;
        Parameters:
        value - The lInfPrimalResidual to set.
        Returns:
        This builder for chaining.

      • clearLInfPrimalResidual

        public SolveLogOuterClass.ConvergenceInformation.Builder clearLInfPrimalResidual()
         The maximum violation of any primal constraint, i.e., the l_∞ norm of the
 violations.
        optional double l_inf_primal_residual = 5;
        Returns:
        This builder for chaining.

      • setL2PrimalResidual

        public SolveLogOuterClass.ConvergenceInformation.Builder setL2PrimalResidual​(double value)
         The l_2 norm of the violations of primal constraints.
        optional double l2_primal_residual = 6;
        Parameters:
        value - The l2PrimalResidual to set.
        Returns:
        This builder for chaining.

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

      • setLInfComponentwisePrimalResidual

        public SolveLogOuterClass.ConvergenceInformation.Builder setLInfComponentwisePrimalResidual​(double value)
         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;
        Parameters:
        value - The lInfComponentwisePrimalResidual to set.
        Returns:
        This builder for chaining.

      • clearLInfComponentwisePrimalResidual

        public SolveLogOuterClass.ConvergenceInformation.Builder clearLInfComponentwisePrimalResidual()
         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;
        Returns:
        This builder for chaining.

      • setLInfDualResidual

        public SolveLogOuterClass.ConvergenceInformation.Builder setLInfDualResidual​(double value)
         The maximum violation of any dual constraint, i.e., the l_∞ norm of the
 violations.
        optional double l_inf_dual_residual = 7;
        Parameters:
        value - The lInfDualResidual to set.
        Returns:
        This builder for chaining.

      • clearLInfDualResidual

        public SolveLogOuterClass.ConvergenceInformation.Builder clearLInfDualResidual()
         The maximum violation of any dual constraint, i.e., the l_∞ norm of the
 violations.
        optional double l_inf_dual_residual = 7;
        Returns:
        This builder for chaining.

      • setL2DualResidual

        public SolveLogOuterClass.ConvergenceInformation.Builder setL2DualResidual​(double value)
         The l_2 norm of the violations of dual constraints.
        optional double l2_dual_residual = 8;
        Parameters:
        value - The l2DualResidual to set.
        Returns:
        This builder for chaining.

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

      • setLInfComponentwiseDualResidual

        public SolveLogOuterClass.ConvergenceInformation.Builder setLInfComponentwiseDualResidual​(double value)
         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;
        Parameters:
        value - The lInfComponentwiseDualResidual to set.
        Returns:
        This builder for chaining.

      • clearLInfComponentwiseDualResidual

        public SolveLogOuterClass.ConvergenceInformation.Builder clearLInfComponentwiseDualResidual()
         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;
        Returns:
        This builder for chaining.

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

      • setLInfPrimalVariable

        public SolveLogOuterClass.ConvergenceInformation.Builder setLInfPrimalVariable​(double value)
         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;
        Parameters:
        value - The lInfPrimalVariable to set.
        Returns:
        This builder for chaining.

      • clearLInfPrimalVariable

        public SolveLogOuterClass.ConvergenceInformation.Builder clearLInfPrimalVariable()
         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;
        Returns:
        This builder for chaining.

      • setL2PrimalVariable

        public SolveLogOuterClass.ConvergenceInformation.Builder setL2PrimalVariable​(double value)
         The l_2 norm of the primal variables.
        optional double l2_primal_variable = 15;
        Parameters:
        value - The l2PrimalVariable to set.
        Returns:
        This builder for chaining.

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

      • setLInfDualVariable

        public SolveLogOuterClass.ConvergenceInformation.Builder setLInfDualVariable​(double value)
         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;
        Parameters:
        value - The lInfDualVariable to set.
        Returns:
        This builder for chaining.

      • clearLInfDualVariable

        public SolveLogOuterClass.ConvergenceInformation.Builder clearLInfDualVariable()
         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;
        Returns:
        This builder for chaining.

      • setL2DualVariable

        public SolveLogOuterClass.ConvergenceInformation.Builder setL2DualVariable​(double value)
         The l_2 norm of the dual variables.
        optional double l2_dual_variable = 17;
        Parameters:
        value - The l2DualVariable to set.
        Returns:
        This builder for chaining.