Clean up documentation of the SAT API #1020
Merged
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
bclement-ocp
approved these changes
Jan 3, 2024
| val optimize : t -> is_max:bool -> Expr.t -> unit | ||
| (** [optimize env ~is_max o] registers the expression [o] as an objective | ||
| function. |
There was a problem hiding this comment.
Should briefly mention the meaning of is_max (maximize vs minimize).
src/lib/reasoners/sat_solver_sig.ml
Outdated
| val unsat : t -> Expr.gformula -> Explanation.t | ||
| (** [unsat env f size] checks the unsatisfiability of [f] in [env]. |
There was a problem hiding this comment.
There is no size argument? unsat has only two arguments; this seems outdated.
Halbaroth
force-pushed
the
clean-up-sat-doc
branch
from
48276ee to
e5c81f1
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
The documentation of the SAT API was a bit outdated and don't use some tags of
odoc.I also merge
emptyandempty_with_instinto a single function. Currently, the second function is only used by the JS worker.The argument of this constructor is supposed to filter ground facts generated by the instantiation engine but the JS worker uses it only to register all these facts.