protocol FloatingPointType
Inheritance |
Comparable, Equatable, Strideable
View Protocol Hierarchy →
|
---|---|
Associated Types | |
Import | import Swift |
Initializers
Static Variables
The positive infinity.
Declaration
static var infinity: Self { get }
Instance Variables
The IEEE 754 "class" of this type.
Declaration
var floatingPointClass: FloatingPointClassification { get }
true
iff self
is zero, subnormal, or normal (not infinity
or NaN).
Declaration
var isFinite: Bool { get }
true
iff self
is normal (not zero, subnormal, infinity, or
NaN).
Declaration
var isNormal: Bool { get }
true
iff self
is a signaling NaN.
Declaration
var isSignaling: Bool { get }
true
iff self
is subnormal.
Declaration
var isSubnormal: Bool { get }
Instance Methods
A strict total order
over instances of Self
.
Declaration
func <(lhs: Self, rhs: Self) -> Bool
Declared In
Comparable
Returns true
if lhs
is equal to rhs
.
Equality implies substitutability. When x == y
, x
and
y
are interchangeable in any code that only depends on their
values.
Class instance identity as distinguished by triple-equals ===
is notably not part of an instance's value. Exposing other
non-value aspects of Equatable
types is discouraged, and any
that are exposed should be explicitly pointed out in
documentation.
Equality is an equivalence relation
x == x
istrue
x == y
impliesy == x
x == y
andy == z
impliesx == z
Inequality is the inverse of equality, i.e. !(x == y)
iff
x != y
.
Declaration
func ==(lhs: Self, rhs: Self) -> Bool
Declared In
Equatable
Returns a Self
x
such that self.distanceTo(x)
approximates
n
.
Complexity: O(1).
See Also: RandomAccessIndexType
's advancedBy
, which
provides a stronger semantic guarantee.
Declaration
func advancedBy(n: Self.Stride) -> Self
Declared In
Strideable
Returns a stride x
such that self.advancedBy(x)
approximates
other
.
Complexity: O(1).
See Also: RandomAccessIndexType
's distanceTo
, which provides a
stronger semantic guarantee.
Declaration
func distanceTo(other: Self) -> Self.Stride
Declared In
Strideable
Default Implementations
Returns the sequence of values (self
, self + stride
, self +
stride + stride
, ... last) where last is the last value in
the progression less than or equal to end
.
Note: There is no guarantee that end
is an element of the sequence.
Declaration
func stride(through end: Self, by stride: Self.Stride) -> StrideThrough<Self>
Declared In
Strideable
Returns the sequence of values (self
, self + stride
, self +
stride + stride
, ... last) where last is the last value in
the progression that is less than end
.
Declaration
func stride(to end: Self, by stride: Self.Stride) -> StrideTo<Self>
Declared In
Strideable
A set of common requirements for Swift's floating point types.