Bitset

A gtk.bitset.Bitset represents 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. gtk.bitset.Bitset 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 gtk.bitset_iter.BitsetIter.

The main use case for gtk.bitset.Bitset is implementing complex selections for gtk.selection_model.SelectionModel.

class Bitset : Boxed {

static gtk.bitset.Bitset newEmpty();

static gtk.bitset.Bitset newRange(uint start, uint nItems);

bool add(uint value);

void addRange(uint start, uint nItems);

void addRangeClosed(uint first, uint last);

void addRectangle(uint start, uint width, uint height, uint stride);

bool contains(uint value);

gtk.bitset.Bitset copy();

void difference(gtk.bitset.Bitset other);

bool equals(gtk.bitset.Bitset other);

uint getMaximum();

uint getMinimum();

uint getNth(uint nth);

ulong getSize();

ulong getSizeInRange(uint first, uint last);

void intersect(gtk.bitset.Bitset other);

bool isEmpty();

bool remove(uint value);

void removeAll();

void removeRange(uint start, uint nItems);

void removeRangeClosed(uint first, uint last);

void removeRectangle(uint start, uint width, uint height, uint stride);

void shiftLeft(uint amount);

void shiftRight(uint amount);

void splice(uint position, uint removed, uint added);

void subtract(gtk.bitset.Bitset other);

void union_(gtk.bitset.Bitset other);

}

Members

Functions

add bool add(uint value): Adds value to self if it wasn't part of it before.
addRange void addRange(uint start, uint nItems): Adds all values from start (inclusive) to start + n_items (exclusive) in self.
addRangeClosed void addRangeClosed(uint first, uint last): Adds the closed range [first, last], so first, last and all values in between. first must be smaller than last.
addRectangle void addRectangle(uint start, uint width, uint height, uint stride): 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.
contains bool contains(uint value): Checks if the given value has been added to self
copy gtk.bitset.Bitset copy(): Creates a copy of self.
difference void difference(gtk.bitset.Bitset other): Sets self to be the symmetric difference of self and other.
equals bool equals(gtk.bitset.Bitset other): Returns true if self and other contain the same values.
getMaximum uint getMaximum(): Returns the largest value in self.
getMinimum uint getMinimum(): Returns the smallest value in self.
getNth uint getNth(uint nth): Returns the value of the nth item in self.
getSize ulong getSize(): Gets the number of values that were added to the set.
getSizeInRange ulong getSizeInRange(uint first, uint last): Gets the number of values that are part of the set from first to last (inclusive).
intersect void intersect(gtk.bitset.Bitset other): Sets self to be the intersection of self and other.
isEmpty bool isEmpty(): Check if no value is contained in bitset.
remove bool remove(uint value): Removes value from self if it was part of it before.
removeAll void removeAll(): Removes all values from the bitset so that it is empty again.
removeRange void removeRange(uint start, uint nItems): Removes all values from start (inclusive) to start + n_items (exclusive) in self.
removeRangeClosed void removeRangeClosed(uint first, uint last): Removes the closed range [first, last], so first, last and all values in between. first must be smaller than last.
removeRectangle void removeRectangle(uint start, uint width, uint height, uint stride): 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.
shiftLeft void shiftLeft(uint amount): Shifts all values in self to the left by amount.
shiftRight void shiftRight(uint amount): Shifts all values in self to the right by amount.
splice void splice(uint position, uint removed, uint added): This is a support function for gio.list_model.ListModel handling, by mirroring the GlistModel::items-changed signal.
subtract void subtract(gtk.bitset.Bitset other): Sets self to be the subtraction of other from self.
union_ void union_(gtk.bitset.Bitset other): Sets self to be the union of self and other.

Static functions

newEmpty gtk.bitset.Bitset newEmpty(): Creates a new empty bitset.
newRange gtk.bitset.Bitset newRange(uint start, uint nItems): Creates a bitset with the given range set.

Inherited Members

From Boxed

cInstancePtr void* cInstancePtr;: Pointer to the C boxed value
getType GType getType(): Get the GType of this boxed type.
gType GType gType [@property getter]: Boxed GType property.
self Boxed self(): Convenience method to return this cast to a type. For use in D with statements.
copy_ void* copy_(): Make a copy of the wrapped C boxed data.
boxedCopy void* boxedCopy(void* cBoxed): Copy a C boxed value using g_boxed_copy.
boxedFree void boxedFree(void* cBoxed): Free a C boxed value using g_boxed_free.

gtk bitset classes

Bitset