PermutationGenerator (groovy 2.4.4 API)

Summary:
Constructor
Method

| Detail:
Constructor
Method

groovy.util.PermutationGenerator

All Implemented Interfaces and Traits:

Iterator
```
public class PermutationGenerator
extends Object
```
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Constructor Summary

Constructors
Constructor and description
`PermutationGenerator (Collection<E> items)` WARNING: Don't make n too large.
`PermutationGenerator (Iterable<E> items)`

Methods Summary

Methods
Type	Name and description
`BigInteger`	`getTotal()`
`boolean`	`hasNext()`
`List<E>`	`next()` Generate next permutation (algorithm from Rosen p. 284)
`void`	`remove()`
`void`	`reset()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Constructor Detail
  - public PermutationGenerator(Collection<E> items)
    
    WARNING: Don't make n too large. Recall that the number of permutations is n! which can be very large, even when n is as small as 20 -- 20! = 2,432,902,008,176,640,000 and 21! is too big to fit into a Java long, which is why we use BigInteger instead.
    Parameters:
    items - the items to permute
  - public PermutationGenerator(Iterable<E> items)
- Method Detail
  - public BigInteger getTotal()
  - public boolean hasNext()
  - public List<E> next()
    
    Generate next permutation (algorithm from Rosen p. 284)
    Returns:
    the items permuted
  - public void remove()
  - public void reset()

Summary:
Constructor
Method

| Detail:
Constructor
Method

Copyright © 2003-2015 The Apache Software Foundation. All rights reserved.