Minor: Upgrade docs for PhysicalExpr::{propagate_constraints, evaluate_bounds}
#7812
Conversation
This file contains hidden or 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
alamb
commented
Oct 12, 2023
| /// If none of the child intervals change as a result of propagation, may | ||
| /// return an empty vector instead of cloning `children`. | ||
| /// | ||
| /// # Example |
There was a problem hiding this comment.
@metesynnada and @berkaysynnada -- I would appreciate it if you could double check this example. I think this is the kind of thing propagate_constraints can do, but I am not 100% sure I got the example correct
There was a problem hiding this comment.
The example you gave is clear and correct, thank you
For more detail:
- For plus operation, specifically, we would first do
- [a_lower, a_upper] <- ([expression_lower, expression_upper] - [b_lower, b_upper]) ∩ [a_lower, a_upper], and then
- [b_lower, b_upper] <- ([expression_lower, expression_upper] - [a_lower, a_upper]) ∩ [b_lower, b_upper].
Co-authored-by: Berkay Şahin <124376117+berkaysynnada@users.noreply.github.com>
github-actions
bot
removed
the
documentation
|
@metesynnada or @ozankabak could I trouble you for a review of this PR ? I can't merge it until a committer has marked it as approved
|
|
Thank you @ozankabak |
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.
Which issue does this PR close?
N/A
Rationale for this change
While reviewing #7804 (review) I spent time figuring out in more detail what these functions did. I figured I would save myself (and hopefully other future readers) some time in the future
What changes are included in this PR?
Add doc comments and examples for
PhysicalExpr::{propagate_constraints, evaluate_bounds}Are these changes tested?
Docs
Are there any user-facing changes?