Bitwise

A set of functions that perform calculations on bits.

All bitwise functions work only on integers; otherwise an ArithmeticError is raised.

The functions in this module come in two flavors: named or operators. For example:

iex> use Bitwise
iex> bnot(1) # named
-2
iex> 1 &&& 1 # operator
1

If you prefer to use only operators or skip them, you can pass the following options:

:only_operators - includes only operators
:skip_operators - skips operators

For example:

iex> use Bitwise, only_operators: true
iex> 1 &&& 1
1

When invoked with no options, use Bitwise is equivalent to import Bitwise.

All bitwise functions can be used in guards:

iex> odd? = fn
...>   int when Bitwise.band(int, 1) == 1 -> true
...>   _ -> false
...> end
iex> odd?.(1)
true

All functions in this module are inlined by the compiler.

Summary

Guards

left &&& right: Bitwise AND operator.
left <<< right: Arithmetic left bitshift operator.
left >>> right: Arithmetic right bitshift operator.
left ^^^ right: Bitwise XOR operator.
left ||| right: Bitwise OR operator.
~~~expr: Bitwise NOT unary operator.
band(left, right): Calculates the bitwise AND of its arguments.
bnot(expr): Calculates the bitwise NOT of the argument.
bor(left, right): Calculates the bitwise OR of its arguments.
bsl(left, right): Calculates the result of an arithmetic left bitshift.
bsr(left, right): Calculates the result of an arithmetic right bitshift.
bxor(left, right): Calculates the bitwise XOR of its arguments.

Guards

left &&& right

Specs

integer() &&& integer() :: integer()

Bitwise AND operator.

Calculates the bitwise AND of its arguments.

Allowed in guard tests. Inlined by the compiler.

Examples

iex> 9 &&& 3
1

left <<< right

Specs

integer() <<< integer() :: integer()

Arithmetic left bitshift operator.

Calculates the result of an arithmetic left bitshift.

Allowed in guard tests. Inlined by the compiler.

Examples

iex> 1 <<< 2
4

iex> 1 <<< -2
0

iex> -1 <<< 2
-4

iex> -1 <<< -2
-1

left >>> right

Specs

integer() >>> integer() :: integer()

Arithmetic right bitshift operator.

Calculates the result of an arithmetic right bitshift.

Allowed in guard tests. Inlined by the compiler.

Examples

iex> 1 >>> 2
0

iex> 1 >>> -2
4

iex> -1 >>> 2
-1

iex> -1 >>> -2
-4

left ^^^ right

Specs

integer() ^^^ integer() :: integer()

Bitwise XOR operator.

Calculates the bitwise XOR of its arguments.

Allowed in guard tests. Inlined by the compiler.

Examples

iex> 9 ^^^ 3
10

left ||| right

Specs

integer() ||| integer() :: integer()

Bitwise OR operator.

Calculates the bitwise OR of its arguments.

Allowed in guard tests. Inlined by the compiler.

Examples

iex> 9 ||| 3
11

~~~expr

Specs

~~~integer() :: integer()

Bitwise NOT unary operator.

Calculates the bitwise NOT of the argument.

Allowed in guard tests. Inlined by the compiler.

Examples

iex> ~~~2
-3

iex> ~~~2 &&& 3
1

band(left, right)

Specs

band(integer(), integer()) :: integer()

Calculates the bitwise AND of its arguments.

Allowed in guard tests. Inlined by the compiler.

Examples

iex> band(9, 3)
1

bnot(expr)

Specs

bnot(integer()) :: integer()

Calculates the bitwise NOT of the argument.

Allowed in guard tests. Inlined by the compiler.

Examples

iex> bnot(2)
-3

iex> bnot(2) &&& 3
1

bor(left, right)

Specs

bor(integer(), integer()) :: integer()

Calculates the bitwise OR of its arguments.

Allowed in guard tests. Inlined by the compiler.

Examples

iex> bor(9, 3)
11

bsl(left, right)

Specs

bsl(integer(), integer()) :: integer()

Calculates the result of an arithmetic left bitshift.

Allowed in guard tests. Inlined by the compiler.

Examples

iex> bsl(1, 2)
4

iex> bsl(1, -2)
0

iex> bsl(-1, 2)
-4

iex> bsl(-1, -2)
-1

bsr(left, right)

Specs

bsr(integer(), integer()) :: integer()

Calculates the result of an arithmetic right bitshift.

Allowed in guard tests. Inlined by the compiler.

Examples

iex> bsr(1, 2)
0

iex> bsr(1, -2)
4

iex> bsr(-1, 2)
-1

iex> bsr(-1, -2)
-4

bxor(left, right)

Specs

bxor(integer(), integer()) :: integer()

Calculates the bitwise XOR of its arguments.

Allowed in guard tests. Inlined by the compiler.

Examples

iex> bxor(9, 3)
10