QueryableOrderedSet<T> class
This is an implementation of OrderedSet that allows you to more efficiently query the list.
You can register a set of queries, i.e., predefined sub-types, whose results, i.e., subsets of this set, are then cached. Since the queries have to be type checks, and types are runtime constants, this can be vastly optimized.
If you find yourself doing a lot of:
orderedSet.whereType<Foo>()
On your code, and are concerned you are iterating a very long O(n) list to find a handful of elements, specially if this is done every tick, you can use this class, that pays a small O(number of registers) cost on add, but lets you find (specific) subsets at O(0).
- Inheritance
-
- Object
- IterableMixin<
T> - OrderedSet<
T> - QueryableOrderedSet
- Available extensions
Constructors
- QueryableOrderedSet([int compare(T e1, T e2)?])
Properties
- first → T
-
The first element.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- isEmpty → bool
-
Whether this collection has no elements.
no setterinherited
- isNotEmpty → bool
-
Whether this collection has at least one element.
no setterinherited
-
iterator
→ Iterator<
T> -
A new
Iterator
that allows iterating the elements of thisIterable
.no setterinherited - last → T
-
The last element.
no setterinherited
- length → int
-
Gets the current length of this.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- single → T
-
Checks that this iterable has only one element, and returns that element.
no setterinherited
Methods
-
add(
T t) → bool -
Adds the element
e
to this, and returns wether the element was succesfully added or not.override -
addAll(
Iterable< T> es) → int -
Adds each element of the provided
es
to this and returns the number of elements added.inherited -
any(
bool test(T element)) → bool -
Checks whether any element of this iterable satisfies
test
.inherited -
cast<
R> () → Iterable< R> -
A view of this iterable as an iterable of
R
instances.inherited -
clear(
) → void -
Removes all elements of this.
override
-
contains(
Object? element) → bool -
Whether the collection contains an element equal to
element
.inherited -
elementAt(
int index) → T -
Returns the
index
th element.inherited -
every(
bool test(T element)) → bool -
Checks whether every element of this iterable satisfies
test
.inherited -
expand<
T> (Iterable< T> toElements(T element)) → Iterable<T> -
Expands each element of this Iterable into zero or more elements.
inherited
-
firstWhere(
bool test(T element), {T orElse()?}) → T -
The first element that satisfies the given predicate
test
.inherited -
fold<
T> (T initialValue, T combine(T previousValue, T element)) → T -
Reduces a collection to a single value by iteratively combining each
element of the collection with an existing value
inherited
-
followedBy(
Iterable< T> other) → Iterable<T> -
Creates the lazy concatenation of this iterable and
other
.inherited -
forEach(
void action(T element)) → void -
Invokes
action
on each element of this iterable in iteration order.inherited -
isRegistered<
C> () → bool -
Whether type
C
is registered as a cache -
join(
[String separator = ""]) → String -
Converts each element to a String and concatenates the strings.
inherited
-
lastWhere(
bool test(T element), {T orElse()?}) → T -
The last element that satisfies the given predicate
test
.inherited -
map<
T> (T toElement(T e)) → Iterable< T> -
The current elements of this iterable modified by
toElement
.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
query<
C extends T> () → List< C> -
Allow you to find a subset of this set with all the elements
e
for which the conditione is C
is true. This is equivalent to -
rebalanceAll(
) → void -
Allows you to rebalance the whole tree. If you are dealing with non-deterministic
compare functions, you probably need to consider rebalancing.
If the result of the priority function for some elements changes, rebalancing is needed.
In general be careful with using comparing functions that can change. If only a few
known elements need rebalancing, you can use rebalanceWhere.
Note: rebalancing is not stable.
inherited
-
rebalanceWhere(
bool test(T element)) → void -
Allows you to rebalance only a portion of the tree. If you are dealing with non-deterministic
compare functions, you probably need to consider rebalancing.
If the priority function changed for certain known elements but not all,
you can use this instead of rebalanceAll.
In general be careful with using comparing functions that can change.
Note: rebalancing is not stable.
inherited
-
reduce(
T combine(T value, T element)) → T -
Reduces a collection to a single value by iteratively combining elements
of the collection using the provided function.
inherited
-
register<
C extends T> () → void -
Adds a new cache for a subtype
C
ofT
, allowing you to call query. If the cache already exists this operation is a no-op. -
remove(
T e) → bool -
Remove a single element that is equal to
e
.override -
removeWhere(
bool test(T element)) → Iterable< T> -
Remove all elements that match the
test
condition; returns the removed elementsinherited -
singleWhere(
bool test(T element), {T orElse()?}) → T -
The single element that satisfies
test
.inherited -
skip(
int count) → Iterable< T> -
Creates an Iterable that provides all but the first
count
elements.inherited -
skipWhile(
bool test(T value)) → Iterable< T> -
Creates an
Iterable
that skips leading elements whiletest
is satisfied.inherited -
take(
int count) → Iterable< T> -
Creates a lazy iterable of the
count
first elements of this iterable.inherited -
takeWhile(
bool test(T value)) → Iterable< T> -
Creates a lazy iterable of the leading elements satisfying
test
.inherited -
toList(
{bool growable = true}) → List< T> -
Creates a List containing the elements of this Iterable.
inherited
-
toSet(
) → Set< T> -
Creates a Set containing the same elements as this iterable.
inherited
-
toString(
) → String -
Returns a string representation of (some of) the elements of
this
.inherited -
where(
bool test(T element)) → Iterable< T> -
Creates a new lazy Iterable with all elements that satisfy the
predicate
test
.inherited -
whereType<
T> () → Iterable< T> -
Creates a new lazy Iterable with all elements that have type
T
.inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited