Docs: add readme details about restricting variables to have integer values #78
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- add more detail on constraining variables to integer solutions - show the `(integer)` qualifier syntax inside the `variables!` macro - update documentation links to use `latest` Add test in `variables.rs` showing `(integer)` qualifier
|
Adding docs based on my previous confusion in #76 |
|
The new test needs to run only on solvers with integer variables support, you can have a look at how other tests do this |
|
Whoops - I added a (I think that's how the build script runs, based on https://github.com/rust-or/good_lp/actions/runs/12586912454/job/35081976400#step:16:1) |
|
thanks! |
KnorpelSenf
pushed a commit
to KnorpelSenf/good_lp
that referenced
this pull request
Jan 22, 2025
…values (rust-or#78) * More details in README: - add more detail on constraining variables to integer solutions - show the `(integer)` qualifier syntax inside the `variables!` macro - update documentation links to use `latest` Add test in `variables.rs` showing `(integer)` qualifier * - conditional config for test - integer variables not suppored by "clarabel" solver --------- Co-authored-by: Niklas Smedemark-Margulies <niklas.smedemark-margulies@analog.com>
lovasoa
added a commit
that referenced
this pull request
Feb 18, 2025
* feat: allow defining initial values for individual variables * feat: support initial variable values for cbc * feat: support initial variable values for SCIP * docs: fix typo in `variable.initial()` docs * fix: compile * fix: parse * perf: track and leverage initial solution size Previously, when building up an initial solution from the problem variables would cause repeated reallocation. We support partial initial solutions so we may have 0-n values in the initial solution (with n being the number of total variables). We do not want to allocate memory for all variables because there might be 0 initial values, and we also do not want to do allocate 0 memory because then we have to repeatedly reallocate memory as the initial solution grows. These changes introduce a counter that is incrememted whenever a variable with an initial value is added to the problem. That way, we can allocate the perfect number of bytes upfront in all cases. * docs: add doctest for initial_solution_len * build: switch over to highs bindings from git * feat: support initial solutions for HiGHS * test: add first tests for HiGHS solver * explain more in readme * Docs: add readme details about restricting variables to have integer values (#78) * More details in README: - add more detail on constraining variables to integer solutions - show the `(integer)` qualifier syntax inside the `variables!` macro - update documentation links to use `latest` Add test in `variables.rs` showing `(integer)` qualifier * - conditional config for test - integer variables not suppored by "clarabel" solver --------- Co-authored-by: Niklas Smedemark-Margulies <niklas.smedemark-margulies@analog.com> * chore: do not bundle scip on docs.rs (#81) * chore: do not bundle scip on docs.rs * docs: add comment on docs.rs features * build: switch over to highs bindings from git * feat: support initial solutions for HiGHS * test: add first tests for HiGHS solver * build: update highs to 1.7.0 * Revert "build: update highs to 1.7.0" This reverts commit 8e0cb62. * build: update highs and russcip * refactor: drop unused imports * style: fix lint for empty check * Revert "refactor: drop unused imports" This reverts commit f1dcedb. * test: drop test for byte size * refactor: prefer is_empty over >0 * feat: add support for initial solutions with HiGHS * style: fix formatting * test: cover initial variable values for HiGHS * test: add time_limit=0 to tests for hot starts --------- Co-authored-by: lovasoa <contact@ophir.dev> Co-authored-by: Niklas <niklas.sm+github@gmail.com> Co-authored-by: Niklas Smedemark-Margulies <niklas.smedemark-margulies@analog.com>
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
More details in README:
(integer)qualifier syntax inside thevariables!macrolatestAdd test in
variables.rsshowing(integer)qualifier