INumberBase<TSelf>.MinMagnitudeNumber(TSelf, TSelf) Method

Definition

Namespace:

System.Numerics

Assembly:

System.Runtime.dll

Source:

INumberBase.cs

Compares two values to compute which has the lesser magnitude and returning the other value if an input is NaN.

public:
 static TSelf MinMagnitudeNumber(TSelf x, TSelf y);

public static abstract TSelf MinMagnitudeNumber (TSelf x, TSelf y);

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

Public Shared Function MinMagnitudeNumber (x As TSelf, y As TSelf) As TSelf

Parameters

x

TSelf

The value to compare with y.

y

TSelf

The value to compare with x.

Returns

TSelf

x if it has a lesser magnitude than y; otherwise, y.

Remarks

For IFloatingPointIeee754<TSelf> this method matches the IEEE 754:2019 minimumMagnitudeNumber function. This requires NaN inputs to not be propagated back to the caller and for -0.0 to be treated as less than +0.0.