Add guideline in doc #320
Add guideline in doc #320
Conversation
Codecov Report
@@ Coverage Diff @@
## master #320 +/- ##
=======================================
Coverage 96.45% 96.45%
=======================================
Files 30 30
Lines 4514 4514
=======================================
Hits 4354 4354
Misses 160 160Continue to review full report at Codecov.
|
docs/src/apimanual.md
Outdated
| const MOIB = MOI.Bridges | ||
|
|
||
| # Include here the functions/sets supported by the solver wrapper (not those that are supported through bridges) | ||
| MOIU.@model FooBarModelData () (EqualTo, GreaterThan, LessThan) (Zeros, Nonnegatives, Nonpositives) () (SingleVariable,) (ScalarAffineFunction,) (VectorOfVariables,) (VectorAffineFunction,) |
There was a problem hiding this comment.
Could the UniversalFallback work here? There's no performance concerns for testing.
There was a problem hiding this comment.
Universal Fallback still requires an internal model so we need to create a model anyway. Doing MOIU.@model FooBarModelData () () () () () () () () and then using UniversalFallback would be a bit obscure. Besides, UniversalFallback only do attribute fallback for now :)
docs/src/apimanual.md
Outdated
| # Include here the functions/sets supported by the solver wrapper (not those that are supported through bridges) | ||
| MOIU.@model FooBarModelData () (EqualTo, GreaterThan, LessThan) (Zeros, Nonnegatives, Nonpositives) () (SingleVariable,) (ScalarAffineFunction,) (VectorOfVariables,) (VectorAffineFunction,) | ||
|
|
||
| MOIB.@bridge SplitInterval MOIB.SplitIntervalBridge () (Interval,) () () () (ScalarAffineFunction,) () () |
There was a problem hiding this comment.
Why do users need to see this macro call? Can't MOIB just export a SplitInterval type? The macros calls in this code snippet are enough to scare potential solver authors away. (Only partially kidding.)
There was a problem hiding this comment.
We could define all bridges in MOIB by default yes, I initially thought that it wasn't necessary and would increase the loading time of MOIB but it could be reconsidered
docs/src/apimanual.md
Outdated
| const config = MOIT.TestConfig(atol=1e-6, rtol=1e-6) | ||
|
|
||
| @testset "MOI Continuous Linear" begin | ||
| MOIT.contlineartest(MOIB.SplitInterval{Float64}(optimizer), config) |
There was a problem hiding this comment.
This would be a good place to explain why SplitInterval is used.
No description provided.