elm / core / Bitwise

Library for bitwise operations.

Basic Operations

and : Basics.Int -> Basics.Int -> Basics.Int

Bitwise AND

or : Basics.Int -> Basics.Int -> Basics.Int

Bitwise OR

xor : Basics.Int -> Basics.Int -> Basics.Int

Bitwise XOR

complement : Basics.Int -> Basics.Int

Flip each bit individually, often called bitwise NOT

Bit Shifts

shiftLeftBy : Basics.Int -> Basics.Int -> Basics.Int

Shift bits to the left by a given offset, filling new bits with zeros. This can be used to multiply numbers by powers of two.

shiftLeftBy 1 5 == 10
shiftLeftBy 5 1 == 32

shiftRightBy : Basics.Int -> Basics.Int -> Basics.Int

Shift bits to the right by a given offset, filling new bits with whatever is the topmost bit. This can be used to divide numbers by powers of two.

shiftRightBy 1  32 == 16
shiftRightBy 2  32 == 8
shiftRightBy 1 -32 == -16

This is called an arithmetic right shift, often written >>, and sometimes called a sign-propagating right shift because it fills empty spots with copies of the highest bit.

shiftRightZfBy : Basics.Int -> Basics.Int -> Basics.Int

Shift bits to the right by a given offset, filling new bits with zeros.

shiftRightZfBy 1  32 == 16
shiftRightZfBy 2  32 == 8
shiftRightZfBy 1 -32 == 2147483632

This is called an logical right shift, often written >>>, and sometimes called a zero-fill right shift because it fills empty spots with zeros.