Gee.TreeSet – gee-0.8 Reference Manual

TreeSet

Object Hierarchy:

Description:

public class TreeSet<G> : AbstractBidirSortedSet<G>

Left-leaning red-black tree implementation of the Set interface.

This implementation is especially well designed for large quantity of data. The (balanced) tree implementation insure that the set and get methods are in logarithmic complexity. For a linear implementation see HashSet.

Content:

Properties:

public CompareDataFunc<G> compare_func { get; }
The elements' comparator function.
public override bool read_only { get; }
Specifies whether this collection can change - i.e. whether add, remove etc. are legal operations.
public override int size { get; }
The number of items in this collection.

Creation methods:

public TreeSet (owned CompareDataFunc<G>? compare_func = null)
Constructs a new, empty tree set sorted according to the specified comparator function.

Methods:

public override bool @foreach (ForallFunc<G> f)
public override bool add (G item)
Adds an item to this collection. Must not be called on read-only collections.
public override BidirIterator<G> bidir_iterator ()
Returns a BidirIterator that can be used for bi-directional iteration over this sorted set.
public override G ceil (G item)
Returns the element which is higher or equal then the specified element.
public override void clear ()
Removes all items from this collection. Must not be called on read- only collections.
public override bool contains (G item)
Determines whether this collection contains the specified item.
public override G first ()
Returns the first element of the sorted set. Set must not be empty.
public override G floor (G item)
Returns the element which is lower or equal then the specified element.
public override SortedSet<G> head_set (G before)
Returns the sub-set of this sorted set containing elements strictly lower than the specified element.
public override G higher (G item)
Returns the element which is strictly higher than the specified element.
public override Iterator<G> iterator ()
Returns a Iterator that can be used for simple iteration over a collection.
public override Iterator<G>? iterator_at (G item)
Returns a BidirIterator initially pointed at the specified element.
public override G last ()
Returns the last element of the sorted set. Set must not be empty.
public override G lower (G item)
Returns the element which is strictly lower than the specified element.
public override bool remove (G item)
Removes the first occurrence of an item from this collection. Must not be called on read-only collections.
public override SortedSet<G> sub_set (G after, G before)
Returns the right-open sub-set of this sorted set, thus containing elements equal or higher than the specified from element, and stricly lower than the specified to element.
public override SortedSet<G> tail_set (G after)
Returns the sub-set of this sorted set containing elements equal or higher than the specified element.