UInt64

A 64-bit unsigned integer value type.

Inheritance BidirectionalIndexType, BitwiseOperationsType, CVarArgType, Comparable, Equatable, ForwardIndexType, Hashable, IntegerArithmeticType, IntegerLiteralConvertible, IntegerType, Printable, RandomAccessIndexType, Reflectable, Strideable, UnsignedIntegerType, _BidirectionalIndexType, _Comparable, _ForwardIndexType, _Incrementable, _IntegerArithmeticType, _IntegerType, _RandomAccessIndexType, _Strideable, _UnsignedIntegerType View Protocol Hierarchy →
Associated Types

A type that can represent the number of steps between pairs of values.

Import
  • import Swift

Initializers

init()

Create an instance initialized to zero.

Declaration

  • init()
init(_: Double)

Construct an instance that approximates other.

Declaration

init(_: Float)

Construct an instance that approximates other.

Declaration

init(_: Float80)

Construct an instance that approximates other.

Declaration

init(_: Int)

Declaration

init(_: Int8)

Declaration

init(_: Int16)

Declaration

init(_: Int32)

Declaration

init(_: Int64)

Declaration

init(_: UInt)

Declaration

init(_: UInt8)

Declaration

init(_: UInt16)

Declaration

init(_: UInt32)

Declaration

init(_: UInt64)

Create an instance initialized to value.

Declaration

init(_: UnicodeScalar)

Construct with value v.value.

Requires: v.value can be represented as UInt64.

Declaration

init(_builtinIntegerLiteral:)

Declaration

  • init(_builtinIntegerLiteral value: Builtin.Int2048)
init(bigEndian:)

Creates an integer from its big-endian representation, changing the byte order if necessary.

Declaration

init(bitPattern:)

Construct a UInt64 having the same memory representation as the Int64 bitPattern. No range or overflow checking occurs, and the resulting UInt64 may not have the same numeric value as bitPattern--it is only guaranteed to use the same pattern of bits.

Declaration

init(integerLiteral:)

Create an instance initialized to value.

Declaration

  • init(integerLiteral value: UInt64)
init(littleEndian:)

Creates an integer from its little-endian representation, changing the byte order if necessary.

Declaration

  • init(littleEndian value: UInt64)

Static Variables

static var allZeros: UInt64

The empty bitset of type UInt64.

Declaration

  • static var allZeros: UInt64 { get }
static var max: UInt64

Declaration

  • static var max: UInt64 { get }
static var min: UInt64

Declaration

  • static var min: UInt64 { get }

Instance Variables

var bigEndian: UInt64

Returns the big-endian representation of the integer, changing the byte order if necessary.

Declaration

var byteSwapped: UInt64

Returns the current integer with the byte order swapped.

Declaration

  • var byteSwapped: UInt64 { get }
var description: String

A textual representation of self.

Declaration

  • var description: String { get }
var hashValue: Int

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 }
var littleEndian: UInt64

Returns the little-endian representation of the integer, changing the byte order if necessary.

Declaration

  • var littleEndian: UInt64 { get }
var value: Builtin.Int64

Declaration

  • var value: Builtin.Int64 { get set }

Static Methods

static func addWithOverflow(_:_:)

Add lhs and rhs, returning a result and a Bool that is true iff the operation caused an arithmetic overflow.

Declaration

static func divideWithOverflow(_:_:)

Divide lhs and rhs, returning a result and a Bool that is true iff the operation caused an arithmetic overflow.

Declaration

static func multiplyWithOverflow(_:_:)

Multiply lhs and rhs, returning a result and a Bool that is true iff the operation caused an arithmetic overflow.

Declaration

static func remainderWithOverflow(_:_:)

Divide lhs and rhs, returning the remainder and a Bool that is true iff the operation caused an arithmetic overflow.

Declaration

static func subtractWithOverflow(_:_:)

Subtract lhs and rhs, returning a result and a Bool that is true iff the operation caused an arithmetic overflow.

Declaration

Instance Methods

func advancedBy(_:)

Return self offset by n steps.

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.

Complexity: O(1)

Declaration

  • func advancedBy(amount: Distance) -> UInt64
func distanceTo(_:)

Return the minimum number of applications of successor or predecessor required to reach other from self.

Complexity: O(1).

Declaration

  • func distanceTo(other: UInt64) -> Distance
func encode()

Transform self into a series of machine words that can be appropriately interpreted by C varargs

Declaration

  • func encode() -> [Word]
func getMirror()

Returns a mirror that reflects self.

Declaration

func predecessor()

Returns the previous consecutive value before self.

Requires: the previous value is representable.

Declaration

func successor()

Returns the next consecutive value after self.

Requires: the next value is representable.

Declaration

func toIntMax()

Explicitly convert to IntMax, trapping on overflow (except in -Ounchecked builds).

Declaration

func toUIntMax()

Represent this number using Swift's widest native unsigned integer type.

Declaration