INumberBase<TSelf>.MinMagnitude(TSelf, TSelf) Method

Definition

Compares two values to compute which has the lesser magnitude.

public:
 static TSelf MinMagnitude(TSelf x, TSelf y);
public static abstract TSelf MinMagnitude (TSelf x, TSelf y);
static member MinMagnitude : 'Self * 'Self -> 'Self
Public Shared Function MinMagnitude (x As TSelf, y As TSelf) As TSelf

Parameters

x
TSelf

The value to compare with y.

y
TSelf

The value to compare with x.

Returns

TSelf

x if it has a lesser magnitude than y; otherwise, y.

Remarks

For IFloatingPointIeee754<TSelf> this method matches the IEEE 754:2019 minimumMagnitude function. This requires NaN inputs to be propagated back to the caller and for -0.0 to be treated as less than +0.0.

Applies to