Single.MinMagnitudeNumber(Single, Single) Method

Definition

Namespace:

System

Assembly:

System.Runtime.dll

Source:

Single.cs

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

public:
 static float MinMagnitudeNumber(float x, float y) = System::Numerics::INumberBase<float>::MinMagnitudeNumber;

public static float MinMagnitudeNumber (float x, float y);

static member MinMagnitudeNumber : single * single -> single

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

Parameters

x

Single

The value to compare with y.

y

Single

The value to compare with x.

Returns

Single

x if it is less than y; otherwise, y.

Implements

MinMagnitudeNumber(TSelf, TSelf)

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.