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

Reference

Definition

Namespace:: System.Numerics

Assembly:: System.Runtime.dll

Source:: INumberBase.cs

Source:: INumberBase.cs

Source:: INumberBase.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

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

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

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

Public Shared Function MaxMagnitudeNumber (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 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

Jaa