Struct permutate::ValuePermutator [] [src]

pub struct ValuePermutator<'a, T: 'a + Copy> { /* fields omitted */ }

The ValuePermutator contains the state of the iterator as well as the values to inputs that are being permutated. The input should be provided as an array of an array of values.

Methods

impl<'a, T: Copy> ValuePermutator<'a, T>
[src]

Initialize a new ValuePermutator with the list of input lists to permutate with. The input may be provided as either multiple lists via an array of arrays, or a single list as an array within an array.

Sets the internal index counter's values to a specific state, which you will typically obtain when using the get_index() method. The iter_no parameter will specify what the iteration's position should be. If, for example, you set this value to 0, then it will iterate through all possible permutations, including looping around back to the beginning and generating permutations for all possible values before the supplied state.

Panics

This method will panic if the supplied indexes vector is not the correct length

Obtains the current iteration number and the index counter's indexes.

Returns the total number of permutations possible

Resets the internal state of the Permutator to allow you to start permutating again.

Provides similar functionality as the Iterator traits next method, but allows the ability to either supply your own buffer or re-use the Vec created by a prior next in order to avoid extra allocations.

  • If the method returns true, then there are more values to compute.
  • If the method returns false, then all values have been exhausted.

Panics

This method will panic if the supplied buffer's length is invalid.

Trait Implementations

impl<'a, T: Copy> Iterator for ValuePermutator<'a, T>
[src]

The type of the elements being iterated over.

Returns the nth element of the iterator. Read more

Advances the iterator and returns the next value. Read more

Returns the bounds on the remaining length of the iterator. Read more

Consumes the iterator, counting the number of iterations and returning it. Read more

Consumes the iterator, returning the last element. Read more

🔬 This is a nightly-only experimental API. (iterator_step_by)

unstable replacement of Range::step_by

Creates an iterator starting at the same point, but stepping by the given amount at each iteration. Read more

Takes two iterators and creates a new iterator over both in sequence. Read more

'Zips up' two iterators into a single iterator of pairs. Read more

Takes a closure and creates an iterator which calls that closure on each element. Read more

Creates an iterator which uses a closure to determine if an element should be yielded. Read more

Creates an iterator that both filters and maps. Read more

Creates an iterator which gives the current iteration count as well as the next value. Read more

Creates an iterator which can use peek to look at the next element of the iterator without consuming it. Read more

Creates an iterator that [skip]s elements based on a predicate. Read more

Creates an iterator that yields elements based on a predicate. Read more

Creates an iterator that skips the first n elements. Read more

Creates an iterator that yields its first n elements. Read more

An iterator adaptor similar to [fold] that holds internal state and produces a new iterator. Read more

Creates an iterator that works like map, but flattens nested structure. Read more

Creates an iterator which ends after the first [None]. Read more

Do something with each element of an iterator, passing the value on. Read more

Borrows an iterator, rather than consuming it. Read more

Transforms an iterator into a collection. Read more

Consumes an iterator, creating two collections from it. Read more

An iterator adaptor that applies a function, producing a single, final value. Read more

Tests if every element of the iterator matches a predicate. Read more

Tests if any element of the iterator matches a predicate. Read more

Searches for an element of an iterator that satisfies a predicate. Read more

Searches for an element in an iterator, returning its index. Read more

Searches for an element in an iterator from the right, returning its index. Read more

Returns the maximum element of an iterator. Read more

Returns the minimum element of an iterator. Read more

Returns the element that gives the maximum value from the specified function. Read more

Returns the element that gives the maximum value with respect to the specified comparison function. Read more

Returns the element that gives the minimum value from the specified function. Read more

Returns the element that gives the minimum value with respect to the specified comparison function. Read more

Reverses an iterator's direction. Read more

Converts an iterator of pairs into a pair of containers. Read more

Creates an iterator which [clone]s all of its elements. Read more

Repeats an iterator endlessly. Read more

Sums the elements of an iterator. Read more

Iterates over the entire iterator, multiplying all the elements Read more

Lexicographically compares the elements of this Iterator with those of another. Read more

Lexicographically compares the elements of this Iterator with those of another. Read more

Determines if the elements of this Iterator are equal to those of another. Read more

Determines if the elements of this Iterator are unequal to those of another. Read more

Determines if the elements of this Iterator are lexicographically less than those of another. Read more

Determines if the elements of this Iterator are lexicographically less or equal to those of another. Read more

Determines if the elements of this Iterator are lexicographically greater than those of another. Read more

Determines if the elements of this Iterator are lexicographically greater than or equal to those of another. Read more