UnsignedIntegerType

A set of common requirements for Swift's unsigned integer types.

Inheritance BidirectionalIndexType, BitwiseOperationsType, Comparable, Equatable, ForwardIndexType, Hashable, IntegerArithmeticType, IntegerLiteralConvertible, IntegerType, Printable, RandomAccessIndexType, Strideable, _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 Self values where one value is reachable from the other.

Reachability is defined by the ability to produce one value from the other via zero or more applications of successor.

  • _DisabledRangeIndex = _DisabledRangeIndex_

A type that can represent the number of steps between pairs of Self values where one value is reachable from the other.

Reachability is defined by the ability to produce one value from the other via zero or more applications of successor.

A type that can represent the distance between two values of Self

5 inherited items hidden. (Show all)
Import
  • import Swift

Initializers

init(integerLiteral:) Required

Create an instance initialized to value.

Declaration

Declared In

IntegerLiteralConvertible
init(_:) Required

Convert from Swift's widest unsigned integer type, trapping on overflow.

Declaration

Declared In

_UnsignedIntegerType

2 inherited items hidden. (Show all)

Static Variables

static var allZeros: Self Required

The empty bitset.

Also the identity element for | and ^, and the fixed point for &.

Declaration

  • static var allZeros: Self { get }

Declared In

BitwiseOperationsType

1 inherited item hidden. (Show all)

Instance Variables

var hashValue: Int Required

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 }

Declared In

Hashable
var description: String Required

A textual representation of self.

Declaration

  • var description: String { get }

Declared In

Printable

2 inherited items hidden. (Show all)

Static Methods

static func addWithOverflow(_:_:) Required

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: Self, _ rhs: Self) -> (Self, overflow: Bool)

Declared In

_IntegerArithmeticType
static func divideWithOverflow(_:_:) Required

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: Self, _ rhs: Self) -> (Self, overflow: Bool)

Declared In

_IntegerArithmeticType
static func multiplyWithOverflow(_:_:) Required

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: Self, _ rhs: Self) -> (Self, overflow: Bool)

Declared In

_IntegerArithmeticType
static func remainderWithOverflow(_:_:) Required

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: Self, _ rhs: Self) -> (Self, overflow: Bool)

Declared In

_IntegerArithmeticType
static func subtractWithOverflow(_:_:) Required

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: Self, _ rhs: Self) -> (Self, overflow: Bool)

Declared In

_IntegerArithmeticType

5 inherited items hidden. (Show all)

Instance Methods

func %(_:rhs:) Required

Divide 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
func &(_:rhs:) Required

Returns the intersection of bits set in lhs and rhs.

Complexity: O(1)

Declaration

  • func &(lhs: Self, rhs: Self) -> Self

Declared In

BitwiseOperationsType
func *(_:rhs:) Required

Multiply lhs and rhs, returning a result and trapping in case of arithmetic overflow (except in -Ounchecked builds).

Declaration

  • func *(lhs: Self, rhs: Self) -> Self

Declared In

IntegerArithmeticType
func +(_:rhs:) Required

Add lhs and rhs, returning a result and trapping in case of arithmetic overflow (except in -Ounchecked builds).

Declaration

  • func +(lhs: Self, rhs: Self) -> Self

Declared In

IntegerArithmeticType
func /(_:rhs:) Required

Divide lhs and rhs, returning a result and trapping in case of arithmetic overflow (except in -Ounchecked builds).

Declaration

  • func /(lhs: Self, rhs: Self) -> Self

Declared In

IntegerArithmeticType
func <(_:rhs:) Required

A strict total order over instances of Self

Declaration

  • func <(lhs: Self, rhs: Self) -> Bool

Declared In

_Comparable
func <=(_:rhs:)

Declaration

  • func <=(lhs: Self, rhs: Self) -> Bool

Declared In

Comparable
func ==(_:rhs:) Required

Return 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 is true
  • x == y implies y == x
  • x == y and y == z implies x == z

Inequality is the inverse of equality, i.e. !(x == y) iff x != y

Declaration

  • func ==(lhs: Self, rhs: Self) -> Bool

Declared In

Equatable
func >(_:rhs:)

Declaration

  • func >(lhs: Self, rhs: Self) -> Bool

Declared In

Comparable
func >=(_:rhs:)

Declaration

  • func >=(lhs: Self, rhs: Self) -> Bool

Declared In

Comparable
func ^(_:rhs:) Required

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
func |(_:rhs:) Required

Returns the union of bits set in lhs and rhs

Complexity: O(1)

Declaration

  • func |(lhs: Self, rhs: Self) -> Self

Declared In

BitwiseOperationsType
prefix func ~(_:) Required

Returns x ^ ~Self.allZeros

Complexity: O(1)

Declaration

  • prefix func ~(x: Self) -> Self

Declared In

BitwiseOperationsType
func -(_:rhs:) Required

Subtract lhs and rhs, returning a result and trapping in case of arithmetic overflow (except in -Ounchecked builds).

Declaration

  • func -(lhs: Self, rhs: Self) -> Self

Declared In

IntegerArithmeticType
func advancedBy(_:) Required

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)

Axioms:

  • x.advancedBy(0) == x
  • x.advancedBy(1) == x.successor()
  • x.advancedBy(-1) == x.predecessor()
  • x.distanceTo(x.advancedBy(m)) == m

Declaration

  • func advancedBy(n: Self.Distance) -> Self

Declared In

_RandomAccessIndexType, _Strideable
func distanceTo(_:) Required

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

Complexity: O(1).

Axioms:

  • x.distanceTo(x.successor())) == 1
  • x.distanceTo(x.predecessor())) == -1
  • x.advancedBy(x.distanceTo(y)) == y

Declaration

  • func distanceTo(other: Self) -> Self.Distance

Declared In

_RandomAccessIndexType, _Strideable
func predecessor() Required

Return 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

  • func predecessor() -> Self

Declared In

_BidirectionalIndexType
func successor() Required

Return the next consecutive value in a discrete sequence of Self values

Requires: self has a well-defined successor.

Declaration

  • func successor() -> Self

Declared In

_Incrementable
func toIntMax() Required

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

Declaration

Declared In

IntegerArithmeticType
func toUIntMax() Required

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

Declaration

Declared In

_UnsignedIntegerType

20 inherited items hidden. (Show all)