You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/apimanual.md
+36-1Lines changed: 36 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -565,4 +565,39 @@ If `canaddconstraint` returns `false`, then calling `addconstraint!` must throw
565
565
566
566
### Package Naming
567
567
568
-
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). In some cases it may be more appropriate to host the MOI wrapper in its own package; in this case it is recommended that the MOI wrapper package be named `MathOptInterfaceXXX` where `XXX` is the solver name.
568
+
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).
569
+
The guideline for naming the file containing the MOI wrapper is `src/MOIWrapper.jl` and `test/MOIWrapper.jl` for the tests.
570
+
In some cases it may be more appropriate to host the MOI wrapper in its own package; in this case it is recommended that the MOI wrapper package be named `MathOptInterfaceXXX` where `XXX` is the solver name.
571
+
572
+
### Testing guideline
573
+
574
+
The skeleton below can be used for the wrapper test file of a solver name `FooBar`:
575
+
```julia
576
+
using MathOptInterface
577
+
const MOI = MathOptInterface
578
+
const MOIT = MOI.Test
579
+
const MOIU = MOI.Utilities
580
+
const MOIB = MOI.Bridges
581
+
582
+
# Include here the functions/sets supported by the solver wrapper (not those that are supported through bridges)
0 commit comments