KPermutations

class KPermutations(*args)

K permutations generator.

Parameters:
kint

The cardinal of the origin set.

nint

The cardinal of the goal set.

See also

KPermutationsDistribution, CombinatorialGenerator, Combinations, Tuples

Notes

In the first usage, the generator is built using the default values k = 1, n = 1.

In the second usage, the generator is built using the value k = n.

In the third usage, the generator produces all the injective functions from a set with k elements into a set with n elements. If k = n it means all the permutations of a set with n elements.

The number of indices generated is:

\frac{n!}{(n - k)!}

The combinations generator generates a collection of Indices that contains all the k! permutations of all the \frac{n!}{k! (n - k)!} subsets with k elements of a set with n elements.

The subsets are generated in lexical order, and for each subset all the corresponding injective functions are generated in lexical order.

Examples

>>> import openturns as ot
>>> kperm = ot.KPermutations(2, 4)
>>> print(kperm.generate())
[[0,1],[1,0],[0,2],[2,0],[0,3],[3,0],[1,2],[2,1],[1,3],[3,1],[2,3],[3,2]]#12

Methods

generate()

Generate the combinatorial sequence.

getClassName()

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.

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.

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.

Examples using the class

Combinatorial generators

Combinatorial generators