Type Method

minimum(_:_:)

Returns the lesser of the two given values.

Declaration

static func minimum(_ x: Float, _ y: Float) -> Float

Parameters

x

A floating-point value.

y

Another floating-point value.

Return Value

The minimum of x and y, or whichever is a number if the other is NaN.

Discussion

This method returns the minimum of two values, preserving order and eliminating NaN when possible. For two values x and y, the result of minimum(x, y) is x if x <= y, y if y < x, 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.minimum(10.0, -25.0)
// -25.0
Double.minimum(10.0, .nan)
// 10.0
Double.minimum(.nan, -25.0)
// -25.0
Double.minimum(.nan, .nan)
// nan

The minimum method implements the minNum operation defined by the IEEE 754 specification.

See Also

Comparing Values

Floating-Point Operators for Float

Perform arithmetic and bitwise operations or compare values.

func isEqual(to: Float) -> Bool

Returns a Boolean value indicating whether this instance is equal to the given value.

func isLess(than: Float) -> Bool

Returns a Boolean value indicating whether this instance is less than the given value.

func isLessThanOrEqualTo(Float) -> Bool

Returns a Boolean value indicating whether this instance is less than or equal to the given value.

func isTotallyOrdered(belowOrEqualTo: Float) -> Bool

Returns a Boolean value indicating whether this instance should precede or tie positions with the given value in an ascending sort.

static func maximum(Float, Float) -> Float

Returns the greater of the two given values.

static func maximumMagnitude(Float, Float) -> Float

Returns the value with greater magnitude.

static func minimumMagnitude(Float, Float) -> Float

Returns the value with lesser magnitude.