Combinations¶
- class Combinations(*args)¶
Combinations generator.
- Parameters:
- kint
The cardinal of the subsets
- nint
The cardinal of the base set
See also
Notes
In the first usage, the generator is built using the default values , .
In the second usage, the generator produces all the subsets with k elements of a base set with n elements. The subsets are produced as a collection of
Indices
in lexical order, the elements of each subset being sorted in increasing order.The number of indices generated is:
The combinations generator generates a collection of
Indices
where:Examples
>>> import openturns as ot >>> tuples = ot.Combinations(2, 5) >>> print(tuples.generate()) [[0,1],[0,2],[0,3],[0,4],[1,2],[1,3],[1,4],[2,3],[2,4],[3,4]]#10
Methods
generate
()Generate the combinatorial sequence.
Accessor to the object's name.
getK
()Accessor to the cardinal of the subsets.
getN
()Accessor to the cardinal of the base set.
getName
()Accessor to the object's name.
hasName
()Test if the object is named.
setK
(k)Accessor to the cardinal of the subsets.
setN
(n)Accessor to the cardinal of the base set.
setName
(name)Accessor to the object's name.
- __init__(*args)¶
- generate()¶
Generate the combinatorial sequence.
- getClassName()¶
Accessor to the object’s name.
- Returns:
- class_namestr
The object class name (object.__class__.__name__).
- getK()¶
Accessor to the cardinal of the subsets.
- Returns:
- kint
The cardinal of the subsets.
- getN()¶
Accessor to the cardinal of the base set.
- Returns:
- nint
The cardinal of the base set.
- 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.
- setK(k)¶
Accessor to the cardinal of the subsets.
- Parameters:
- kint
The cardinal of the subsets.
- setN(n)¶
Accessor to the cardinal of the base set.
- Parameters:
- nint
The cardinal of the base set.
- setName(name)¶
Accessor to the object’s name.
- Parameters:
- namestr
The name of the object.