protocol
_SignedIntegerType
Inheritance |
BitwiseOperationsType, Comparable, CustomStringConvertible, Equatable, Hashable, IntegerArithmeticType, IntegerLiteralConvertible, SignedNumberType, _Incrementable, _IntegerArithmeticType, _IntegerType
View Protocol Hierarchy →
|
---|---|
Associated Types |
1 inherited item hidden. (Show all) |
Import |
|
Initializers
Create an instance initialized to value
.
Declaration
init
(
integerLiteral
value
:
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
static
var
allZeros
:
Self
{
get
}
Declared In
BitwiseOperationsType
1 inherited item hidden. (Show all)
Instance Variables
A textual representation of self
.
Declaration
var
description
:
String
{
get
}
Declared In
CustomStringConvertible
2 inherited items hidden. (Show all)
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
:
Self
,
_
rhs
:
Self
) -
>
(
Self
,
overflow
:
Bool
)
Declared In
_IntegerArithmeticType
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
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
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
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
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
Returns the intersection of bits set in lhs
and rhs
.
Complexity: O(1).
Declaration
func
&
(
lhs
:
Self
,
rhs
:
Self
) -
>
Self
Declared In
BitwiseOperationsType
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
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
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
A strict total order
over instances of Self
.
Declaration
func
<
(
lhs
:
Self
,
rhs
:
Self
) -
>
Bool
Declared In
Comparable
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
istrue
x == y
impliesy == x
x == y
andy == z
impliesx == 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
prefix
func
~(
x
:
Self
) -
>
Self
Declared In
BitwiseOperationsType
Return the result of negating x
.
Declaration
prefix
func
-(
x
:
Self
) -
>
Self
Declared In
SignedNumberType
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
, SignedNumberType
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
Represent this number using Swift's widest native signed integer type.
Declaration
func
toIntMax
() -
>
IntMax
Declared In
_SignedIntegerType
, IntegerArithmeticType
16 inherited items hidden. (Show all)
This protocol is an implementation detail of
SignedIntegerType
; do not use it directly.