Skip to content

Commit 73e92a4

Browse files
blegatmlubin
authored andcommitted
Remove canXXX section on doc (#482)
1 parent 19d85b0 commit 73e92a4

File tree

1 file changed

+0
-6
lines changed

1 file changed

+0
-6
lines changed

docs/src/apimanual.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -810,12 +810,6 @@ users to avoid extra copies in this case.
810810

811811
Solver wrappers should document how the low-level solver statuses map to the MOI statuses. In particular, the characterization of a result with status `FeasiblePoint` and termination status `Success` is entirely solver defined. It may or may not be a globally optimal solution. Solver wrappers are not responsible for verifying the feasibility of results. Statuses like `NearlyFeasiblePoint`, `InfeasiblePoint`, `NearlyInfeasiblePoint`, and `NearlyReductionCertificate` are designed to be used when the solver explicitly indicates as much.
812812

813-
### canXXX
814-
815-
For most operations, MOI provides a function `canXXX` that can be used to check if the operation `XXX` is allowed.
816-
For example, `addconstraint!(model::ModelLike, func::F, set::S)` has the corresponding function `canaddconstraint(model, ::Type{F}, ::Type{S})::Bool`.
817-
If `canaddconstraint` returns `false`, then calling `addconstraint!` must throw an error (likewise with all `XXX` and `canXXX` pairs). Note that even if `canaddconstraint` returns `true`, `addconstraint!` may still throw an error if, for example, the constraint function does not meet some sparsity conditions, one of the coefficients is `NaN`, or an invalid variable index is provided. This is because (in most cases) the `canXXX` method receives type information instead of the actual arguments.
818-
819813
### Package Naming
820814

821815
MOI solver interfaces may be in the same package as the solver itself (either the C wrapper if the solver is accessible through C, or the Julia code if the solver is written in Julia, for example).

0 commit comments

Comments
 (0)