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

Definition

Namespace:

System.Numerics

Assembly:

System.Runtime.dll

Source:

INumberBase.cs

Compares two values to compute which has the greater magnitude.

public:
 static TSelf MaxMagnitude(TSelf x, TSelf y);

public static abstract TSelf MaxMagnitude (TSelf x, TSelf y);

static member MaxMagnitude : 'Self * 'Self -> 'Self

Public Shared Function MaxMagnitude (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 greater magnitude than y; otherwise, y.

Remarks

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