API Reference

bitset	Return a new bitset class with given name and members.
bitsets.bases.BitSet	Ordered container of unique elements from a predefined domain.
bitsets.series.List	Mutable bitset sequence.
bitsets.series.Tuple	Immutable bitset sequence.

bitset

bitsets.bitset(name: str, members, base=<class 'bitsets.bases.BitSet'>, list: bool = False, tuple: bool = False)

Return a new bitset class with given name and members.

Parameters:

• name (str) – Name of the class to be created.

• members – Hashable sequence of allowed bitset members.

• base – Base class to derive the returned class from.

• list (bool) – Include a custom class for bitset lists.

• tuple (bool) – Include a custom class for bitset tuples.

Example

>>> Letters = bitset('Letters', 'abcdef', list=True, tuple=True)
>>> Letters
<class bitsets.meta.bitset('Letters', 'abcdef', 0x..., BitSet, List, Tuple)>
>>> Letters('deadbeef')
Letters(['a', 'b', 'd', 'e', 'f'])

BitSet

class bitsets.bases.BitSet(members=())

Ordered container of unique elements from a predefined domain.

Parameters:

members – Iterable of domain members.

Raises:

KeyError – if a member is not in the domain of the set.

__contains__(member)

Set membership.

Raises:

KeyError – if member is not in the domain of the set.

__iter__()

Iterate over the set members.

__len__() → int

Return the number of items in the set (cardinality).

Return type:

int

all() → bool

Return True iff the set contains all domain items.

Return type:

bool

any() → bool

Return True iff the set contains at least one item.

Return type:

bool

atoms(reverse=False)

Yield the singleton for every set member.

bits() → str

Return the binary string of set membership.

Return type:

str

bools() → tuple[bool, ...]

Return the boolean sequence of set membership.

Return type:

tuple[bool, ...]

complement()

Complement set.

copy()

Return the set unchanged (as its is immutable).

count(value: bool = True) → real

Returns the number of present/absent members.

Return type:

<attribute ‘real’ of ‘int’ objects>

difference(other)

Set difference.

classmethod frombits(bits='0')

Create a set from binary string.

classmethod frombools(bools=())

Create a set from an iterable of boolean evaluable items.

inatoms(reverse=False)

Yield the singleton for every non-member.

intersection(other)

Set intersection.

isdisjoint(other) → bool

Set disjointness.

Return type:

bool

issubset(other) → bool

Inverse set containment.

Return type:

bool

issuperset(other) → bool

Set containment.

Return type:

bool

longcolex()

Return sort key for long colexicographical order.

longlex()

Return sort key for long lexicographical order.

members(as_set=False)

Return the set members tuple/frozenset.

powerset(start=None, excludestart=False)

Yield combinations from start to self in short lexicographic order.

shortcolex()

Return sort key for short colexicographical order.

shortlex()

Return sort key for short lexicographical order.

symmetric_difference(other)

Symmetric set difference.

union(other)

Set union.

BitSet.List

class bitsets.series.List(*bits) → None

Mutable bitset sequence.

Parameters:

*bits (str) – Strings with the binary membership representation.

bits() → list[str]

Return the series as list of binary set membership strings.

Return type:

list[str]

bools() → list[bool]

Return the series as list of boolean set membership sequences.

Return type:

list[bool]

classmethod frombits(bits)

Series from binary string arguments.

classmethod frombools(bools)

Series from iterable of boolean evaluable iterables.

classmethod fromints(ints)

Series from integer rank arguments.

classmethod frommembers(members)

Series from iterable of member iterables.

index_sets(as_set=False)

Return the series as list of index set tuples.

ints() → list[int]

Return the series as list of integers ranks.

Return type:

list[int]

members(as_set=False)

Return the series as list of set member tuples/frozensets.

reduce_and()

Return the intersection of all series elements.

reduce_or()

Return the union of all series elements.

BitSet.Tuple

class bitsets.series.Tuple(*bits)

Immutable bitset sequence.

Parameters:

*bits (str) – Strings with the binary membership representation.

bits() → list[str]

Return the series as list of binary set membership strings.

Return type:

list[str]

bools() → list[bool]

Return the series as list of boolean set membership sequences.

Return type:

list[bool]

classmethod frombits(bits)

Series from binary string arguments.

classmethod frombools(bools)

Series from iterable of boolean evaluable iterables.

classmethod fromints(ints)

Series from integer rank arguments.

classmethod frommembers(members)

Series from iterable of member iterables.

index_sets(as_set=False)

Return the series as list of index set tuples.

ints() → list[int]

Return the series as list of integers ranks.

Return type:

list[int]

members(as_set=False)

Return the series as list of set member tuples/frozensets.

reduce_and()

Return the intersection of all series elements.

reduce_or()

Return the union of all series elements.