Gtk.Bitset¶

record (struct)

A set of unsigned integers.

Another name for this data structure is “bitmap”.

The current implementation is based on roaring bitmaps.

A bitset allows adding a set of integers and provides support for set operations like unions, intersections and checks for equality or if a value is contained in the set. GtkBitset also contains various functions to query metadata about the bitset, such as the minimum or maximum values or its size.

The fastest way to iterate values in a bitset is BitsetIter.

The main use case for GtkBitset is implementing complex selections for SelectionModel.

Constructors¶

new_empty¶

@classmethod
def new_empty(cls) -> Bitset

Creates a new empty bitset.

new_range¶

@classmethod
def new_range(cls, start: int, n_items: int) -> Bitset

Creates a bitset with the given range set.

Parameters:

start — first value to add
n_items — number of consecutive values to add

Methods¶

add¶

def add(self, value: int) -> bool

Adds value to self if it wasn't part of it before.

Parameters:

value — value to add

add_range¶

def add_range(self, start: int, n_items: int) -> None

Adds all values from start (inclusive) to start + n_items (exclusive) in self.

Parameters:

start — first value to add
n_items — number of consecutive values to add

add_range_closed¶

def add_range_closed(self, first: int, last: int) -> None

Adds the closed range [first, last], so first, last and all values in between. first must be smaller than last.

Parameters:

first — first value to add
last — last value to add

add_rectangle¶

def add_rectangle(self, start: int, width: int, height: int, stride: int) -> None

Interprets the values as a 2-dimensional boolean grid with the given stride and inside that grid, adds a rectangle with the given width and height.

Parameters:

start — first value to add
width — width of the rectangle
height — height of the rectangle
stride — row stride of the grid

contains¶

def contains(self, value: int) -> bool

Checks if the given value has been added to self

Parameters:

value — the value to check

copy¶

def copy(self) -> Bitset

Creates a copy of self.

difference¶

def difference(self, other: Bitset) -> None

Sets self to be the symmetric difference of self and other.

The symmetric difference is set self to contain all values that were either contained in self or in other, but not in both. This operation is also called an XOR.

It is allowed for self and other to be the same bitset. The bitset will be emptied in that case.

Parameters:

other — the GtkBitset to compute the difference from

equals¶

def equals(self, other: Bitset) -> bool

Returns True if self and other contain the same values.

Parameters:

other — another GtkBitset

get_maximum¶

def get_maximum(self) -> int

Returns the largest value in self.

If self is empty, 0 is returned.

get_minimum¶

def get_minimum(self) -> int

Returns the smallest value in self.

If self is empty, G_MAXUINT is returned.

get_nth¶

def get_nth(self, nth: int) -> int

Returns the value of the nth item in self.

If nth is >= the size of self, 0 is returned.

Parameters:

nth — index of the item to get

get_size¶

def get_size(self) -> int

Gets the number of values that were added to the set.

For example, if the set is empty, 0 is returned.

Note that this function returns a guint64, because when all values are set, the return value is G_MAXUINT + 1. Unless you are sure this cannot happen (it can't with GListModel), be sure to use a 64bit type.

get_size_in_range¶

def get_size_in_range(self, first: int, last: int) -> int

Gets the number of values that are part of the set from first to last (inclusive).

Note that this function returns a guint64, because when all values are set, the return value is G_MAXUINT + 1. Unless you are sure this cannot happen (it can't with GListModel), be sure to use a 64bit type.

Parameters:

first — the first element to include
last — the last element to include

intersect¶

def intersect(self, other: Bitset) -> None

Sets self to be the intersection of self and other.

In other words, remove all values from self that are not part of other.

It is allowed for self and other to be the same bitset. Nothing will happen in that case.

Parameters:

other — the GtkBitset to intersect with

is_empty¶

def is_empty(self) -> bool

Check if no value is contained in bitset.

ref¶

def ref(self) -> Bitset

Acquires a reference on the given GtkBitset.

remove¶

def remove(self, value: int) -> bool

Removes value from self if it was part of it before.

Parameters:

value — value to remove

remove_all¶

def remove_all(self) -> None

Removes all values from the bitset so that it is empty again.

remove_range¶

def remove_range(self, start: int, n_items: int) -> None

Removes all values from start (inclusive) to start + n_items (exclusive) in self.

Parameters:

start — first value to remove
n_items — number of consecutive values to remove

remove_range_closed¶

def remove_range_closed(self, first: int, last: int) -> None

Removes the closed range [first, last], so first, last and all values in between. first must be smaller than last.

Parameters:

first — first value to remove
last — last value to remove

remove_rectangle¶

def remove_rectangle(self, start: int, width: int, height: int, stride: int) -> None

Interprets the values as a 2-dimensional boolean grid with the given stride and inside that grid, removes a rectangle with the given width and height.

Parameters:

start — first value to remove
width — width of the rectangle
height — height of the rectangle
stride — row stride of the grid

shift_left¶

def shift_left(self, amount: int) -> None

Shifts all values in self to the left by amount.

Values smaller than amount are discarded.

Parameters:

amount — amount to shift all values to the left

shift_right¶

def shift_right(self, amount: int) -> None

Shifts all values in self to the right by amount.

Values that end up too large to be held in a #guint are discarded.

Parameters:

amount — amount to shift all values to the right

splice¶

def splice(self, position: int, removed: int, added: int) -> None

This is a support function for GListModel handling, by mirroring the GlistModel::items-changed signal.

First, it "cuts" the values from position to removed from the bitset. That is, it removes all those values and shifts all larger values to the left by removed places.

Then, it "pastes" new room into the bitset by shifting all values larger than position by added spaces to the right. This frees up space that can then be filled.

Parameters:

position — position at which to slice
removed — number of values to remove
added — number of values to add

subtract¶

def subtract(self, other: Bitset) -> None

Sets self to be the subtraction of other from self.

In other words, remove all values from self that are part of other.

It is allowed for self and other to be the same bitset. The bitset will be emptied in that case.

Parameters:

other — the GtkBitset to subtract

union¶

def union(self, other: Bitset) -> None

Sets self to be the union of self and other.

That is, add all values from other into self that weren't part of it.

It is allowed for self and other to be the same bitset. Nothing will happen in that case.

Parameters:

other — the GtkBitset to union with

unref¶

def unref(self) -> None

Releases a reference on the given GtkBitset.

If the reference was the last, the resources associated to the self are freed.