Skip to content
Merged
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
31 changes: 31 additions & 0 deletions packages/utils/src/math/utils.cairo
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,23 @@ impl SameSignImpl<
}
}

pub trait Clamp<T> {
fn clamp(self: T, min: T, max: T) -> T;
}

impl ClampImpl<T, +PartialOrd<T>, +Drop<T>, +Copy<T>> of Clamp<T> {
fn clamp(self: T, min: T, max: T) -> T {
assert!(min <= max, "min must be less than or equal to max");
if self < min {
min
} else if self > max {
max
} else {
self
}
}
}

#[cfg(test)]
mod tests {
use starkware_utils::constants::{MAX_U128, MAX_U64};
Expand Down Expand Up @@ -415,4 +432,18 @@ mod tests {
let num6: u64 = 0;
assert_eq!(num5.same_sign(num6), true, "same_sign failed");
}

#[test]
fn clamp_test() {
assert_eq!(10_u64.clamp(0_u64, 20_u64), 10_u64, "clamp failed");
assert_eq!((-10_i64).clamp(0_i64, 20_i64), 0_i64, "clamp failed");
assert_eq!(30_i64.clamp(0_i64, 20_i64), 20_i64, "clamp failed");
assert_eq!(10_u256.clamp(20_u256, 20_u256), 20_u256, "clamp failed");
}

#[test]
#[should_panic(expected: "min must be less than or equal to max")]
fn clamp_test_panic() {
10_i64.clamp(20_i64, 0_i64);
}
}