Restricts x to the interval [min_val, max_val].
Values outside the range are replaced by the nearest bound.
Usage
clamp(x, min_val, max_val, warn = TRUE, param_name = "value")
Arguments
- x
Numeric value or vector
- min_val
Lower bound
- max_val
Upper bound
- warn
Logical; issue a warning when clamping occurs, default TRUE
- param_name
Name used in warning messages
Value
x with values outside [min_val, max_val] replaced by the bounds
Examples
suppressWarnings(clamp(1.5, 0, 1))
#> [1] 1
suppressWarnings(clamp(-0.5, 0, 1))
#> [1] 0
clamp(0.3, 0, 1)
#> [1] 0.3
suppressWarnings(clamp(c(-1, 0.5, 2), 0, 1))
#> [1] 0.0 0.5 1.0
