Add @math.maximum() and @math.minimum()
#35
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
fantix
commented
Mar 9, 2024
| /// print(@math.maximum(1, 2)) // output: 2 | ||
| /// print(@math.maximum(2, 2)) // output: 2 | ||
| /// ``` | ||
| pub fn maximum[T : Compare](x : T, y : T) -> T { |
There was a problem hiding this comment.
The full name maximum follows the convention in list/list.mbt:
Line 497 in ad0d7c8
However, I personally prefer max and min, thoughts?
math/algebraic.mbt
Outdated
Comment on lines
83
to
87
| let v1 = 1 | ||
| let v2 = 2 | ||
| let x1 = "v\(v1)" | ||
| let x2 = "v\(v2)" | ||
|
|
||
| // We need another value that `== x2` but not `=== x2` | ||
| let x2t = "v\(v2)" | ||
| @assertion.assert_is_not(x2, x2t).unwrap() |
There was a problem hiding this comment.
Do we have a way to reuse code for testing, without introducing footprints in release builds?
There was a problem hiding this comment.
yes, we are working on that.
Comment on lines
+18
to
+24
| /// Compares and returns the maximum of two values. | ||
| /// | ||
| /// Returns the second argument if the comparison determines them to be equal. | ||
| /// | ||
| /// # Examples | ||
| /// | ||
| /// ``` | ||
| /// print(@math.maximum(1, 2)) // output: 2 | ||
| /// print(@math.maximum(2, 2)) // output: 2 | ||
| /// ``` |
There was a problem hiding this comment.
About conventions of doc strings:
- I used "Compares" instead of "Compare", while both forms can be found in the code base. I believe it implies "(this function) compares and returns ...".
- I used "Examples" instead of "Example" because I do have multiple examples. I think we should stick with "Examples" (like Rust) across the repo even if it's just a single example.
- I used
@math.maximuminstead of justmaximumso that users could directly copy it from the documentation and run without errors. - I'm not sure we like the
print(...) // output: ...style in doc strings, it's incompatible with potential future doc tests. Though,@assertion.assert_eq(@math.maximum(1, 2), 2)is just too long to read, so I ended up following what the rest of this repo has been doing.
There was a problem hiding this comment.
Thanks for the suggestions, about the last one, we will consider generate example based docs directly from test "example"
This was referenced Mar 9, 2024
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.
@mathpackage (Rust put min and max instd::cmpthough)Ported from muts.