Details on the Iterator object - Maple Help
For the best experience, we recommend viewing online help using Google Chrome or Microsoft Edge.

Online Help

All Products    Maple    MapleSim

Home : Support : Online Help : Mathematics : Discrete Mathematics : Combinatorics : Iterator : Details on the Iterator object

Details of the Iterator object


Common Methods

Standard Methods




Common Methods

Each iterator constructed by this package is a Maple object with the following common methods.

ModuleApply : makes the object an appliable object factory. It calls the Object constructor and passes its arguments to the object's ModuleCopy method.

ModuleCopy(self,proto,...) : used to copy an object; see ModuleCopy.

ModuleIterator(self) : returns the two procedures, hasNext and getNext used to implement an iterator; see ModuleIterator. The iterators constructed by this package violate one of the specifications: calling hasNext consecutively, without a call to getNext, does not necessarily return the same value. Each call to hasNext advances the iterator. The reason for this is efficiency; these iterators reuse an Array as output, so there is no need to call getNext.

length(self) : returns the length of the output array of the iterator self. For most iterators, this is a fixed value, but for a few this may change with each iteration.

anditer(p,self,...) : applies the predicate p to each iteration and returns the and of all the evaluations. It returns false immediately if any evaluation returns false. Optional arguments are passed to the predicate, p. The iterator is reset upon exiting.

oriter(p,self,...) : applies the predicate p to each iteration and returns the or of all the evaluations. It returns true immediately if any evaluation returns true. Optional arguments are passed to the predicate, p. The iterator is reset upon exiting.

output(self) : returns the Array used to store the output result.

Print(self,num,opts) : prints num iterations of self. The option showrank prints the rank of each iteration.

Reset(self,rank) : reset self to the given rank. If the iterator does not have an Unrank method, or if rank is omitted, the iterator is reset to the first rank.

Standard Methods

Many of the iterators have the following methods.

Number(self) : return the total number of iterations that the iterator would generate if it started from rank one.

Rank(self,L) : compute the rank of L.  If L is not passed, use the current rank of self.

Unrank(self,rnk) : return the output of self corresponding to rank rnk.


Because these iterators use state variables that are local to the instantiated object, the same object cannot be reused as in iterator in a nested loop. Doing so will raise an error indicating that the iterator has already been started.

To use two or more of these objects in nested loops, create duplicates using the Object function. See the example, below.



Construct an iterator that generates all permutations of the integers from one to five.


Compute the number of iterations.




Test whether the sum of the first and last elements of any permutation equals three, then display the permutation and its rank that meet the criteria.










Verify all permutations sum to 15.




Display the length of the output.




Print the first 10 iterations, with rank.


 1: 1 2 3 4 5
 2: 1 2 3 5 4
 3: 1 2 4 3 5
 4: 1 2 4 5 3
 5: 1 2 5 3 4
 6: 1 2 5 4 3
 7: 1 3 2 4 5
 8: 1 3 2 5 4
 9: 1 3 4 2 5
10: 1 3 4 5 2

Using the same iterator in concurrent loops raises an error.


Error, Permute(5) already started

To avoid this, copy the object and use it in the inner loop. Because P stopped before completing due to the error, it needs to be reset.






The Details of the Iterator object command was updated in Maple 2021.

See Also