## BinaryInteger

protocol BinaryInteger
Inheritance Arithmetic, Comparable, CustomStringConvertible, Equatable, ExpressibleByIntegerLiteral View Protocol Hierarchy → Magnitude : Equatable, ExpressibleByIntegerLiteral IntegerLiteralType A type that represents an integer literal. The standard library integer and floating-point types are all valid types for IntegerLiteralType. import Swift

### Initializers

init<T where T : BinaryInteger>(_: T)

#### Declaration

init<T where T : BinaryInteger>(_ source: T)
init<T where T : FloatingPoint>(_: T)

#### Declaration

init<T where T : FloatingPoint>(_ source: T)
init(clamping:) Required

#### Declaration

init<T where T : BinaryInteger>(clamping source: T)
init(extendingOrTruncating:) Required

#### Declaration

init<T where T : BinaryInteger>(extendingOrTruncating source: T)
init?(exactly:)

#### Declaration

init?<T where T : FloatingPoint>(exactly source: T)
init(integerLiteral:)

Creates an instance initialized to the specified integer value.

Do not call this initializer directly. Instead, initialize a variable or constant using an integer literal. For example:

let x = 23

In this example, the assignment to the x constant calls this integer literal initializer behind the scenes.

value: The value to create.

#### Declaration

init(integerLiteral value: Self.IntegerLiteralType)

#### Declared In

ExpressibleByIntegerLiteral

### Static Variables

static var isSigned: Bool Required

#### Declaration

static var isSigned: Bool { get }

### Instance Variables

var bitWidth: Int Required

#### Declaration

var bitWidth: Int { get }
var minimumSignedRepresentationBitWidth: Int Required

#### Declaration

var minimumSignedRepresentationBitWidth: Int { get }
var magnitude: Self.Magnitude Required

#### Declaration

var magnitude: Self.Magnitude { get }

#### Declared In

Arithmetic
var description: String Required

A textual representation of this instance.

Instead of accessing this property directly, convert an instance of any type to a string by using the String(describing:) initializer. For example:

struct Point: CustomStringConvertible {
let x: Int, y: Int

var description: String {
return "(\(x), \(y))"
}
}

let p = Point(x: 21, y: 30)
let s = String(describing: p)
print(s)
// Prints "(21, 30)"

The conversion of p to a string in the assignment to s uses the Point type's description property.

#### Declaration

var description: String { get }

#### Declared In

CustomStringConvertible

### Instance Methods

func <(_:rhs:) Required

Returns a Boolean value indicating whether the value of the first argument is less than that of the second argument.

This function is the only requirement of the Comparable protocol. The remainder of the relational operator functions are implemented by the standard library for any type that conforms to Comparable.

Parameters: lhs: A value to compare. rhs: Another value to compare.

#### Declaration

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

#### Declared In

Comparable
func <=(_:rhs:)

Returns a Boolean value indicating whether the value of the first argument is less than or equal to that of the second argument.

Parameters: lhs: A value to compare. rhs: Another value to compare.

#### Declaration

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

#### Declared In

Comparable
func ==(_:rhs:) Required

Returns a Boolean value indicating whether two values are equal.

Equality is the inverse of inequality. For any values a and b, a == b implies that a != b is false.

Parameters: lhs: A value to compare. rhs: Another value to compare.

#### Declaration

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

#### Declared In

Equatable
func >(_:rhs:)

Returns a Boolean value indicating whether the value of the first argument is greater than that of the second argument.

Parameters: lhs: A value to compare. rhs: Another value to compare.

#### Declaration

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

#### Declared In

Comparable
func >=(_:rhs:)

Returns a Boolean value indicating whether the value of the first argument is greater than or equal to that of the second argument.

Parameters: lhs: A value to compare. rhs: Another value to compare.

#### Declaration

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

Comparable

Arithmetic

#### Declaration

func adding(_ rhs: Self) -> Self

#### Declared In

Arithmetic
mutating func divide(by:) Required

#### Declaration

mutating func divide(by rhs: Self)

#### Declared In

Arithmetic
func divided(by:)

#### Declaration

func divided(by rhs: Self) -> Self

#### Declared In

Arithmetic
mutating func formRemainder(dividingBy:) Required

#### Declaration

mutating func formRemainder(dividingBy rhs: Self)
func isEqual(to:) Required

#### Declaration

func isEqual(to rhs: Self) -> Bool
func isLess(than:) Required

#### Declaration

func isLess(than rhs: Self) -> Bool
func multiplied(by:)

#### Declaration

func multiplied(by rhs: Self) -> Self

#### Declared In

Arithmetic
mutating func multiply(by:) Required

#### Declaration

mutating func multiply(by rhs: Self)

#### Declared In

Arithmetic
func quotientAndRemainder(dividingBy:)

#### Declaration

func quotientAndRemainder(dividingBy rhs: Self) -> (Self, Self)
func remainder(dividingBy:)

#### Declaration

func remainder(dividingBy rhs: Self) -> Self
func signum()

Returns -1 if the value of self is negative, 1 if it's positive, 0 otherwise.

#### Declaration

func signum() -> Self
mutating func subtract(_:) Required

#### Declaration

mutating func subtract(_ rhs: Self)

#### Declared In

Arithmetic
func subtracting(_:)

#### Declaration

func subtracting(_ rhs: Self) -> Self

#### Declared In

Arithmetic
func word(at:) Required

#### Declaration

func word(at n: Int) -> UInt

### Default Implementations

init()

init()

Arithmetic
init(_:)

#### Declaration

init<T where T : FloatingPoint>(_ source: T)
init(integerLiteral:)

Create an instance initialized to value.

#### Declaration

init(integerLiteral value: Self)

#### Declared In

Arithmetic , ExpressibleByIntegerLiteral
init?(exactly:)

#### Declaration

init?<T where T : FloatingPoint>(exactly source: T)
var countRepresentedWords: Int

#### Declaration

var countRepresentedWords: Int { get }

#### Declaration

func adding(_ rhs: Self) -> Self

#### Declared In

Arithmetic
func divided(by:)

#### Declaration

func divided(by rhs: Self) -> Self

#### Declared In

Arithmetic
func multiplied(by:)

#### Declaration

func multiplied(by rhs: Self) -> Self

#### Declared In

Arithmetic
func quotientAndRemainder(dividingBy:)

#### Declaration

func quotientAndRemainder(dividingBy rhs: Self) -> (Self, Self)
func remainder(dividingBy:)

#### Declaration

func remainder(dividingBy rhs: Self) -> Self
func signum()

#### Declaration

func signum() -> Self
func subtracting(_:)

#### Declaration

func subtracting(_ rhs: Self) -> Self

Arithmetic