Tuples

class Tuples(*args)

Tuples generator.

Available constructors:

Tuples()

Tuples(bounds)

Parameters
boundsIndices

The cardinal of all the sets forming the cartesian product.

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(self)

Generate the combinatorial sequence.

getBounds(self)

Accessor to the bounds.

getClassName(self)

Accessor to the object’s name.

getId(self)

Accessor to the object’s id.

getName(self)

Accessor to the object’s name.

getShadowedId(self)

Accessor to the object’s shadowed id.

getVisibility(self)

Accessor to the object’s visibility state.

hasName(self)

Test if the object is named.

hasVisibleName(self)

Test if the object has a distinguishable name.

setBounds(self, bounds)

Accessor to the bounds.

setName(self, name)

Accessor to the object’s name.

setShadowedId(self, id)

Accessor to the object’s shadowed id.

setVisibility(self, visible)

Accessor to the object’s visibility state.

__init__(self, *args)

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

generate(self)

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(self)

Accessor to the bounds.

Returns
boundsIndices

The cardinal of all the sets forming the cartesian product.

getClassName(self)

Accessor to the object’s name.

Returns
class_namestr

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

getId(self)

Accessor to the object’s id.

Returns
idint

Internal unique identifier.

getName(self)

Accessor to the object’s name.

Returns
namestr

The name of the object.

getShadowedId(self)

Accessor to the object’s shadowed id.

Returns
idint

Internal unique identifier.

getVisibility(self)

Accessor to the object’s visibility state.

Returns
visiblebool

Visibility flag.

hasName(self)

Test if the object is named.

Returns
hasNamebool

True if the name is not empty.

hasVisibleName(self)

Test if the object has a distinguishable name.

Returns
hasVisibleNamebool

True if the name is not empty and not the default one.

setBounds(self, bounds)

Accessor to the bounds.

Parameters
boundsIndices

The cardinal of all the sets forming the cartesian product.

setName(self, name)

Accessor to the object’s name.

Parameters
namestr

The name of the object.

setShadowedId(self, id)

Accessor to the object’s shadowed id.

Parameters
idint

Internal unique identifier.

setVisibility(self, visible)

Accessor to the object’s visibility state.

Parameters
visiblebool

Visibility flag.