Skip to content

Commit 772b7d4

Browse files
authored
[docs] Clarify BasisStatusCode (jump-dev#1218)
* [docs] Clarify BasisStatusCode Closes jump-dev#440 * Update attributes.jl
1 parent 6c5fd6b commit 772b7d4

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

src/attributes.jl

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1064,21 +1064,29 @@ is_set_by_optimize(::CallbackVariablePrimal) = true
10641064
"""
10651065
BasisStatusCode
10661066
1067-
An Enum of possible values for the `ConstraintBasisStatus` attribute.
1068-
This explains the status of a given element with respect to an optimal solution basis.
1067+
An Enum of possible values for the `ConstraintBasisStatus` attribute, explaining
1068+
the status of a given element with respect to an optimal solution basis.
1069+
10691070
Possible values are:
1071+
10701072
* `BASIC`: element is in the basis
10711073
* `NONBASIC`: element is not in the basis
10721074
* `NONBASIC_AT_LOWER`: element is not in the basis and is at its lower bound
10731075
* `NONBASIC_AT_UPPER`: element is not in the basis and is at its upper bound
10741076
* `SUPER_BASIC`: element is not in the basis but is also not at one of its
10751077
bounds
10761078
1077-
Note: `NONBASIC_AT_LOWER` and `NONBASIC_AT_UPPER` should be used only for
1078-
constraints with the `Interval`. In this case cases they are necessary to
1079-
distinguish which side of the constraint. One-sided constraints (e.g.,
1080-
`LessThan` and `GreaterThan`) should use `NONBASIC` instead of the
1081-
`NONBASIC_AT_*` values.
1079+
Notes
1080+
1081+
* `NONBASIC_AT_LOWER` and `NONBASIC_AT_UPPER` should be used only for
1082+
constraints with the `Interval` set. In this case, they are necessary to
1083+
distinguish which side of the constraint is active. One-sided constraints
1084+
(e.g., `LessThan` and `GreaterThan`) should use `NONBASIC` instead of the
1085+
`NONBASIC_AT_*` values.
1086+
1087+
* In general, `SUPER_BASIC` usually occurs when the problem is nonlinear. For
1088+
linear programs, `SUPER_BASIC` variables only occur if the solver returns a
1089+
solution that is not at a vertex of the feasible region.
10821090
"""
10831091
@enum(
10841092
BasisStatusCode,

0 commit comments

Comments
 (0)