RandomWalkIterable<V> class

Iterable producing a random walk over a graph.

  • If selfAvoiding is set to true, a vertex will be visited at most once.
  • If edgeProbability is provided, probabilities of picking an edge will be weighted.

If there are no eligible successors the iterator terminates, however with some graphs and call configurations the iterator is infinite.

See https://en.wikipedia.org/wiki/Random_walk.

Inheritance
Available extensions

Constructors

RandomWalkIterable(V vertex, {required Iterable<V> successorsOf(V vertex), num edgeProbability(V source, V target)?, bool selfAvoiding = false, Random? random, StorageStrategy<V>? vertexStrategy})

Properties

edgeProbability num Function(V source, V target)?
final
first → V
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<V>
A new Iterator that allows iterating the elements of this Iterable.
no setteroverride
last → V
The last element.
no setterinherited
length int
The number of elements in this Iterable.
no setterinherited
random Random
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
selfAvoiding bool
final
single → V
Checks that this iterable has only one element, and returns that element.
no setterinherited
successorsOf Iterable<V> Function(V vertex)
final
vertex → V
final
vertexStrategy StorageStrategy<V>
final

Methods

any(bool test(V 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
contains(Object? element) bool
Whether the collection contains an element equal to element.
inherited
elementAt(int index) → V
Returns the indexth element.
inherited
every(bool test(V element)) bool
Checks whether every element of this iterable satisfies test.
inherited
expand<T>(Iterable<T> toElements(V element)) Iterable<T>
Expands each element of this Iterable into zero or more elements.
inherited
firstWhere(bool test(V element), {V orElse()?}) → V
The first element that satisfies the given predicate test.
inherited
fold<T>(T initialValue, T combine(T previousValue, V element)) → T
Reduces a collection to a single value by iteratively combining each element of the collection with an existing value
inherited
followedBy(Iterable<V> other) Iterable<V>
Creates the lazy concatenation of this iterable and other.
inherited
forEach(void action(V element)) → void
Invokes action on each element of this iterable in iteration order.
inherited
join([String separator = ""]) String
Converts each element to a String and concatenates the strings.
inherited
lastWhere(bool test(V element), {V orElse()?}) → V
The last element that satisfies the given predicate test.
inherited
map<T>(T toElement(V 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
reduce(V combine(V value, V element)) → V
Reduces a collection to a single value by iteratively combining elements of the collection using the provided function.
inherited
singleWhere(bool test(V element), {V orElse()?}) → V
The single element that satisfies test.
inherited
skip(int count) Iterable<V>
Creates an Iterable that provides all but the first count elements.
inherited
skipWhile(bool test(V value)) Iterable<V>
Creates an Iterable that skips leading elements while test is satisfied.
inherited
take(int count) Iterable<V>
Creates a lazy iterable of the count first elements of this iterable.
inherited
takeWhile(bool test(V value)) Iterable<V>
Creates a lazy iterable of the leading elements satisfying test.
inherited
toList({bool growable = true}) List<V>
Creates a List containing the elements of this Iterable.
inherited
toSet() Set<V>
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(V element)) Iterable<V>
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