struct UInt16
Inheritance |
BidirectionalIndexType, BitwiseOperationsType, CVarArgType, Comparable, CustomStringConvertible, Equatable, ForwardIndexType, Hashable, IntegerArithmeticType, IntegerLiteralConvertible, IntegerType, RandomAccessIndexType, Strideable, UnsignedIntegerType, _DisallowMixedSignArithmetic, _Incrementable, _IntegerArithmeticType, _IntegerType, _RandomAccessAmbiguity, _Reflectable
View Protocol Hierarchy →
|
---|---|
Associated Types | |
Import | import Swift |
Initializers
Creates an integer from its big-endian representation, changing the byte order if necessary.
Declaration
init(bigEndian value: UInt16)
Construct a UInt16
having the same memory representation as
the Int16
bitPattern
. No range or overflow checking
occurs, and the resulting UInt16
may not have the same numeric
value as bitPattern
--it is only guaranteed to use the same
pattern of bits.
Declaration
init(bitPattern: Int16)
Create an instance initialized to value
.
Declaration
init(integerLiteral value: UInt16)
Creates an integer from its little-endian representation, changing the byte order if necessary.
Declaration
init(littleEndian value: UInt16)
Construct a UInt16
having the same bitwise representation as
the least significant bits of the provided bit pattern.
No range or overflow checking occurs.
Declaration
init(truncatingBitPattern: Int)
Construct a UInt16
having the same bitwise representation as
the least significant bits of the provided bit pattern.
No range or overflow checking occurs.
Declaration
init(truncatingBitPattern: Int32)
Construct a UInt16
having the same bitwise representation as
the least significant bits of the provided bit pattern.
No range or overflow checking occurs.
Declaration
init(truncatingBitPattern: Int64)
Construct a UInt16
having the same bitwise representation as
the least significant bits of the provided bit pattern.
No range or overflow checking occurs.
Declaration
init(truncatingBitPattern: UInt)
Construct a UInt16
having the same bitwise representation as
the least significant bits of the provided bit pattern.
No range or overflow checking occurs.
Declaration
init(truncatingBitPattern: UInt32)
Construct a UInt16
having the same bitwise representation as
the least significant bits of the provided bit pattern.
No range or overflow checking occurs.
Declaration
init(truncatingBitPattern: UInt64)
Construct from an ASCII representation in the given radix
.
If text
does not match the regular expression
"[+-]?[0-9a-zA-Z]+", or the value it denotes in the given radix
is not representable, the result is nil
.
Declaration
init?(_ text: String, radix: Int = default)
Static Variables
The empty bitset of type UInt16.
Declaration
static var allZeros: UInt16 { get }
Instance Variables
Returns the big-endian representation of the integer, changing the byte order if necessary.
Declaration
var bigEndian: UInt16 { get }
Returns the current integer with the byte order swapped.
Declaration
var byteSwapped: UInt16 { get }
A textual representation of self
.
Declaration
var description: String { get }
The hash value.
Axiom: x == y
implies x.hashValue == y.hashValue
.
Note: The hash value is not guaranteed to be stable across different invocations of the same program. Do not persist the hash value across program runs.
Declaration
var hashValue: Int { get }
Returns the little-endian representation of the integer, changing the byte order if necessary.
Declaration
var littleEndian: UInt16 { get }
Static Methods
Add lhs
and rhs
, returning a result and a
Bool
that is true
iff the operation caused an arithmetic
overflow.
Declaration
static func addWithOverflow(lhs: UInt16, _ rhs: UInt16) -> (UInt16, overflow: Bool)
Divide lhs
and rhs
, returning
a result and a Bool
that is true
iff the operation caused an arithmetic overflow.
Declaration
static func divideWithOverflow(lhs: UInt16, _ rhs: UInt16) -> (UInt16, overflow: Bool)
Multiply lhs
and rhs
, returning a result and a
Bool
that is true
iff the operation caused an arithmetic
overflow.
Declaration
static func multiplyWithOverflow(lhs: UInt16, _ rhs: UInt16) -> (UInt16, overflow: Bool)
Divide lhs
and rhs
, returning
the remainder and a Bool
that is true
iff the operation caused an arithmetic overflow.
Declaration
static func remainderWithOverflow(lhs: UInt16, _ rhs: UInt16) -> (UInt16, overflow: Bool)
Subtract lhs
and rhs
, returning a result and a
Bool
that is true
iff the operation caused an arithmetic
overflow.
Declaration
static func subtractWithOverflow(lhs: UInt16, _ rhs: UInt16) -> (UInt16, overflow: Bool)
Instance Methods
Declaration
func advancedBy(n: Distance) -> UInt16
Declared In
UInt16
, 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
func advancedBy(n: UInt16.Distance, limit: UInt16) -> UInt16
Declared In
IntegerType
, RandomAccessIndexType
, BidirectionalIndexType
, ForwardIndexType
Declaration
func distanceTo(other: UInt16) -> Distance
Declared In
UInt16
, IntegerType
, RandomAccessIndexType
, BidirectionalIndexType
, ForwardIndexType
Returns the previous consecutive value before self
.
Requires: The previous value is representable.
Declaration
func predecessor() -> UInt16
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: UInt16, by stride: UInt16.Stride) -> StrideThrough<UInt16>
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
func stride(to end: UInt16, by stride: UInt16.Stride) -> StrideTo<UInt16>
Declared In
IntegerType
, RandomAccessIndexType
, Strideable
Returns the next consecutive value after self
.
Requires: The next value is representable.
Declaration
func successor() -> UInt16
Represent this number using Swift's widest native unsigned integer type.
Declaration
func toUIntMax() -> UIntMax
A 16-bit unsigned integer value type.