Double.MinMagnitude(Double, Double) Method

Definition

Compares two values to compute which is lesser.

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

Implements

Remarks

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