Package operations_research.pdlp

Interface SolveLogOuterClass.IterationStatsOrBuilder

    • Method Detail

      • hasIterationNumber

        boolean hasIterationNumber()
         The iteration number at which these stats were recorded. By convention,
 iteration counts start at 1, and the stats correspond to the solution
 *after* the iteration. Therefore stats from iteration 0 are the stats at
 the starting point.
        optional int32 iteration_number = 1;
        Returns:
        Whether the iterationNumber field is set.

      • getIterationNumber

        int getIterationNumber()
         The iteration number at which these stats were recorded. By convention,
 iteration counts start at 1, and the stats correspond to the solution
 *after* the iteration. Therefore stats from iteration 0 are the stats at
 the starting point.
        optional int32 iteration_number = 1;
        Returns:
        The iterationNumber.

      • getConvergenceInformationList

        java.util.List<SolveLogOuterClass.ConvergenceInformation> getConvergenceInformationList()
         A set of statistics measuring how close a point is to establishing primal
 and dual feasibility and optimality. This field is repeated since there
 might be several different points that are considered.
        repeated .operations_research.pdlp.ConvergenceInformation convergence_information = 2;

      • getConvergenceInformation

        SolveLogOuterClass.ConvergenceInformation getConvergenceInformation​(int index)
         A set of statistics measuring how close a point is to establishing primal
 and dual feasibility and optimality. This field is repeated since there
 might be several different points that are considered.
        repeated .operations_research.pdlp.ConvergenceInformation convergence_information = 2;

      • getConvergenceInformationCount

        int getConvergenceInformationCount()
         A set of statistics measuring how close a point is to establishing primal
 and dual feasibility and optimality. This field is repeated since there
 might be several different points that are considered.
        repeated .operations_research.pdlp.ConvergenceInformation convergence_information = 2;

      • getConvergenceInformationOrBuilderList

        java.util.List<? extends SolveLogOuterClass.ConvergenceInformationOrBuilder> getConvergenceInformationOrBuilderList()
         A set of statistics measuring how close a point is to establishing primal
 and dual feasibility and optimality. This field is repeated since there
 might be several different points that are considered.
        repeated .operations_research.pdlp.ConvergenceInformation convergence_information = 2;

      • getConvergenceInformationOrBuilder

        SolveLogOuterClass.ConvergenceInformationOrBuilder getConvergenceInformationOrBuilder​(int index)
         A set of statistics measuring how close a point is to establishing primal
 and dual feasibility and optimality. This field is repeated since there
 might be several different points that are considered.
        repeated .operations_research.pdlp.ConvergenceInformation convergence_information = 2;

      • getInfeasibilityInformationList

        java.util.List<SolveLogOuterClass.InfeasibilityInformation> getInfeasibilityInformationList()
         A set of statistics measuring how close a point is to establishing primal
 or dual infeasibility (i.e., has no solution). This field is repeated since
 there might be several different points that could establish infeasibility.
        repeated .operations_research.pdlp.InfeasibilityInformation infeasibility_information = 3;

      • getInfeasibilityInformation

        SolveLogOuterClass.InfeasibilityInformation getInfeasibilityInformation​(int index)
         A set of statistics measuring how close a point is to establishing primal
 or dual infeasibility (i.e., has no solution). This field is repeated since
 there might be several different points that could establish infeasibility.
        repeated .operations_research.pdlp.InfeasibilityInformation infeasibility_information = 3;

      • getInfeasibilityInformationCount

        int getInfeasibilityInformationCount()
         A set of statistics measuring how close a point is to establishing primal
 or dual infeasibility (i.e., has no solution). This field is repeated since
 there might be several different points that could establish infeasibility.
        repeated .operations_research.pdlp.InfeasibilityInformation infeasibility_information = 3;

      • getInfeasibilityInformationOrBuilderList

        java.util.List<? extends SolveLogOuterClass.InfeasibilityInformationOrBuilder> getInfeasibilityInformationOrBuilderList()
         A set of statistics measuring how close a point is to establishing primal
 or dual infeasibility (i.e., has no solution). This field is repeated since
 there might be several different points that could establish infeasibility.
        repeated .operations_research.pdlp.InfeasibilityInformation infeasibility_information = 3;

      • getInfeasibilityInformationOrBuilder

        SolveLogOuterClass.InfeasibilityInformationOrBuilder getInfeasibilityInformationOrBuilder​(int index)
         A set of statistics measuring how close a point is to establishing primal
 or dual infeasibility (i.e., has no solution). This field is repeated since
 there might be several different points that could establish infeasibility.
        repeated .operations_research.pdlp.InfeasibilityInformation infeasibility_information = 3;

      • getPointMetadataList

        java.util.List<SolveLogOuterClass.PointMetadata> getPointMetadataList()
         Auxiliary statistics for each type of point.
        repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

      • getPointMetadata

        SolveLogOuterClass.PointMetadata getPointMetadata​(int index)
         Auxiliary statistics for each type of point.
        repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

      • getPointMetadataCount

        int getPointMetadataCount()
         Auxiliary statistics for each type of point.
        repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

      • getPointMetadataOrBuilderList

        java.util.List<? extends SolveLogOuterClass.PointMetadataOrBuilder> getPointMetadataOrBuilderList()
         Auxiliary statistics for each type of point.
        repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

      • getPointMetadataOrBuilder

        SolveLogOuterClass.PointMetadataOrBuilder getPointMetadataOrBuilder​(int index)
         Auxiliary statistics for each type of point.
        repeated .operations_research.pdlp.PointMetadata point_metadata = 11;

      • hasCumulativeKktMatrixPasses

        boolean hasCumulativeKktMatrixPasses()
         The cumulative number of passes through the KKT matrix since the start of
 the solve. One pass is a multply by the constraint matrix, its transpose
 and the matrix that defines the quadratic part of the objective.

 For example, each iteration of mirror saddle prox contributes 2.0 to this
 sum. This is a float because it can include fractional passes through the
 data. For example, in an active set method we may only use a submatrix with
 20% of the nonzeros of the KKT matrix at each iteration in which case 0.2
 would be added to the total.
        optional double cumulative_kkt_matrix_passes = 4;
        Returns:
        Whether the cumulativeKktMatrixPasses field is set.

      • getCumulativeKktMatrixPasses

        double getCumulativeKktMatrixPasses()
         The cumulative number of passes through the KKT matrix since the start of
 the solve. One pass is a multply by the constraint matrix, its transpose
 and the matrix that defines the quadratic part of the objective.

 For example, each iteration of mirror saddle prox contributes 2.0 to this
 sum. This is a float because it can include fractional passes through the
 data. For example, in an active set method we may only use a submatrix with
 20% of the nonzeros of the KKT matrix at each iteration in which case 0.2
 would be added to the total.
        optional double cumulative_kkt_matrix_passes = 4;
        Returns:
        The cumulativeKktMatrixPasses.

      • hasCumulativeRejectedSteps

        boolean hasCumulativeRejectedSteps()
         The total number of rejected steps (e.g., within a line search procedure)
 since the start of the solve.
        optional int32 cumulative_rejected_steps = 5;
        Returns:
        Whether the cumulativeRejectedSteps field is set.

      • getCumulativeRejectedSteps

        int getCumulativeRejectedSteps()
         The total number of rejected steps (e.g., within a line search procedure)
 since the start of the solve.
        optional int32 cumulative_rejected_steps = 5;
        Returns:
        The cumulativeRejectedSteps.

      • hasCumulativeTimeSec

        boolean hasCumulativeTimeSec()
         The amount of time passed since we started solving the problem (see solver
 log `solve_time_sec` which records total time).
        optional double cumulative_time_sec = 6;
        Returns:
        Whether the cumulativeTimeSec field is set.

      • getCumulativeTimeSec

        double getCumulativeTimeSec()
         The amount of time passed since we started solving the problem (see solver
 log `solve_time_sec` which records total time).
        optional double cumulative_time_sec = 6;
        Returns:
        The cumulativeTimeSec.

      • hasRestartUsed

        boolean hasRestartUsed()
         The kind of restart that occurred at this iteration, or NO_RESTART if a
 restart did not occur.
        optional .operations_research.pdlp.RestartChoice restart_used = 7;
        Returns:
        Whether the restartUsed field is set.

      • getRestartUsed

        SolveLogOuterClass.RestartChoice getRestartUsed()
         The kind of restart that occurred at this iteration, or NO_RESTART if a
 restart did not occur.
        optional .operations_research.pdlp.RestartChoice restart_used = 7;
        Returns:
        The restartUsed.

      • hasStepSize

        boolean hasStepSize()
         Step size used at this iteration. Note that the step size used for the
 primal update is step_size / primal_weight, while the one used for the dual
 update is step_size * primal_weight.
        optional double step_size = 8;
        Returns:
        Whether the stepSize field is set.

      • getStepSize

        double getStepSize()
         Step size used at this iteration. Note that the step size used for the
 primal update is step_size / primal_weight, while the one used for the dual
 update is step_size * primal_weight.
        optional double step_size = 8;
        Returns:
        The stepSize.

      • hasPrimalWeight

        boolean hasPrimalWeight()
         Primal weight controlling the relation between primal and dual step sizes.
 See field 'step_size' for a detailed description.
        optional double primal_weight = 9;
        Returns:
        Whether the primalWeight field is set.

      • getPrimalWeight

        double getPrimalWeight()
         Primal weight controlling the relation between primal and dual step sizes.
 See field 'step_size' for a detailed description.
        optional double primal_weight = 9;
        Returns:
        The primalWeight.