Package operations_research.pdlp

Interface SolveLogOuterClass.SolveLogOrBuilder

    • Method Detail

      • hasInstanceName

        boolean hasInstanceName()
         The name of the optimization problem.
        optional string instance_name = 1;
        Returns:
        Whether the instanceName field is set.

      • getInstanceName

        java.lang.String getInstanceName()
         The name of the optimization problem.
        optional string instance_name = 1;
        Returns:
        The instanceName.

      • getInstanceNameBytes

        com.google.protobuf.ByteString getInstanceNameBytes()
         The name of the optimization problem.
        optional string instance_name = 1;
        Returns:
        The bytes for instanceName.

      • hasParams

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

      • getParams

        Solvers.PrimalDualHybridGradientParams getParams()
         If solved with PDLP, the parameters for this solve.
        optional .operations_research.pdlp.PrimalDualHybridGradientParams params = 14;
        Returns:
        The params.

      • hasTerminationReason

        boolean hasTerminationReason()
         The reason that the solve terminated.
        optional .operations_research.pdlp.TerminationReason termination_reason = 3;
        Returns:
        Whether the terminationReason field is set.

      • getTerminationReason

        SolveLogOuterClass.TerminationReason getTerminationReason()
         The reason that the solve terminated.
        optional .operations_research.pdlp.TerminationReason termination_reason = 3;
        Returns:
        The terminationReason.

      • hasTerminationString

        boolean hasTerminationString()
         Optional extra information about the termination reason.
        optional string termination_string = 4;
        Returns:
        Whether the terminationString field is set.

      • getTerminationString

        java.lang.String getTerminationString()
         Optional extra information about the termination reason.
        optional string termination_string = 4;
        Returns:
        The terminationString.

      • getTerminationStringBytes

        com.google.protobuf.ByteString getTerminationStringBytes()
         Optional extra information about the termination reason.
        optional string termination_string = 4;
        Returns:
        The bytes for terminationString.

      • hasIterationCount

        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;
        Returns:
        Whether the iterationCount field is set.

      • getIterationCount

        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;
        Returns:
        The iterationCount.

      • hasPreprocessingTimeSec

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

      • getPreprocessingTimeSec

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

      • hasSolveTimeSec

        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;
        Returns:
        Whether the solveTimeSec field is set.

      • getSolveTimeSec

        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;
        Returns:
        The solveTimeSec.

      • hasSolutionStats

        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;
        Returns:
        Whether the solutionStats field is set.

      • getSolutionStats

        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;
        Returns:
        The solutionStats.

      • getSolutionStatsOrBuilder

        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;

      • hasSolutionType

        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;
        Returns:
        Whether the solutionType field is set.

      • getSolutionType

        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;
        Returns:
        The solutionType.

      • getIterationStatsList

        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;

      • getIterationStats

        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;

      • getIterationStatsCount

        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;

      • getIterationStatsOrBuilderList

        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;

      • getIterationStatsOrBuilder

        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;

      • hasOriginalProblemStats

        boolean hasOriginalProblemStats()
         Statistics of the original problem.
        optional .operations_research.pdlp.QuadraticProgramStats original_problem_stats = 11;
        Returns:
        Whether the originalProblemStats field is set.

      • getOriginalProblemStats

        SolveLogOuterClass.QuadraticProgramStats getOriginalProblemStats()
         Statistics of the original problem.
        optional .operations_research.pdlp.QuadraticProgramStats original_problem_stats = 11;
        Returns:
        The originalProblemStats.

      • hasPreprocessedProblemStats

        boolean hasPreprocessedProblemStats()
         Statistics of the problem after preprocessing.
        optional .operations_research.pdlp.QuadraticProgramStats preprocessed_problem_stats = 12;
        Returns:
        Whether the preprocessedProblemStats field is set.

      • getPreprocessedProblemStats

        SolveLogOuterClass.QuadraticProgramStats getPreprocessedProblemStats()
         Statistics of the problem after preprocessing.
        optional .operations_research.pdlp.QuadraticProgramStats preprocessed_problem_stats = 12;
        Returns:
        The preprocessedProblemStats.

      • getPreprocessedProblemStatsOrBuilder

        SolveLogOuterClass.QuadraticProgramStatsOrBuilder getPreprocessedProblemStatsOrBuilder()
         Statistics of the problem after preprocessing.
        optional .operations_research.pdlp.QuadraticProgramStats preprocessed_problem_stats = 12;

      • getFeasibilityPolishingDetailsList

        java.util.List<SolveLogOuterClass.FeasibilityPolishingDetails> getFeasibilityPolishingDetailsList()
         If solving with `use_feasibility_polishing`, details about the primal and
 dual feasibility polishing phases.
        repeated .operations_research.pdlp.FeasibilityPolishingDetails feasibility_polishing_details = 15;

      • getFeasibilityPolishingDetails

        SolveLogOuterClass.FeasibilityPolishingDetails getFeasibilityPolishingDetails​(int index)
         If solving with `use_feasibility_polishing`, details about the primal and
 dual feasibility polishing phases.
        repeated .operations_research.pdlp.FeasibilityPolishingDetails feasibility_polishing_details = 15;

      • getFeasibilityPolishingDetailsCount

        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;

      • getFeasibilityPolishingDetailsOrBuilderList

        java.util.List<? extends SolveLogOuterClass.FeasibilityPolishingDetailsOrBuilder> getFeasibilityPolishingDetailsOrBuilderList()
         If solving with `use_feasibility_polishing`, details about the primal and
 dual feasibility polishing phases.
        repeated .operations_research.pdlp.FeasibilityPolishingDetails feasibility_polishing_details = 15;

      • getFeasibilityPolishingDetailsOrBuilder

        SolveLogOuterClass.FeasibilityPolishingDetailsOrBuilder getFeasibilityPolishingDetailsOrBuilder​(int index)
         If solving with `use_feasibility_polishing`, details about the primal and
 dual feasibility polishing phases.
        repeated .operations_research.pdlp.FeasibilityPolishingDetails feasibility_polishing_details = 15;