Type Method

maximumMagnitude(_:_:)

Returns the value with greater magnitude.

Required. Default implementation provided.

Declaration

static func maximumMagnitude(_ x: Self, _ y: Self) -> Self

Parameters

x

A floating-point value.

y

Another floating-point value.

Return Value

Whichever of x or y has greater magnitude, or whichever is a number if the other is NaN.

Discussion

This method returns the value with greater magnitude of the two given values, preserving order and eliminating NaN when possible. For two values x and y, the result of maximumMagnitude(x, y) is x if x.magnitude > y.magnitude, y if x.magnitude <= y.magnitude, or whichever of x or y is a number if the other is a quiet NaN. If both x and y are NaN, or either x or y is a signaling NaN, the result is NaN.

Double.maximumMagnitude(10.0, -25.0)
// -25.0
Double.maximumMagnitude(10.0, .nan)
// 10.0
Double.maximumMagnitude(.nan, -25.0)
// -25.0
Double.maximumMagnitude(.nan, .nan)
// nan

The maximumMagnitude method implements the maxNumMag operation defined by the IEEE 754 specification.

Default Implementations

FloatingPoint Implementations

static func maximumMagnitude(Self, Self) -> Self

Returns the value with greater magnitude.