Double.MinMagnitudeNumber(Double, Double) Method

Definition

Namespace:

System

Assembly:

System.Runtime.dll

Source:

Double.cs

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

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

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

static member MinMagnitudeNumber : double * double -> double

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

Parameters

x

Double

The value to compare with y.

y

Double

The value to compare with x.

Returns

Double

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.