Tuples

class Tuples(*args)

Tuples generator.

Parameters:
boundsIndices

The cardinal of all the sets forming the cartesian product.

Methods

generateNext()

Generate the next element of the combinatorial sequence.

getBounds()

Accessor to the bounds.

getClassName()

Accessor to the object's name.

getDimension()

Get the dimension of the generated indices.

getName()

Accessor to the object's name.

getSize()

Get the number of elements of the combinatorial sequence.

hasName()

Test if the object is named.

restart()

Restart the combinatorial sequence from its beginning.

setBounds(bounds)

Accessor to the bounds.

setName(name)

Accessor to the object's name.

generate

Notes

In the first usage, the generator is built using the default values bounds = [1].

In the second usage, the generator produces all the indices [i_0, \ldots, i_{d-1}] with i_k \in \{0, \ldots, bounds[k] - 1\} where d is the dimension of bounds.

The number of indices generated is:

\prod_{k = 0}^{d - 1} bounds[k]

The tuples generator generates a collection of Indices that contains all the elements of the following Cartesian product:

\prod_{k = 0}^{d - 1} \{ 0, \ldots, bounds[k] -1 \}

Examples

>>> import openturns as ot
>>> tuples = ot.Tuples([3, 4])
>>> print(tuples.getSize())
12
>>> for indices in tuples:
...     print(indices)
[0,0]
[1,0]
[2,0]
[0,1]
[1,1]
[2,1]
[0,2]
[1,2]
[2,2]
[0,3]
[1,3]
[2,3]
__init__(*args)
generateNext()

Generate the next element of the combinatorial sequence.

Returns:
indicesIndices

The next element of the sequence. The order in which the elements are generated depends on the concrete generator.

Notes

The generator holds an internal state, as SplitterImplementation does. restart starts the sequence over from its beginning. Once all the getSize elements have been generated, calling this method raises an exception. In Python, the generator can also be iterated over directly:

for indices in ot.Combinations(2, 5):
    print(indices)
getBounds()

Accessor to the bounds.

Returns:
boundsIndices

The cardinal of all the sets forming the cartesian product.

getClassName()

Accessor to the object’s name.

Returns:
class_namestr

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

getDimension()

Get the dimension of the generated indices.

Returns:
dimensionint

The size of each Indices generated by generateNext.

getName()

Accessor to the object’s name.

Returns:
namestr

The name of the object.

getSize()

Get the number of elements of the combinatorial sequence.

Returns:
sizeint

The number of total elements generated, without building the whole collection.

hasName()

Test if the object is named.

Returns:
hasNamebool

True if the name is not empty.

restart()

Restart the combinatorial sequence from its beginning.

Notes

The next call to generateNext (or to the Python iterator) generates the first element of the sequence again.

setBounds(bounds)

Accessor to the bounds.

Parameters:
boundsIndices

The cardinal of all the sets forming the cartesian product.

setName(name)

Accessor to the object’s name.

Parameters:
namestr

The name of the object.

Examples using the class

Combinatorial generators

Combinatorial generators