Package operations_research.pdlp

Class SolveLogOuterClass.SolveLog

    • Field Detail

      • INSTANCE_NAME_FIELD_NUMBER

        public static final int INSTANCE_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TERMINATION_REASON_FIELD_NUMBER

        public static final int TERMINATION_REASON_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TERMINATION_STRING_FIELD_NUMBER

        public static final int TERMINATION_STRING_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ITERATION_COUNT_FIELD_NUMBER

        public static final int ITERATION_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PREPROCESSING_TIME_SEC_FIELD_NUMBER

        public static final int PREPROCESSING_TIME_SEC_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SOLVE_TIME_SEC_FIELD_NUMBER

        public static final int SOLVE_TIME_SEC_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SOLUTION_STATS_FIELD_NUMBER

        public static final int SOLUTION_STATS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SOLUTION_TYPE_FIELD_NUMBER

        public static final int SOLUTION_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ITERATION_STATS_FIELD_NUMBER

        public static final int ITERATION_STATS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ORIGINAL_PROBLEM_STATS_FIELD_NUMBER

        public static final int ORIGINAL_PROBLEM_STATS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PREPROCESSED_PROBLEM_STATS_FIELD_NUMBER

        public static final int PREPROCESSED_PROBLEM_STATS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FEASIBILITY_POLISHING_DETAILS_FIELD_NUMBER

        public static final int FEASIBILITY_POLISHING_DETAILS_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

      • hasInstanceName

        public boolean hasInstanceName()
         The name of the optimization problem.
        optional string instance_name = 1;
        Specified by:
        hasInstanceName in interface SolveLogOuterClass.SolveLogOrBuilder
        Returns:
        Whether the instanceName field is set.

      • getInstanceNameBytes

        public com.google.protobuf.ByteString getInstanceNameBytes()
         The name of the optimization problem.
        optional string instance_name = 1;
        Specified by:
        getInstanceNameBytes in interface SolveLogOuterClass.SolveLogOrBuilder
        Returns:
        The bytes for instanceName.

      • hasParams

        public boolean hasParams()
         If solved with PDLP, the parameters for this solve.
        optional .operations_research.pdlp.PrimalDualHybridGradientParams params = 14;
        Specified by:
        hasParams in interface SolveLogOuterClass.SolveLogOrBuilder
        Returns:
        Whether the params field is set.

      • hasTerminationReason

        public boolean hasTerminationReason()
         The reason that the solve terminated.
        optional .operations_research.pdlp.TerminationReason termination_reason = 3;
        Specified by:
        hasTerminationReason in interface SolveLogOuterClass.SolveLogOrBuilder
        Returns:
        Whether the terminationReason field is set.

      • hasTerminationString

        public boolean hasTerminationString()
         Optional extra information about the termination reason.
        optional string termination_string = 4;
        Specified by:
        hasTerminationString in interface SolveLogOuterClass.SolveLogOrBuilder
        Returns:
        Whether the terminationString field is set.

      • getTerminationString

        public java.lang.String getTerminationString()
         Optional extra information about the termination reason.
        optional string termination_string = 4;
        Specified by:
        getTerminationString in interface SolveLogOuterClass.SolveLogOrBuilder
        Returns:
        The terminationString.

      • getTerminationStringBytes

        public com.google.protobuf.ByteString getTerminationStringBytes()
         Optional extra information about the termination reason.
        optional string termination_string = 4;
        Specified by:
        getTerminationStringBytes in interface SolveLogOuterClass.SolveLogOrBuilder
        Returns:
        The bytes for terminationString.

      • hasIterationCount

        public boolean hasIterationCount()
         The total number of iterations during the solve. For a solve with
 `use_feasibility_polishing` this count includes the iterations from
 the feasibility polishing phases.
        optional int32 iteration_count = 5;
        Specified by:
        hasIterationCount in interface SolveLogOuterClass.SolveLogOrBuilder
        Returns:
        Whether the iterationCount field is set.

      • getIterationCount

        public int getIterationCount()
         The total number of iterations during the solve. For a solve with
 `use_feasibility_polishing` this count includes the iterations from
 the feasibility polishing phases.
        optional int32 iteration_count = 5;
        Specified by:
        getIterationCount in interface SolveLogOuterClass.SolveLogOrBuilder
        Returns:
        The iterationCount.

      • hasPreprocessingTimeSec

        public boolean hasPreprocessingTimeSec()
         Time for preprocessing (everything before iteration 0). This is also
 included in `solve_time_sec`.
        optional double preprocessing_time_sec = 13;
        Specified by:
        hasPreprocessingTimeSec in interface SolveLogOuterClass.SolveLogOrBuilder
        Returns:
        Whether the preprocessingTimeSec field is set.

      • getPreprocessingTimeSec

        public double getPreprocessingTimeSec()
         Time for preprocessing (everything before iteration 0). This is also
 included in `solve_time_sec`.
        optional double preprocessing_time_sec = 13;
        Specified by:
        getPreprocessingTimeSec in interface SolveLogOuterClass.SolveLogOrBuilder
        Returns:
        The preprocessingTimeSec.

      • hasSolveTimeSec

        public boolean hasSolveTimeSec()
         The runtime of the solve. Note: This should not be used for comparing
 methods unless care is taken to control for noise in runtime measurement.
 For a solve with `use_feasibility_polishing` this count includes the
 iterations from the feasibility polishing phases.
        optional double solve_time_sec = 6;
        Specified by:
        hasSolveTimeSec in interface SolveLogOuterClass.SolveLogOrBuilder
        Returns:
        Whether the solveTimeSec field is set.

      • getSolveTimeSec

        public double getSolveTimeSec()
         The runtime of the solve. Note: This should not be used for comparing
 methods unless care is taken to control for noise in runtime measurement.
 For a solve with `use_feasibility_polishing` this count includes the
 iterations from the feasibility polishing phases.
        optional double solve_time_sec = 6;
        Specified by:
        getSolveTimeSec in interface SolveLogOuterClass.SolveLogOrBuilder
        Returns:
        The solveTimeSec.

      • hasSolutionStats

        public boolean hasSolutionStats()
         The `IterationStats` for the final iteration of the solver. For a solve
 with `use_feasibility_polishing`, the work metrics (iteration_count,
 cumulative_kkt_matrix_passes, etc.) will include the work done in the
 feasibility polishing phases.
 NOTE: Regardless of preprocessing (i.e. scaling or presolve) the optimality
 or infeasibility information is evaluated with respect to the original
 problem.
        optional .operations_research.pdlp.IterationStats solution_stats = 8;
        Specified by:
        hasSolutionStats in interface SolveLogOuterClass.SolveLogOrBuilder
        Returns:
        Whether the solutionStats field is set.

      • getSolutionStats

        public SolveLogOuterClass.IterationStats getSolutionStats()
         The `IterationStats` for the final iteration of the solver. For a solve
 with `use_feasibility_polishing`, the work metrics (iteration_count,
 cumulative_kkt_matrix_passes, etc.) will include the work done in the
 feasibility polishing phases.
 NOTE: Regardless of preprocessing (i.e. scaling or presolve) the optimality
 or infeasibility information is evaluated with respect to the original
 problem.
        optional .operations_research.pdlp.IterationStats solution_stats = 8;
        Specified by:
        getSolutionStats in interface SolveLogOuterClass.SolveLogOrBuilder
        Returns:
        The solutionStats.

      • getSolutionStatsOrBuilder

        public SolveLogOuterClass.IterationStatsOrBuilder getSolutionStatsOrBuilder()
         The `IterationStats` for the final iteration of the solver. For a solve
 with `use_feasibility_polishing`, the work metrics (iteration_count,
 cumulative_kkt_matrix_passes, etc.) will include the work done in the
 feasibility polishing phases.
 NOTE: Regardless of preprocessing (i.e. scaling or presolve) the optimality
 or infeasibility information is evaluated with respect to the original
 problem.
        optional .operations_research.pdlp.IterationStats solution_stats = 8;
        Specified by:
        getSolutionStatsOrBuilder in interface SolveLogOuterClass.SolveLogOrBuilder

      • hasSolutionType

        public boolean hasSolutionType()
         The type of the output point that the solver returned. The quality of the
 point is reported in the corresponding entry of
 solution_stats.convergence_information and/or
 solution_stats.infeasibility_information. If termination_reason is
 TERMINATION_REASON_OPTIMAL, it's guaranteed that the corresponding entry of
 solution_stats.convergence_information satisfies the optimality conditions.
 Similarly, if termination_reason is either
 TERMINATION_REASON_PRIMAL_INFEASIBLE or TERMINATION_REASON_DUAL_INFEASIBLE
 the corresponding entry of solution_stats.infeasibility_information
 satisifes conditions for declaring primal or dual infeasibility,
 respectively.
 If termination_reason is anything else, e.g. TERMINATION_REASON_TIME_LIMIT
 or TERMINATION_REASON_PRIMAL_OR_DUAL_INFEASIBLE, the solution may not
 satisfy the optimality or infeasibility conditions.
        optional .operations_research.pdlp.PointType solution_type = 10;
        Specified by:
        hasSolutionType in interface SolveLogOuterClass.SolveLogOrBuilder
        Returns:
        Whether the solutionType field is set.

      • getSolutionType

        public SolveLogOuterClass.PointType getSolutionType()
         The type of the output point that the solver returned. The quality of the
 point is reported in the corresponding entry of
 solution_stats.convergence_information and/or
 solution_stats.infeasibility_information. If termination_reason is
 TERMINATION_REASON_OPTIMAL, it's guaranteed that the corresponding entry of
 solution_stats.convergence_information satisfies the optimality conditions.
 Similarly, if termination_reason is either
 TERMINATION_REASON_PRIMAL_INFEASIBLE or TERMINATION_REASON_DUAL_INFEASIBLE
 the corresponding entry of solution_stats.infeasibility_information
 satisifes conditions for declaring primal or dual infeasibility,
 respectively.
 If termination_reason is anything else, e.g. TERMINATION_REASON_TIME_LIMIT
 or TERMINATION_REASON_PRIMAL_OR_DUAL_INFEASIBLE, the solution may not
 satisfy the optimality or infeasibility conditions.
        optional .operations_research.pdlp.PointType solution_type = 10;
        Specified by:
        getSolutionType in interface SolveLogOuterClass.SolveLogOrBuilder
        Returns:
        The solutionType.

      • getIterationStatsList

        public java.util.List<SolveLogOuterClass.IterationStats> getIterationStatsList()
         A history of iteration stats for the solve. The iteration_number fields
 should be in increasing order. The frequency at which these stats should be
 recorded is not specified. This field is "more" optional than the others
 because it often significantly increases the size of the message, and
 because the information may not be available for third-party solvers.
 For a solve with `use_feasibility_polishing`, these iteration stats will
 only reflect the work done in the main iterations (not the feasibility
 polishing phases).
        repeated .operations_research.pdlp.IterationStats iteration_stats = 7;
        Specified by:
        getIterationStatsList in interface SolveLogOuterClass.SolveLogOrBuilder

      • getIterationStatsOrBuilderList

        public java.util.List<? extends SolveLogOuterClass.IterationStatsOrBuilder> getIterationStatsOrBuilderList()
         A history of iteration stats for the solve. The iteration_number fields
 should be in increasing order. The frequency at which these stats should be
 recorded is not specified. This field is "more" optional than the others
 because it often significantly increases the size of the message, and
 because the information may not be available for third-party solvers.
 For a solve with `use_feasibility_polishing`, these iteration stats will
 only reflect the work done in the main iterations (not the feasibility
 polishing phases).
        repeated .operations_research.pdlp.IterationStats iteration_stats = 7;
        Specified by:
        getIterationStatsOrBuilderList in interface SolveLogOuterClass.SolveLogOrBuilder

      • getIterationStatsCount

        public int getIterationStatsCount()
         A history of iteration stats for the solve. The iteration_number fields
 should be in increasing order. The frequency at which these stats should be
 recorded is not specified. This field is "more" optional than the others
 because it often significantly increases the size of the message, and
 because the information may not be available for third-party solvers.
 For a solve with `use_feasibility_polishing`, these iteration stats will
 only reflect the work done in the main iterations (not the feasibility
 polishing phases).
        repeated .operations_research.pdlp.IterationStats iteration_stats = 7;
        Specified by:
        getIterationStatsCount in interface SolveLogOuterClass.SolveLogOrBuilder

      • getIterationStats

        public SolveLogOuterClass.IterationStats getIterationStats​(int index)
         A history of iteration stats for the solve. The iteration_number fields
 should be in increasing order. The frequency at which these stats should be
 recorded is not specified. This field is "more" optional than the others
 because it often significantly increases the size of the message, and
 because the information may not be available for third-party solvers.
 For a solve with `use_feasibility_polishing`, these iteration stats will
 only reflect the work done in the main iterations (not the feasibility
 polishing phases).
        repeated .operations_research.pdlp.IterationStats iteration_stats = 7;
        Specified by:
        getIterationStats in interface SolveLogOuterClass.SolveLogOrBuilder

      • getIterationStatsOrBuilder

        public SolveLogOuterClass.IterationStatsOrBuilder getIterationStatsOrBuilder​(int index)
         A history of iteration stats for the solve. The iteration_number fields
 should be in increasing order. The frequency at which these stats should be
 recorded is not specified. This field is "more" optional than the others
 because it often significantly increases the size of the message, and
 because the information may not be available for third-party solvers.
 For a solve with `use_feasibility_polishing`, these iteration stats will
 only reflect the work done in the main iterations (not the feasibility
 polishing phases).
        repeated .operations_research.pdlp.IterationStats iteration_stats = 7;
        Specified by:
        getIterationStatsOrBuilder in interface SolveLogOuterClass.SolveLogOrBuilder

      • hasOriginalProblemStats

        public boolean hasOriginalProblemStats()
         Statistics of the original problem.
        optional .operations_research.pdlp.QuadraticProgramStats original_problem_stats = 11;
        Specified by:
        hasOriginalProblemStats in interface SolveLogOuterClass.SolveLogOrBuilder
        Returns:
        Whether the originalProblemStats field is set.

      • hasPreprocessedProblemStats

        public boolean hasPreprocessedProblemStats()
         Statistics of the problem after preprocessing.
        optional .operations_research.pdlp.QuadraticProgramStats preprocessed_problem_stats = 12;
        Specified by:
        hasPreprocessedProblemStats in interface SolveLogOuterClass.SolveLogOrBuilder
        Returns:
        Whether the preprocessedProblemStats field is set.

      • getFeasibilityPolishingDetailsCount

        public int getFeasibilityPolishingDetailsCount()
         If solving with `use_feasibility_polishing`, details about the primal and
 dual feasibility polishing phases.
        repeated .operations_research.pdlp.FeasibilityPolishingDetails feasibility_polishing_details = 15;
        Specified by:
        getFeasibilityPolishingDetailsCount in interface SolveLogOuterClass.SolveLogOrBuilder

      • 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.SolveLog parseFrom​(java.nio.ByteBuffer data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static SolveLogOuterClass.SolveLog parseFrom​(java.io.InputStream input)
                                             throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • parseDelimitedFrom

        public static SolveLogOuterClass.SolveLog parseDelimitedFrom​(java.io.InputStream input)
                                                      throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

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

      • parseFrom

        public static SolveLogOuterClass.SolveLog parseFrom​(com.google.protobuf.CodedInputStream input)
                                             throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<SolveLogOuterClass.SolveLog> 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.SolveLog getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder