A Set of objects that can be ordered relative to each other.

The set is based on a self-balancing binary tree. It allows most operations in amortized logarithmic time.

Elements of the set are compared using the compare function passed in the constructor, both for ordering and for equality. If the set contains only an object a, then set.contains(b) will return true if and only if compare(a, b) == 0, and the value of a == b is not even checked. If the compare function is omitted, the objects are assumed to be Comparable, and are compared using their Comparable.compareTo method. Non-comparable objects (including null) will not work as an element in that case.

Mixes-in

Properties

first → E
read-only

isEmpty bool
read-only

isNotEmpty bool
read-only

iterator Iterator<E>
read-only

last → E
read-only

length int
read-only

single → E
read-only

Constructors

SplayTreeSet([int compare(E key1, E key2), bool isValidKey(potentialKey)])

Create a new SplayTreeSet with the given compare function.

SplayTreeSet.from(Iterable elements, [int compare(E key1, E key2), bool isValidKey(potentialKey)])

Creates a SplayTreeSet that contains all elements.

Methods

add(E element) → bool

Adds value into the set. Returns true if value was added to the set.

addAll(Iterable<E> elements) → void

Adds all elements to this Set.

any(bool test(E element)) → bool
inherited

Checks whether any element of this iterable satisfies test.

clear() → void

Removes all elements in the set.

contains(Object object) → bool

Returns true if the collection contains an element equal to element.

containsAll(Iterable<Object> other) → bool
inherited

Returns whether this Set contains all the elements of other.

difference(Set<E> other) → Set<E>

Returns a new set with the the elements of this that are not in other.

elementAt(int index) → E
inherited

Returns the indexth element.

every(bool f(E element)) → bool
inherited

Checks whether every element of this iterable satisfies test.

expand(Iterable f(E element)) → Iterable
inherited

Expands each element of this Iterableinto zero or more elements.

firstWhere(bool test(E value), {E orElse()}) → E
inherited

Returns the first element that satisfies the given predicate test.

fold(initialValue, dynamic combine(previousValue, E element)) → dynamic
inherited

Reduces a collection to a single value by iteratively combining each element of the collection with an existing value

forEach(void f(E element)) → void
inherited

Applies the function f to each element of this collection in iteration order.

intersection(Set<E> other) → Set<E>

Returns a new set which is the intersection between this set and other.

join([String separator = ""]) → String
inherited

Converts each element to a String and concatenates the strings.

lastWhere(bool test(E value), {E orElse()}) → E
inherited

Returns the last element that satisfies the given predicate test.

lookup(Object object) → E

If an object equal to object is in the set, return it.

map(dynamic f(E element)) → Iterable
inherited

Returns a new lazy Iterable with elements that are created by calling f on each element of this Iterable in iteration order.

reduce(E combine(E value, E element)) → E
inherited

Reduces a collection to a single value by iteratively combining elements of the collection using the provided function.

remove(Object object) → bool

Removes value from the set. Returns true if value was in the set. Returns false otherwise. The method has no effect if value value was not in the set.

removeAll(Iterable<Object> elements) → void

Removes each element of elements from this set.

removeWhere(bool test(E element)) → void
inherited

Removes all elements of this set that satisfy test.

retainAll(Iterable<Object> elements) → void

Removes all elements of this set that are not elements in elements.

retainWhere(bool test(E element)) → void
inherited

Removes all elements of this set that fail to satisfy test.

singleWhere(bool test(E value)) → E
inherited

Returns the single element that satisfies test.

skip(int n) → Iterable<E>
inherited

Returns an Iterable that provides all but the first count elements.

skipWhile(bool test(E value)) → Iterable<E>
inherited

Returns an Iterable that skips leading elements while test is satisfied.

take(int n) → Iterable<E>
inherited

Returns a lazy iterable of the count first elements of this iterable.

takeWhile(bool test(E value)) → Iterable<E>
inherited

Returns a lazy iterable of the leading elements satisfying test.

toList({bool growable: true}) → List<E>
inherited

Creates a List containing the elements of this Iterable.

toSet() → Set<E>

Creates a Set containing the same elements as this iterable.

toString() → String

Returns a string representation of this object.

union(Set<E> other) → Set<E>

Returns a new set which contains all the elements of this set and other.

where(bool f(E element)) → Iterable<E>
inherited

Returns a new lazy Iterable with all elements that satisfy the predicate test.