Display the source code in std/algorithm/comparison.d from which this page was generated on github.

If you spot a problem with this page, click here to create a Bugzilla issue.

Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using local clone.

Function `std.algorithm.comparison.clamp`

Clamps a value into the given bounds.


						
				auto clamp(T1, T2, T3)
				(
				

				  T1 val,
				

				  T2 lower,
				

				  T3 upper
				

				)
				

				if (is(typeof(max(min(val, upper), lower))));

This function is equivalent to max(lower, min(upper, val)).

Parameters

Name	Description
val	The value to clamp.
lower	The lower bound of the clamp.
upper	The upper bound of the clamp.

Returns

Returns val, if it is between lower and upper. Otherwise returns the nearest of the two.

Example

writeln(clamp(2, 1, 3)); // 2
writeln(clamp(0, 1, 3)); // 1
writeln(clamp(4, 1, 3)); // 3

writeln(clamp(1, 1, 1)); // 1

writeln(clamp(5, -1, 2u)); // 2

Authors

Andrei Alexandrescu

License

Boost License 1.0.