Inheritance diagram for operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder:

Public Member Functions
boolean	hasOptimalityNorm ()

operations_research.pdlp.Solvers.OptimalityNorm	getOptimalityNorm ()

boolean	hasSimpleOptimalityCriteria ()

operations_research.pdlp.Solvers.TerminationCriteria.SimpleOptimalityCriteria	getSimpleOptimalityCriteria ()

operations_research.pdlp.Solvers.TerminationCriteria.SimpleOptimalityCriteriaOrBuilder	getSimpleOptimalityCriteriaOrBuilder ()

boolean	hasDetailedOptimalityCriteria ()

operations_research.pdlp.Solvers.TerminationCriteria.DetailedOptimalityCriteria	getDetailedOptimalityCriteria ()

operations_research.pdlp.Solvers.TerminationCriteria.DetailedOptimalityCriteriaOrBuilder	getDetailedOptimalityCriteriaOrBuilder ()

boolean	hasEpsOptimalAbsolute ()

double	getEpsOptimalAbsolute ()

boolean	hasEpsOptimalRelative ()

double	getEpsOptimalRelative ()

boolean	hasEpsPrimalInfeasible ()

double	getEpsPrimalInfeasible ()

boolean	hasEpsDualInfeasible ()

double	getEpsDualInfeasible ()

boolean	hasTimeSecLimit ()

double	getTimeSecLimit ()

boolean	hasIterationLimit ()

int	getIterationLimit ()

boolean	hasKktMatrixPassLimit ()

double	getKktMatrixPassLimit ()

operations_research.pdlp.Solvers.TerminationCriteria.OptimalityCriteriaCase	getOptimalityCriteriaCase ()

Detailed Description

Definition at line 176 of file Solvers.java.

Member Function Documentation

◆ getDetailedOptimalityCriteria()

operations_research.pdlp.Solvers.TerminationCriteria.DetailedOptimalityCriteria operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.getDetailedOptimalityCriteria ( )

.operations_research.pdlp.TerminationCriteria.DetailedOptimalityCriteria detailed_optimality_criteria = 10;

Returns: The detailedOptimalityCriteria.

Implemented in operations_research.pdlp.Solvers.TerminationCriteria, and operations_research.pdlp.Solvers.TerminationCriteria.Builder.

◆ getDetailedOptimalityCriteriaOrBuilder()

operations_research.pdlp.Solvers.TerminationCriteria.DetailedOptimalityCriteriaOrBuilder operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.getDetailedOptimalityCriteriaOrBuilder ( )

.operations_research.pdlp.TerminationCriteria.DetailedOptimalityCriteria detailed_optimality_criteria = 10;

Implemented in operations_research.pdlp.Solvers.TerminationCriteria, and operations_research.pdlp.Solvers.TerminationCriteria.Builder.

◆ getEpsDualInfeasible()

double operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.getEpsDualInfeasible ( )

If the following three conditions hold we say we have obtained an
approximate primal ray, which is an approximate certificate of dual
infeasibility.
(1) primal_ray_linear_objective < 0,
(2) max_primal_ray_infeasibility / (-primal_ray_linear_objective) <=
eps_dual_infeasible
(3) primal_ray_quadratic_norm / (-primal_ray_linear_objective) <=
eps_dual_infeasible.

optional double eps_dual_infeasible = 5 [default = 1e-08];

Returns: The epsDualInfeasible.

Implemented in operations_research.pdlp.Solvers.TerminationCriteria, and operations_research.pdlp.Solvers.TerminationCriteria.Builder.

◆ getEpsOptimalAbsolute()

double operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.getEpsOptimalAbsolute ( )

Absolute tolerance on primal residual, dual residual, and the objective
gap.
Deprecated, use simple_optimality_criteria instead.
TODO(b/241462829) delete this deprecated field.

optional double eps_optimal_absolute = 2 [default = 1e-06, deprecated = true];

Deprecated: operations_research.pdlp.TerminationCriteria.eps_optimal_absolute is deprecated. See ortools/pdlp/solvers.proto;l=133

Returns: The epsOptimalAbsolute.

Implemented in operations_research.pdlp.Solvers.TerminationCriteria, and operations_research.pdlp.Solvers.TerminationCriteria.Builder.

◆ getEpsOptimalRelative()

double operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.getEpsOptimalRelative ( )

Relative tolerance on primal residual, dual residual, and the objective
gap.
Deprecated, use simple_optimality_criteria instead.
TODO(b/241462829) delete this deprecated field.

optional double eps_optimal_relative = 3 [default = 1e-06, deprecated = true];

Deprecated: operations_research.pdlp.TerminationCriteria.eps_optimal_relative is deprecated. See ortools/pdlp/solvers.proto;l=140

Returns: The epsOptimalRelative.

Implemented in operations_research.pdlp.Solvers.TerminationCriteria, and operations_research.pdlp.Solvers.TerminationCriteria.Builder.

◆ getEpsPrimalInfeasible()

double operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.getEpsPrimalInfeasible ( )

If the following two conditions hold we say that we have obtained an
approximate dual ray, which is an approximate certificate of primal
infeasibility.
(1) dual_ray_objective > 0,
(2) max_dual_ray_infeasibility / dual_ray_objective <=
eps_primal_infeasible.

optional double eps_primal_infeasible = 4 [default = 1e-08];

Returns: The epsPrimalInfeasible.

Implemented in operations_research.pdlp.Solvers.TerminationCriteria, and operations_research.pdlp.Solvers.TerminationCriteria.Builder.

◆ getIterationLimit()

int operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.getIterationLimit ( )

If termination_reason = TERMINATION_REASON_ITERATION_LIMIT then the solver
has taken at least iterations_limit iterations.

optional int32 iteration_limit = 7 [default = 2147483647];

Returns: The iterationLimit.

Implemented in operations_research.pdlp.Solvers.TerminationCriteria, and operations_research.pdlp.Solvers.TerminationCriteria.Builder.

◆ getKktMatrixPassLimit()

double operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.getKktMatrixPassLimit ( )

If termination_reason = TERMINATION_REASON_KKT_MATRIX_PASS_LIMIT then
cumulative_kkt_matrix_passes is at least kkt_pass_limit.

optional double kkt_matrix_pass_limit = 8 [default = inf];

Returns: The kktMatrixPassLimit.

Implemented in operations_research.pdlp.Solvers.TerminationCriteria, and operations_research.pdlp.Solvers.TerminationCriteria.Builder.

◆ getOptimalityCriteriaCase()

operations_research.pdlp.Solvers.TerminationCriteria.OptimalityCriteriaCase operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.getOptimalityCriteriaCase ( )

Implemented in operations_research.pdlp.Solvers.TerminationCriteria, and operations_research.pdlp.Solvers.TerminationCriteria.Builder.

◆ getOptimalityNorm()

operations_research.pdlp.Solvers.OptimalityNorm operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.getOptimalityNorm ( )

The norm that we are measuring the optimality criteria in.

optional .operations_research.pdlp.OptimalityNorm optimality_norm = 1 [default = OPTIMALITY_NORM_L2];

Returns: The optimalityNorm.

Implemented in operations_research.pdlp.Solvers.TerminationCriteria, and operations_research.pdlp.Solvers.TerminationCriteria.Builder.

◆ getSimpleOptimalityCriteria()

operations_research.pdlp.Solvers.TerminationCriteria.SimpleOptimalityCriteria operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.getSimpleOptimalityCriteria ( )

.operations_research.pdlp.TerminationCriteria.SimpleOptimalityCriteria simple_optimality_criteria = 9;

Returns: The simpleOptimalityCriteria.

Implemented in operations_research.pdlp.Solvers.TerminationCriteria, and operations_research.pdlp.Solvers.TerminationCriteria.Builder.

◆ getSimpleOptimalityCriteriaOrBuilder()

operations_research.pdlp.Solvers.TerminationCriteria.SimpleOptimalityCriteriaOrBuilder operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.getSimpleOptimalityCriteriaOrBuilder ( )

.operations_research.pdlp.TerminationCriteria.SimpleOptimalityCriteria simple_optimality_criteria = 9;

Implemented in operations_research.pdlp.Solvers.TerminationCriteria, and operations_research.pdlp.Solvers.TerminationCriteria.Builder.

◆ getTimeSecLimit()

double operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.getTimeSecLimit ( )

If termination_reason = TERMINATION_REASON_TIME_LIMIT then the solver has
taken at least time_sec_limit time.

optional double time_sec_limit = 6 [default = inf];

Returns: The timeSecLimit.

Implemented in operations_research.pdlp.Solvers.TerminationCriteria, and operations_research.pdlp.Solvers.TerminationCriteria.Builder.

◆ hasDetailedOptimalityCriteria()

boolean operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.hasDetailedOptimalityCriteria ( )

.operations_research.pdlp.TerminationCriteria.DetailedOptimalityCriteria detailed_optimality_criteria = 10;

Returns: Whether the detailedOptimalityCriteria field is set.

Implemented in operations_research.pdlp.Solvers.TerminationCriteria, and operations_research.pdlp.Solvers.TerminationCriteria.Builder.

◆ hasEpsDualInfeasible()

boolean operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.hasEpsDualInfeasible ( )

If the following three conditions hold we say we have obtained an
approximate primal ray, which is an approximate certificate of dual
infeasibility.
(1) primal_ray_linear_objective < 0,
(2) max_primal_ray_infeasibility / (-primal_ray_linear_objective) <=
eps_dual_infeasible
(3) primal_ray_quadratic_norm / (-primal_ray_linear_objective) <=
eps_dual_infeasible.

optional double eps_dual_infeasible = 5 [default = 1e-08];

Returns: Whether the epsDualInfeasible field is set.

Implemented in operations_research.pdlp.Solvers.TerminationCriteria, and operations_research.pdlp.Solvers.TerminationCriteria.Builder.

◆ hasEpsOptimalAbsolute()

boolean operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.hasEpsOptimalAbsolute ( )

Absolute tolerance on primal residual, dual residual, and the objective
gap.
Deprecated, use simple_optimality_criteria instead.
TODO(b/241462829) delete this deprecated field.

optional double eps_optimal_absolute = 2 [default = 1e-06, deprecated = true];

Deprecated: operations_research.pdlp.TerminationCriteria.eps_optimal_absolute is deprecated. See ortools/pdlp/solvers.proto;l=133

Returns: Whether the epsOptimalAbsolute field is set.

Implemented in operations_research.pdlp.Solvers.TerminationCriteria, and operations_research.pdlp.Solvers.TerminationCriteria.Builder.

◆ hasEpsOptimalRelative()

boolean operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.hasEpsOptimalRelative ( )

Relative tolerance on primal residual, dual residual, and the objective
gap.
Deprecated, use simple_optimality_criteria instead.
TODO(b/241462829) delete this deprecated field.

optional double eps_optimal_relative = 3 [default = 1e-06, deprecated = true];

Deprecated: operations_research.pdlp.TerminationCriteria.eps_optimal_relative is deprecated. See ortools/pdlp/solvers.proto;l=140

Returns: Whether the epsOptimalRelative field is set.

Implemented in operations_research.pdlp.Solvers.TerminationCriteria, and operations_research.pdlp.Solvers.TerminationCriteria.Builder.

◆ hasEpsPrimalInfeasible()

boolean operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.hasEpsPrimalInfeasible ( )

If the following two conditions hold we say that we have obtained an
approximate dual ray, which is an approximate certificate of primal
infeasibility.
(1) dual_ray_objective > 0,
(2) max_dual_ray_infeasibility / dual_ray_objective <=
eps_primal_infeasible.

optional double eps_primal_infeasible = 4 [default = 1e-08];

Returns: Whether the epsPrimalInfeasible field is set.

Implemented in operations_research.pdlp.Solvers.TerminationCriteria, and operations_research.pdlp.Solvers.TerminationCriteria.Builder.

◆ hasIterationLimit()

boolean operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.hasIterationLimit ( )

If termination_reason = TERMINATION_REASON_ITERATION_LIMIT then the solver
has taken at least iterations_limit iterations.

optional int32 iteration_limit = 7 [default = 2147483647];

Returns: Whether the iterationLimit field is set.

Implemented in operations_research.pdlp.Solvers.TerminationCriteria, and operations_research.pdlp.Solvers.TerminationCriteria.Builder.

◆ hasKktMatrixPassLimit()

boolean operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.hasKktMatrixPassLimit ( )

If termination_reason = TERMINATION_REASON_KKT_MATRIX_PASS_LIMIT then
cumulative_kkt_matrix_passes is at least kkt_pass_limit.

optional double kkt_matrix_pass_limit = 8 [default = inf];

Returns: Whether the kktMatrixPassLimit field is set.

Implemented in operations_research.pdlp.Solvers.TerminationCriteria, and operations_research.pdlp.Solvers.TerminationCriteria.Builder.

◆ hasOptimalityNorm()

boolean operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.hasOptimalityNorm ( )

The norm that we are measuring the optimality criteria in.

optional .operations_research.pdlp.OptimalityNorm optimality_norm = 1 [default = OPTIMALITY_NORM_L2];

Returns: Whether the optimalityNorm field is set.

Implemented in operations_research.pdlp.Solvers.TerminationCriteria, and operations_research.pdlp.Solvers.TerminationCriteria.Builder.

◆ hasSimpleOptimalityCriteria()

boolean operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.hasSimpleOptimalityCriteria ( )

.operations_research.pdlp.TerminationCriteria.SimpleOptimalityCriteria simple_optimality_criteria = 9;

Returns: Whether the simpleOptimalityCriteria field is set.

Implemented in operations_research.pdlp.Solvers.TerminationCriteria, and operations_research.pdlp.Solvers.TerminationCriteria.Builder.

◆ hasTimeSecLimit()

boolean operations_research.pdlp.Solvers.TerminationCriteriaOrBuilder.hasTimeSecLimit ( )

If termination_reason = TERMINATION_REASON_TIME_LIMIT then the solver has
taken at least time_sec_limit time.

optional double time_sec_limit = 6 [default = inf];

Returns: Whether the timeSecLimit field is set.

Implemented in operations_research.pdlp.Solvers.TerminationCriteria, and operations_research.pdlp.Solvers.TerminationCriteria.Builder.

The documentation for this interface was generated from the following file:

build/java/ortools-java/src/main/java/operations_research/pdlp/Solvers.java

Public Member Functions

Detailed Description

Member Function Documentation

◆ getDetailedOptimalityCriteria()

◆ getDetailedOptimalityCriteriaOrBuilder()

◆ getEpsDualInfeasible()

◆ getEpsOptimalAbsolute()

◆ getEpsOptimalRelative()

◆ getEpsPrimalInfeasible()

◆ getIterationLimit()

◆ getKktMatrixPassLimit()

◆ getOptimalityCriteriaCase()

◆ getOptimalityNorm()

◆ getSimpleOptimalityCriteria()

◆ getSimpleOptimalityCriteriaOrBuilder()

◆ getTimeSecLimit()

◆ hasDetailedOptimalityCriteria()

◆ hasEpsDualInfeasible()

◆ hasEpsOptimalAbsolute()

◆ hasEpsOptimalRelative()

◆ hasEpsPrimalInfeasible()

◆ hasIterationLimit()

◆ hasKktMatrixPassLimit()

◆ hasOptimalityNorm()

◆ hasSimpleOptimalityCriteria()

◆ hasTimeSecLimit()