Single.MinMagnitude(Single, Single) Method

Definition

Compares two values to compute which is lesser.

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

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

Implements

Remarks

For <see cref="T:System.Numerics.IFloatingPointIeee7541> this method matches the IEEE 754:2019 minimumMagnitudefunction. This requires NaN inputs to not be propagated back to the caller and for-0.0to be treated as less than+0.0`.

Applies to