Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add min and max functions to the stdlib #4839

Merged
merged 3 commits into from
Apr 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/docs/noir/standard_library/traits.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,8 @@ impl<A, B, C, D, E> Eq for (A, B, C, D, E)
Implementing this trait on a type allows `<`, `<=`, `>`, and `>=` to be
used on values of the type.

`std::cmp` also provides `max` and `min` functions for any type which implements the `Ord` trait.

Implementations:

```rust
Expand Down
52 changes: 52 additions & 0 deletions noir_stdlib/src/cmp.nr
Original file line number Diff line number Diff line change
Expand Up @@ -314,3 +314,55 @@ impl<A, B, C, D, E> Ord for (A, B, C, D, E) where A: Ord, B: Ord, C: Ord, D: Ord
result
}
}

// Compares and returns the maximum of two values.
//
// Returns the second argument if the comparison determines them to be equal.
//
// # Examples
//
// ```
// use std::cmp;
//
// assert_eq(cmp::max(1, 2), 2);
// assert_eq(cmp::max(2, 2), 2);
// ```
pub fn max<T>(v1: T, v2: T) -> T where T: Ord {
if v1 > v2 { v1 } else { v2 }
}

// Compares and returns the minimum of two values.
//
// Returns the first argument if the comparison determines them to be equal.
//
// # Examples
//
// ```
// use std::cmp;
//
// assert_eq(cmp::min(1, 2), 1);
// assert_eq(cmp::min(2, 2), 2);
// ```
pub fn min<T>(v1: T, v2: T) -> T where T: Ord {
if v1 > v2 { v2 } else { v1 }
}

mod cmp_tests {
use crate::cmp::{min, max};

#[test]
fn sanity_check_min() {
assert_eq(min(0 as u64, 1 as u64), 0);
assert_eq(min(0 as u64, 0 as u64), 0);
assert_eq(min(1 as u64, 1 as u64), 1);
assert_eq(min(255 as u8, 0 as u8), 0);
}

#[test]
fn sanity_check_max() {
assert_eq(max(0 as u64, 1 as u64), 1);
assert_eq(max(0 as u64, 0 as u64), 0);
assert_eq(max(1 as u64, 1 as u64), 1);
assert_eq(max(255 as u8, 0 as u8), 255);
}
}
Loading