Tuples

class Tuples(*args)

Tuples generator.

Parameters:
boundsIndices

The cardinal of all the sets forming the cartesian product.

See also

CombinatorialGenerator, Combinations, KPermutations

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.generate())
[[0,0],[1,0],[2,0],[0,1],[1,1],[2,1],[0,2],[1,2],[2,2],[0,3],[1,3],[2,3]]#12

Methods

generate()

Generate the combinatorial sequence.

getBounds()

Accessor to the bounds.

getClassName()

Accessor to the object's name.

getName()

Accessor to the object's name.

hasName()

Test if the object is named.

setBounds(bounds)

Accessor to the bounds.

setName(name)

Accessor to the object's name.
__init__(*args)
generate()

Generate the combinatorial sequence.

Returns:
indicesColcollection 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.

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__).

getName()

Accessor to the object’s name.

Returns:
namestr

The name of the object.

hasName()

Test if the object is named.

Returns:
hasNamebool

True if the name is not empty.

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