protocolUnsignedIntegerType
| Inheritance |
BidirectionalIndexType, BitwiseOperationsType, Comparable, CustomStringConvertible, Equatable, ForwardIndexType, Hashable, IntegerArithmeticType, IntegerLiteralConvertible, IntegerType, RandomAccessIndexType, Strideable, _DisallowMixedSignArithmetic, _Incrementable, _IntegerArithmeticType, _IntegerType, _RandomAccessAmbiguity
View Protocol Hierarchy →
|
|---|---|
| Associated Types |
A type that can represent the number of steps between pairs of
Reachability is defined by the ability to produce one value from
the other via zero or more applications of
A type that can represent the distance between two values of 3 inherited items hidden. (Show all) |
| Import |
|
Initializers
Convert from Swift's widest unsigned integer type, trapping on overflow.
Declaration
init(_:UIntMax)
Create an instance initialized to value.
Declaration
init(integerLiteralvalue:Self.IntegerLiteralType)
Declared In
IntegerLiteralConvertible
1 inherited item hidden. (Show all)
Static Variables
The empty bitset.
Also the identity element for | and
^, and the fixed point for
&.
Declaration
staticvarallZeros:Self{get}
Declared In
BitwiseOperationsType
1 inherited item hidden. (Show all)
Instance Variables
A textual representation of self.
Declaration
vardescription:String{get}
Declared In
CustomStringConvertible
2 inherited items hidden. (Show all)
Static Methods
Adds lhs and rhs, returning the result and a Bool that is
true iff the operation caused an arithmetic overflow.
Declaration
staticfuncaddWithOverflow(lhs:Self,_rhs:Self) ->(Self,overflow:Bool)
Declared In
_IntegerArithmeticType
Divides lhs and rhs, returning the result and a Bool that is
true iff the operation caused an arithmetic overflow.
Declaration
staticfuncdivideWithOverflow(lhs:Self,_rhs:Self) ->(Self,overflow:Bool)
Declared In
_IntegerArithmeticType
Multiplies lhs and rhs, returning the result and a Bool that is
true iff the operation caused an arithmetic overflow.
Declaration
staticfuncmultiplyWithOverflow(lhs:Self,_rhs:Self) ->(Self,overflow:Bool)
Declared In
_IntegerArithmeticType
Divides lhs and rhs, returning the remainder and a Bool that is
true iff the operation caused an arithmetic overflow.
Declaration
staticfuncremainderWithOverflow(lhs:Self,_rhs:Self) ->(Self,overflow:Bool)
Declared In
_IntegerArithmeticType
Subtracts lhs and rhs, returning the result and a Bool that is
true iff the operation caused an arithmetic overflow.
Declaration
staticfuncsubtractWithOverflow(lhs:Self,_rhs:Self) ->(Self,overflow:Bool)
Declared In
_IntegerArithmeticType
5 inherited items hidden. (Show all)
Instance Methods
Divides lhs and rhs, returning the remainder and trapping in case of
arithmetic overflow (except in -Ounchecked builds).
Declaration
func%(lhs:Self,rhs:Self) ->Self
Declared In
IntegerArithmeticType
Returns the intersection of bits set in lhs and rhs.
Complexity: O(1).
Declaration
func&(lhs:Self,rhs:Self) ->Self
Declared In
BitwiseOperationsType
Multiplies lhs and rhs, returning the result and trapping in case of
arithmetic overflow (except in -Ounchecked builds).
Declaration
func*(lhs:Self,rhs:Self) ->Self
Declared In
IntegerArithmeticType
Adds lhs and rhs, returning the result and trapping in case of
arithmetic overflow (except in -Ounchecked builds).
Declaration
func+(lhs:Self,rhs:Self) ->Self
Declared In
IntegerArithmeticType
Divides lhs and rhs, returning the result and trapping in case of
arithmetic overflow (except in -Ounchecked builds).
Declaration
func/(lhs:Self,rhs:Self) ->Self
Declared In
IntegerArithmeticType
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 == xistruex == yimpliesy == xx == yandy == zimpliesx == 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 the bits that are set in exactly one of lhs and rhs.
Complexity: O(1).
Declaration
func^(lhs:Self,rhs:Self) ->Self
Declared In
BitwiseOperationsType
Returns the union of bits set in lhs and rhs.
Complexity: O(1).
Declaration
func|(lhs:Self,rhs:Self) ->Self
Declared In
BitwiseOperationsType
Returns x ^ ~Self.allZeros.
Complexity: O(1).
Declaration
prefixfunc~(x:Self) ->Self
Declared In
BitwiseOperationsType
Subtracts lhs and rhs, returning the result and trapping in case of
arithmetic overflow (except in -Ounchecked builds).
Declaration
func-(lhs:Self,rhs:Self) ->Self
Declared In
IntegerArithmeticType
Returns the result of advancing self by n positions.
Returns:
- If n > 0, the result of applying successor to self n times.
- If n < 0, the result of applying predecessor to self -n times.
- Otherwise, self.
Requires: n >= 0 if only conforming to ForwardIndexType
Complexity:
- O(1) if conforming to RandomAccessIndexType
- O(abs(n)) otherwise
Declaration
funcadvancedBy(n:Self.Distance) ->Self
Declared In
ForwardIndexType, RandomAccessIndexType, Strideable
Returns the result of advancing self by n positions, or until it
equals limit.
Returns:
- If n > 0, the result of applying successor to self n times
but not past limit.
- If n < 0, the result of applying predecessor to self -n times
but not past limit.
- Otherwise, self.
Requires: n >= 0 if only conforming to ForwardIndexType.
Complexity:
- O(1) if conforming to RandomAccessIndexType
- O(abs(n)) otherwise
Declaration
funcadvancedBy(n:Self.Distance,limit:Self) ->Self
Declared In
ForwardIndexType, RandomAccessIndexType
Measure the distance between self and end.
Requires:
- start and end are part of the same sequence when conforming to
RandomAccessSequenceType.
- end is reachable from self by incrementation otherwise.
Complexity:
- O(1) if conforming to RandomAccessIndexType
- O(n) otherwise, where n is the function's result.
Declaration
funcdistanceTo(end:Self) ->Self.Distance
Declared In
ForwardIndexType, RandomAccessIndexType, Strideable
Returns the previous consecutive value in a discrete sequence.
If self has a well-defined successor,
self.successor().predecessor() == self. If self has a
well-defined predecessor, self.predecessor().successor() ==
self.
Requires: self has a well-defined predecessor.
Declaration
funcpredecessor() ->Self
Declared In
BidirectionalIndexType
Returns the next consecutive value in a discrete sequence of
Self values.
Requires: self has a well-defined successor.
Declaration
funcsuccessor() ->Self
Declared In
_Incrementable
Explicitly convert to IntMax, trapping on overflow (except in
-Ounchecked builds).
Declaration
functoIntMax() ->IntMax
Declared In
IntegerArithmeticType
Represent this number using Swift's widest native unsigned integer type.
Declaration
functoUIntMax() ->UIntMax
20 inherited items hidden. (Show all)
Default Implementations
Returns the result of advancing self by n positions.
Returns:
- If n > 0, the result of applying successor to self n times.
- If n < 0, the result of applying predecessor to self -n times.
- Otherwise, self.
Requires: n >= 0 if only conforming to ForwardIndexType
Complexity:
- O(1) if conforming to RandomAccessIndexType
- O(abs(n)) otherwise
Declaration
funcadvancedBy(n:Self.Distance) ->Self
Declared In
IntegerType, RandomAccessIndexType, BidirectionalIndexType, _RandomAccessAmbiguity, ForwardIndexType
Returns the result of advancing self by n positions, or until it
equals limit.
Returns:
- If n > 0, the result of applying successor to self n times
but not past limit.
- If n < 0, the result of applying predecessor to self -n times
but not past limit.
- Otherwise, self.
Requires: n >= 0 if only conforming to ForwardIndexType.
Complexity:
- O(1) if conforming to RandomAccessIndexType
- O(abs(n)) otherwise
Declaration
funcadvancedBy(n:Self.Distance,limit:Self) ->Self
Declared In
IntegerType, RandomAccessIndexType, BidirectionalIndexType, ForwardIndexType
Measure the distance between self and end.
Requires:
- start and end are part of the same sequence when conforming to
RandomAccessSequenceType.
- end is reachable from self by incrementation otherwise.
Complexity:
- O(1) if conforming to RandomAccessIndexType
- O(n) otherwise, where n is the function's result.
Declaration
funcdistanceTo(end:Self) ->Self.Distance
Declared In
IntegerType, RandomAccessIndexType, BidirectionalIndexType, ForwardIndexType
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
funcstride(throughend:Self,bystride:Self.Stride) ->StrideThrough<Self>
Declared In
IntegerType, RandomAccessIndexType, 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
funcstride(toend:Self,bystride:Self.Stride) ->StrideTo<Self>
Declared In
IntegerType, RandomAccessIndexType, Strideable
5 inherited items hidden. (Show all)
A set of common requirements for Swift's unsigned integer types.