Double.MaxMagnitudeNumber(Double, Double) Method

Definition

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

public:
 static double MaxMagnitudeNumber(double x, double y) = System::Numerics::INumberBase<double>::MaxMagnitudeNumber;
public static double MaxMagnitudeNumber (double x, double y);
static member MaxMagnitudeNumber : double * double -> double
Public Shared Function MaxMagnitudeNumber (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

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

Implements

Remarks

For IFloatingPointIeee754<TSelf> this method matches the IEEE 754:2019 maximumMagnitudeNumber 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