bitset

v0.2.1

bitset v0.2.1 Bitset View Source

Documentation for Bitset. the fixed-size N bits

Link to this section Summary

Types

t()

Functions

all?(bitset)
any?(bitset)
count(bitset)

the number of bits set to true

flip(bitset)

toggle all bits

flip(bitset, pos)

toggle the bit at the position

new(size)
new(arg, size)
none?(bitset)
reset(bitset)

sets all bits to false

reset(bitset, pos)

sets the bit at the position to false

reverse(bitset)
set(bitset)

sets all bits to true

set(bitset, pos, bit \\ 1)

sets the bit at the position to bit value

size(bitset)
test?(bitset, pos)
to_binary(bitset) deprecated

convert to binary format

to_bytes(bitset)
to_data(bitset)

return Bitset data binary

to_string(bitset, acc \\ <<>>)

return string representation of the bitset

Link to this section Types

Link to this type

t() View Source 
t() :: %Bitset{data: term(), size: term()}

Link to this section Functions

Link to this function

all?(bitset) View Source 
all?(bitstring() | Bitset.t()) :: boolean()

Link to this function

any?(bitset) View Source 
any?(bitstring() | Bitset.t()) :: boolean()

Link to this function

count(bitset) View Source 
count(Bitset.t()) :: integer()

the number of bits set to true

Link to this function

flip(bitset) View Source 
flip(Bitset.t()) :: Bitset.t()

toggle all bits

Link to this function

flip(bitset, pos) View Source 
flip(Bitset.t(), integer()) :: Bitset.t()

toggle the bit at the position

Link to this function

new(size) View Source 
new(bitstring() | non_neg_integer()) :: Bitset.t()

Link to this function

new(arg, size) View Source 
new(bitstring(), integer()) :: Bitset.t()

Link to this function

none?(bitset) View Source 
none?(bitstring() | Bitset.t()) :: boolean()

Link to this function

reset(bitset) View Source 
reset(Bitset.t()) :: Bitset.t()

sets all bits to false

Link to this function

reset(bitset, pos) View Source 
reset(Bitset.t(), integer()) :: Bitset.t()

sets the bit at the position to false

Link to this function

reverse(bitset) View Source 
reverse(Bitset.t()) :: Bitset.t()

Link to this function

set(bitset) View Source 
set(Bitset.t()) :: Bitset.t()

sets all bits to true

Link to this function

set(bitset, pos, bit \\ 1) View Source 
set(Bitset.t(), integer(), integer()) :: Bitset.t()

sets the bit at the position to bit value

Link to this function

size(bitset) View Source 
size(Bitset.t()) :: integer()
size(bitstring()) :: integer()

Link to this function

test?(bitset, pos) View Source 
test?(Bitset.t(), integer()) :: boolean()

Link to this function

to_binary(bitset) View Source 
to_binary(Bitset.t()) :: bitstring()

This function is deprecated. Use to_bytes/1 instead.

convert to binary format

Link to this function

to_bytes(bitset) View Source (since 0.2.1) 
to_bytes(Bitset.t()) :: bitstring()

Link to this function

to_data(bitset) View Source 
to_data(Bitset.t()) :: bitstring()

return Bitset data binary

Link to this function

to_string(bitset, acc \\ <<>>) View Source 
to_string(bitstring() | Bitset.t(), bitstring()) :: binary()

return string representation of the bitset