CombinatorialGenerator

class CombinatorialGenerator(*args)

Combinatorial generator base class.

Available constructors:

CombinatorialGenerator()

CombinatorialGenerator(combinatorialGeneratorImp)

Parameters:
combinatorialGeneratorImp : CombinatorialGeneratorImplementation

An implementation of a combinatorial generator which is provided by Combinations, KPermutations or Tuples.

Attributes:
thisown

The membership flag

Methods

generate() Generate the combinatorial sequence.
getClassName() Accessor to the object’s name.
getId() Accessor to the object’s id.
getImplementation(*args) Accessor to the underlying implementation.
getName() Accessor to the object’s name.
setName(name) Accessor to the object’s name.
setImplementation  
__init__(*args)

Initialize self. See help(type(self)) for accurate signature.

generate()

Generate the combinatorial sequence.

Returns:
indicesCol : collection of Indices

The collection of all the possible values of the combinatorial generator as a set of non-negative integer values stored into an Indices.

getClassName()

Accessor to the object’s name.

Returns:
class_name : str

The object class name (object.__class__.__name__).

getId()

Accessor to the object’s id.

Returns:
id : int

Internal unique identifier.

getImplementation(*args)

Accessor to the underlying implementation.

Returns:
impl : Implementation

The implementation class.

getName()

Accessor to the object’s name.

Returns:
name : str

The name of the object.

setName(name)

Accessor to the object’s name.

Parameters:
name : str

The name of the object.

thisown

The membership flag