INumber<TSelf>.Clamp(TSelf, TSelf, TSelf) Method

Definition

Namespace:

System.Numerics

Assembly:

System.Runtime.dll

Source:

INumber.cs

Clamps a value to an inclusive minimum and maximum value.

public:
 static override TSelf Clamp(TSelf value, TSelf min, TSelf max);

public static virtual TSelf Clamp (TSelf value, TSelf min, TSelf max);

static member Clamp : 'Self * 'Self * 'Self -> 'Self

Public Shared Overrides Function Clamp (value As TSelf, min As TSelf, max As TSelf) As TSelf

Parameters

value

TSelf

The value to clamp.

min

TSelf

The inclusive minimum to which value should clamp.

max

TSelf

The inclusive maximum to which value should clamp.

Returns

TSelf

The result of clamping value to the inclusive range of min and max.

Exceptions

ArgumentException

min is greater than max.