Structure

Float

A single-precision, floating-point value type.

Declaration

@frozen struct Float

Topics

Converting Integers

init<Source>(Source)

Creates a new value, rounded to the closest possible representation.

init(Int)

Creates a new value, rounded to the closest possible representation.

Converting Strings

init?<S>(S)

Creates a new instance from the given string.

Converting Floating-Point Values

init<Source>(Source)

Creates a new instance from the given value, rounded to the closest possible representation.

init<Source>(Source)

Creates a new value, rounded to the closest possible representation.

init(Double)

Creates a new instance that approximates the given value.

init(Float)

Creates a new instance initialized to the given value.

init(Float80)

Creates a new instance that approximates the given value.

init(CGFloat)

Creates a new instance that approximates the given value.

init(signOf: Float, magnitudeOf: Float)

Creates a new floating-point value using the sign of one value and the magnitude of another.

init(sign: FloatingPointSign, exponent: Int, significand: Float)

Creates a new value from the given sign, exponent, and significand.

init(truncating: NSNumber)

Converting with No Loss of Precision

These initializers result in nil if the value passed can't be represented without any loss of precision.

init?<Source>(exactly: Source)

Creates a new instance from the given value, if it can be represented exactly.

init?(exactly: Double)

Creates a new instance initialized to the given value, if it can be represented without rounding.

init?(exactly: Float)

Creates a new instance initialized to the given value, if it can be represented without rounding.

init?(exactly: Float80)

Creates a new instance initialized to the given value, if it can be represented without rounding.

init?(exactly: NSNumber)
init?<Source>(exactly: Source)

Creates a new value, if the given integer can be represented exactly.

Creating a Random Value

static func random(in: Range<Float>) -> Float

Returns a random value within the specified range.

static func random<T>(in: Range<Float>, using: inout T) -> Float

Returns a random value within the specified range, using the given generator as a source for randomness.

static func random(in: ClosedRange<Float>) -> Float

Returns a random value within the specified range.

static func random<T>(in: ClosedRange<Float>, using: inout T) -> Float

Returns a random value within the specified range, using the given generator as a source for randomness.

Performing Calculations

Floating-Point Operators for Float

Perform arithmetic and bitwise operations or compare values.

func addingProduct(Float, Float) -> Float

Returns the result of adding the product of the two given values to this value, computed without intermediate rounding.

func addProduct(Float, Float)

Adds the product of the two given values to this value in place, computed without intermediate rounding.

func squareRoot() -> Float

Returns the square root of the value, rounded to a representable value.

func formSquareRoot()

Replaces this value with its square root, rounded to a representable value.

func remainder(dividingBy: Float) -> Float

Returns the remainder of this value divided by the given value.

func formRemainder(dividingBy: Float)

Replaces this value with the remainder of itself divided by the given value.

func truncatingRemainder(dividingBy: Float) -> Float

Returns the remainder of this value divided by the given value using truncating division.

func formTruncatingRemainder(dividingBy: Float)

Replaces this value with the remainder of itself divided by the given value using truncating division.

func negate()

Replaces this value with its additive inverse.

Rounding Values

func rounded() -> Float

Returns this value rounded to an integral value using “schoolbook rounding.”

func rounded(FloatingPointRoundingRule) -> Float

Returns this value rounded to an integral value using the specified rounding rule.

func round()

Rounds this value to an integral value using “schoolbook rounding.”

func round(FloatingPointRoundingRule)

Rounds the value to an integral value using the specified rounding rule.

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 minimum(Float, Float) -> Float

Returns the lesser of the two given values.

static func minimumMagnitude(Float, Float) -> Float

Returns the value with lesser magnitude.

Finding the Sign and Magnitude

var magnitude: Float

The magnitude of this value.

var sign: FloatingPointSign

The sign of the floating-point value.

typealias Float.Magnitude

A type that can represent the absolute value of any possible value of this type.

Querying a Float

var ulp: Float

The unit in the last place of this value.

var significand: Float

The significand of the floating-point value.

var exponent: Int

The exponent of the floating-point value.

var nextUp: Float

The least representable value that compares greater than this value.

var nextDown: Float

The greatest representable value that compares less than this value.

var binade: Float

The floating-point value with the same sign and exponent as this value, but with a significand of 1.0.

Accessing Numeric Constants

static var pi: Float

The mathematical constant pi.

static var infinity: Float

Positive infinity.

static var greatestFiniteMagnitude: Float

The greatest finite number representable by this type.

static var nan: Float

A quiet NaN (“not a number”).

static var signalingNaN: Float

A signaling NaN (“not a number”).

static var ulpOfOne: Float

The unit in the last place of 1.0.

static var leastNormalMagnitude: Float

The least positive normal number.

static var leastNonzeroMagnitude: Float

The least positive number.

static var zero: Float

The zero value.

Working with Binary Representation

var bitPattern: UInt32

The bit pattern of the value’s encoding.

var significandBitPattern: UInt32

The raw encoding of the value’s significand field.

var significandWidth: Int

The number of bits required to represent the value’s significand.

var exponentBitPattern: UInt

The raw encoding of the value’s exponent field.

static var significandBitCount: Int

The available number of fractional significand bits.

static var exponentBitCount: Int

The number of bits used to represent the type’s exponent.

static var radix: Int

The radix, or base of exponentiation, for this floating-point type.

init(bitPattern: UInt32)

Creates a new value with the given bit pattern.

init(sign: FloatingPointSign, exponentBitPattern: UInt, significandBitPattern: UInt32)

Creates a new instance from the specified sign and bit patterns.

init(nan: Float.RawSignificand, signaling: Bool)

Creates a NaN (“not a number”) value with the specified payload.

typealias Float.Exponent

A type that can represent any written exponent.

typealias Float.RawSignificand

A type that represents the encoded significand of a value.

Querying a Float's State

var isZero: Bool

A Boolean value indicating whether the instance is equal to zero.

var isFinite: Bool

A Boolean value indicating whether this instance is finite.

var isInfinite: Bool

A Boolean value indicating whether the instance is infinite.

var isNaN: Bool

A Boolean value indicating whether the instance is NaN (“not a number”).

var isSignalingNaN: Bool

A Boolean value indicating whether the instance is a signaling NaN.

var isNormal: Bool

A Boolean value indicating whether this instance is normal.

var isSubnormal: Bool

A Boolean value indicating whether the instance is subnormal.

var isCanonical: Bool

A Boolean value indicating whether the instance’s representation is in the canonical form.

var floatingPointClass: FloatingPointClassification

The classification of this value.

Encoding and Decoding Values

func encode(to: Encoder)

Encodes this value into the given encoder.

init(from: Decoder)

Creates a new instance by decoding from the given decoder.

Creating a Range

static func ..< (Float, Float) -> Range<Float>

Returns a half-open range that contains its lower bound but not its upper bound.

static func ... (Float, Float) -> ClosedRange<Float>

Returns a closed range that contains both of its bounds.

Describing a Float

func hash(into: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.

var description: String

A textual representation of the value.

var debugDescription: String

A textual representation of the value, suitable for debugging.

var customMirror: Mirror

A mirror that reflects the Float instance.

var hashValue: Int

The hash value.

SIMD-Supporting Types

typealias Float.SIMDMaskScalar
struct Float.SIMD2Storage

Storage for a vector of two floating-point values.

struct Float.SIMD4Storage

Storage for a vector of four floating-point values.

struct Float.SIMD8Storage

Storage for a vector of eight floating-point values.

struct Float.SIMD16Storage

Storage for a vector of 16 floating-point values.

struct Float.SIMD32Storage

Storage for a vector of 32 floating-point values.

struct Float.SIMD64Storage

Storage for a vector of 64 floating-point values.

Infrequently Used Functionality

init()

Creates a value initialized to zero.

init(integerLiteral: Int64)

Creates a new value from the given integer literal.

init(floatLiteral: Float)

Creates a new value from the given floating-point literal.

init(integerLiteral: Float)

Creates an instance initialized to the specified integer value.

func advanced(by: Float) -> Float

Returns a new value advanced by the given distance.

func distance(to: Float) -> Float

Returns the distance from this value to the specified value.

func write<Target>(to: inout Target)

Writes a textual representation of this instance into the given output stream.

Deprecated

init(NSNumber)Deprecated
var customPlaygroundQuickLook: _PlaygroundQuickLook

A custom playground Quick Look for the Float instance.

Deprecated

Type Aliases

typealias Float.BiquadFunctions
typealias Float.DFTFunctions
typealias Float.FloatLiteralType

A type that represents a floating-point literal.

typealias Float.IntegerLiteralType

A type that represents an integer literal.

typealias Float.RawExponent

A type that represents the encoded exponent of a value.

typealias Float.Stride

A type that represents the distance between two values.

Initializers

init(FPIEEE32)
init(_builtinFloatLiteral: FPIEEE64)
init(_builtinFloatLiteral: FPIEEE80)
init(_builtinIntegerLiteral: IntLiteral)

Instance Properties

var magnitudeSquared: Double

Instance Methods

func scale(by: Double)

Relationships

Conforms To

See Also

Numeric Values

struct Int

A signed integer value type.

struct Double

A double-precision, floating-point value type.