INumberBase<TSelf>.MaxMagnitude(TSelf, TSelf) Method
Definition
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.
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
.
Applies to
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.