NFloat.MinMagnitudeNumber(NFloat, NFloat) Method

Definition

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

public:
 static System::Runtime::InteropServices::NFloat MinMagnitudeNumber(System::Runtime::InteropServices::NFloat x, System::Runtime::InteropServices::NFloat y) = System::Numerics::INumberBase<System::Runtime::InteropServices::NFloat>::MinMagnitudeNumber;
public static System.Runtime.InteropServices.NFloat MinMagnitudeNumber (System.Runtime.InteropServices.NFloat x, System.Runtime.InteropServices.NFloat y);
static member MinMagnitudeNumber : System.Runtime.InteropServices.NFloat * System.Runtime.InteropServices.NFloat -> System.Runtime.InteropServices.NFloat
Public Shared Function MinMagnitudeNumber (x As NFloat, y As NFloat) As NFloat

Parameters

x
NFloat

The value to compare with y.

y
NFloat

The value to compare with x.

Returns

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

Implements

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.

Applies to