GeneratingIterable< T> class
An Iterable whose first value is the result of initial and whose subsequent values are generated by passing the current value to the next function.
The class is useful for creating lazy iterables from object hierarchies and graphs.
The initial value and next function are required to generate a sequence
that eventually terminates, otherwise calling methods that expect a finite
sequence, like length
or last
, will cause an infinite loop.
Example:
class Node {
Node parent;
/// An iterable of node and all ancestors up to the root.
Iterable<Node> ancestors =
new GeneratingIterable<Node>(() => this, (n) => n.parent);
/// An iterable of the root and the path of nodes to this. The
/// reverse of ancestors.
Iterable<Node> path = ancestors.toList().reversed();
}
- Inheritance
- Object
- Iterable<
T> - IterableBase<
T> - GeneratingIterable
Constructors
-
GeneratingIterable(_Initial<
T> initial, _Next< T> next)
Properties
-
initial
→ _Initial<
T> -
final
-
iterator
→ Iterator<
T> -
Returns a new
Iterator
that allows iterating the elements of thisIterable
. [...]read-only, override -
next
→ _Next<
T> -
final
- first → T
-
Returns the first element. [...]
read-only, inherited
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- isEmpty → bool
-
Returns
true
if there are no elements in this collection. [...]read-only, inherited - isNotEmpty → bool
-
Returns true if there is at least one element in this collection. [...]
read-only, inherited
- last → T
-
Returns the last element. [...]
read-only, inherited
- length → int
-
Returns the number of elements in this. [...]
read-only, inherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
- single → T
-
Checks that this iterable has only one element, and returns that element. [...]
read-only, inherited
Methods
-
any(
bool test(E element)) → bool -
Checks whether any element of this iterable satisfies
test
. [...]inherited -
cast<
R>( ) → Iterable< R> -
Provides a view of this iterable as an iterable of
R
instances. [...]inherited -
contains(
Object element) → bool -
Returns true if the collection contains an element equal to
element
. [...]inherited -
elementAt(
int index) → T -
Returns the
index
th element. [...]inherited -
every(
bool test(E element)) → bool -
Checks whether every element of this iterable satisfies
test
. [...]inherited -
expand<
T>( Iterable< T> f(E element)) → Iterable< T> -
Expands each element of this Iterable into zero or more elements. [...]
inherited
-
firstWhere(
bool test(E element), { T orElse() }) → T -
Returns the first element that satisfies the given predicate
test
. [...]inherited -
fold<
T>( T initialValue, T combine(T previousValue, E 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> -
Returns the lazy concatentation of this iterable and
other
. [...]inherited -
forEach(
void f(E element)) → void -
Applies the function
f
to each element of this collection in iteration order.inherited -
join(
[String separator = "" ]) → String -
Converts each element to a String and concatenates the strings. [...]
inherited
-
lastWhere(
bool test(E element), { T orElse() }) → T -
Returns the last element that satisfies the given predicate
test
. [...]inherited -
map<
T>( T f(E e)) → Iterable< T> -
Returns a new lazy Iterable with elements that are created by
calling
f
on each element of thisIterable
in iteration order. [...]inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
-
reduce(
T combine(E value, E element)) → T -
Reduces a collection to a single value by iteratively combining elements
of the collection using the provided function. [...]
inherited
-
singleWhere(
bool test(E element), { T orElse() }) → T -
Returns the single element that satisfies
test
. [...]inherited -
skip(
int count) → Iterable< T> -
Returns an Iterable that provides all but the first
count
elements. [...]inherited -
skipWhile(
bool test(E value)) → Iterable< T> -
Returns an
Iterable
that skips leading elements whiletest
is satisfied. [...]inherited -
take(
int count) → Iterable< T> -
Returns a lazy iterable of the
count
first elements of this iterable. [...]inherited -
takeWhile(
bool test(E value)) → Iterable< T> -
Returns 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(E element)) → Iterable< T> -
Returns a new lazy Iterable with all elements that satisfy the
predicate
test
. [...]inherited -
whereType<
T>( ) → Iterable< T> -
Returns a new lazy Iterable with all elements that have type
T
. [...]inherited
Operators
-
operator ==(
dynamic other) → bool -
The equality operator. [...]
inherited