Permutation groups

RepLAB provides ways to work with permutation groups.

Permutation groups are finite groups that are subgroups of the symmetric group acting on n elements.

In particular, the decomposition of \(\{1,...,n\}\) into orbits, the natural action and representation of the group are all defined.

• Permutation: Class with static methods to work with permutations.

• PermutationGroup: Describes a generic permutation group.

As a closely related variant, we describe signed permutations. Signed permutations act on the domain \(\{-n,...,-1, 1,...,n\}\).

• SignedPermutation: Class with static methods to work with signed permutations.

• SignedPermutationGroup: Describes a group of signed permutations.

Permutation

class replab.Permutation

This class regroups functions that are useful when dealing with permutations.

In RepLAB, permutations are represented using row vectors of integers, those integers being encoded using the type double; so this class does not have any instances.

Class members list

Properties

• cycleStructure – Returns the cycle structure of the given permutation

• cycles – Returns the cycles of the given permutation

• lexCompare – Returns the comparison of two permutations by lexicographic order

• order – Returns the order of the permutation

• sign – Returns the sign of a given permutation

• sorting – Returns the permutation that sorts a cell array using a custom comparison function

Construction

• fromCycles – Constructs a permutation from a product of cycles.

• shift – Returns the cyclic permutation that shifts the domain indices by i.

• transposition – Returns the transposition permuting i and j.

Matrix conversion

• fromMatrix – Returns the permutation corresponding to the given matrix representation

• toMatrix – Returns the permutation matrix corresponding to the given permutation

• toSparseMatrix – Returns the sparse permutation matrix corresponding to the given permutation

Own members

static cycleStructure(perm)

Returns the cycle structure of the given permutation

Example

>>> isequal(replab.Permutation.cycleStructure([2 1 4 3]), [2 2])
    1

Parameters

perm (permutation) – Permutation

Returns

Nonincreasing vector of integers containing the sizes of cycles (for sizes > 1)

Return type

integer(1,*)

static cycles(perm)

Returns the cycles of the given permutation

Example

>>> isequal(replab.Permutation.cycleStructure([2 1 4 3]), [2 2])
    1

Parameters

perm (permutation) – Permutation

Returns

Nonincreasing vector of integers containing the sizes of cycles (for sizes > 1)

Return type

integer(1,*)

static fromCycles(n, varargin)

Constructs a permutation from a product of cycles.

Each cycle is given as a row vector, and the sequence of cycles is given as variable arguments.

Parameters

• n (integer) – Domain size

• varargin (cell(1,*) of integer(1,*)) – Sequence of cycles as row vectors of indices

Returns

The permutation corresponding to the product of cycles.

Return type

permutation

static fromMatrix(mat)

Returns the permutation corresponding to the given matrix representation

See replab.Permutation.toMatrix

Parameters

mat – A permutation matrix.

Returns

The permutation corresponding to matrix mat.

Raises

Error – if mat is not a permutation matrix, throws an error

static lexCompare(lhs, rhs)

Returns the comparison of two permutations by lexicographic order

Parameters

• lhs (permutation) – First permutation

• rhs (permutation) – Second permutation

Returns

1 if lhs > rhs, 0 if lhs == rhs, -1 if lhs < rhs

Return type

integer

static order(perm)

Returns the order of the permutation

Parameters

perm (permutation) – Permutation

Returns

The order of perm, i.e. the smallest o such that perm^o == identity

Return type

integer

static shift(n, i)

Returns the cyclic permutation that shifts the domain indices by i.

Parameters

• n (integer) – Domain size

• i (nonnegative integer) – Shift so that j is sent to j + i (wrapping around).

Returns

The constructed cyclic shift

Return type

permutation

static sign(perm)

Returns the sign of a given permutation

Example

>>> replab.Permutation.sign([3 2 1 4])
    -1

Parameters

perm (permutation) – Permutation to compute the sign of

Returns

Sign of the permutation

Return type

integer

static sorting(array, greaterFun)

Returns the permutation that sorts a cell array using a custom comparison function

Parameters

• array – A (row or column) vector array containing data of arbitrary type

• greaterFun – A function handle that compares elements such that greaterFun(x, y) == true when x > y and false otherwise

Returns

A permutation p such that sorted = array(p)

static toMatrix(perm)

Returns the permutation matrix corresponding to the given permutation

The returned matrix is such that matrix multiplication is compatible with composition of permutations, i.e. for Sn = replab.S(domainSize) we have replab.permutation.toMatrix(Sn.compose(x, y)) = replab.Permutation.toMatrix(x) * replab.Permutation.toMatrix(y)

Parameters

perm (permutation) – Permutation

Returns

The permutation matrix corresponding to perm.

static toSparseMatrix(perm)

Returns the sparse permutation matrix corresponding to the given permutation

The returned matrix is such that matrix multiplication is compatible with composition of permutations. I.e. for Sn = replab.S(n) we have replab.Permutation.toMatrix(Sn.compose(x, y)) = replab.Permutation.toMatrix(x) * replab.Permutation.toMatrix(y)

Parameters

perm (permutation) – Permutation

Returns

The sparse permutation matrix corresponding to perm.

static transposition(n, i, j)

Returns the transposition permuting i and j.

Parameters

• n (integer) – Domain size

• i (integer) – First domain element to be transposed.

• j (integer) – Second domain element to be transposed.

Returns

The constructed transposition

Return type

permutation

PermutationGroup

class replab.PermutationGroup(domainSize, generators, varargin)

Bases: replab.FiniteGroup

Permutation group over the integer 1, .., domainSize

Class members list

Properties

• generators – Group generators

• identity – Monoid identity element

• type – Type of the contained elements

Prettyprinting

• additionalFields – Returns the name/value pairs corresponding to additional fields to be printed

• disp – Standard MATLAB/Octave display method

• headerStr – Tiny single line description of the current object type

• hiddenFields – Returns the names of the fields that are not printed as a row vector

• longStr – Multi-line description of the current object

• shortStr – Single line text description of the current object

Test helpers

• assertEqv – Compares two elements for equality

• assertNotEqv – Compares two elements for inequality

Sampling and equality test

• eqv – Tests domain elements for equality/equivalence

• sample – Samples an element from this set

Laws

• check – Checks the consistency of this object

• checkAndContinue – Checks the consistency of this object

• laws – Returns the laws that this object obeys

Property cache

• cache – Sets the value of the designated property in the cache

• cached – Returns the cached property if it exists, computing it if necessary

• cachedOrDefault – Returns the cached property if it exists, or the provided default value if it is unknown yet

• cachedOrEmpty – Returns the cached property if it exists, or [] if it is unknown yet

• inCache – Returns whether the value of the given property has already been computed

Unique ID

• eq – Equality test

• id – Returns the unique ID of this object (deprecated)

• isequal – Tests finite sets for equality

• ne – Non-equality test

Monoid operations

• areCommuting – Returns whether the two given elements commute

• compose – Composes two monoid/group elements

• composeAll – Composes a sequence of monoid elements

• composeN – Computes the power of a given element by repeated squaring

• isIdentity – Tests if the given element is the identity

Morphisms

• abstractIsomorphism – Returns an isomorphism to an abstract group

• automorphismGroup – Returns the automorphism group of this group

• commutingMorphismsMorphism – Constructs a morphism from morphisms with commuting images

• conjugatingAutomorphism – Returns the morphism that corresponds to left conjugation by an element

• findIsomorphism – Finds an isomorphism from this finite group to another finite group, if it exists

• findIsomorphisms – Finds all the isomorphisms from this finite group to another finite group

• findMorphisms – Finds all the morphisms from this finite group to another finite group

• innerAutomorphism – Returns the inner automorphism given using conjugation by the given element

• isIsomorphicTo – Returns whether this group is isomorphic to another group

• isMorphismByImages – Checks whether the given images describe a group morphism

• isomorphismByFunction – Constructs an isomorphism to a finite group using an image function

• isomorphismByFunctions – Constructs a group isomorphism using preimage/image functions

• isomorphismByImages – Constructs an isomorphism to a group using images of generators

• morphismByFunction – Constructs a group morphism using an image function

• morphismByImages – Constructs a morphism to a group using images of generators

• orderPreservingPermutationIsomorphism – Returns an isomorphism from this group to a permutation group, which preserves element order

• permutationIsomorphism – Returns an isomorphism from this group to a permutation group

• regularIsomorphism – Returns an isomorphism from this group to a permutation group whose degree matches the order of this group

Group methods

• commutator – Returns the commutator of two group elements

• composeFlat – Returns the composition of elements from an array picked according to the given indices/letters

• composeWithInverse – Returns the composition of an element with the inverse of another element

• inverse – Computes the inverse of an element

• leftConjugate – Returns the left conjugate of a group element

Elements

• contains – Tests whether this set contains the given element

• elementOrder – Returns the order of a group element

• elements – Returns a cell array containing all the elements of this set

• elementsSequence – Returns a sequence corresponding to this set

• nElements – Returns the size of this set

• representative – Returns the minimal element of this set under the type ordering

• setProduct – Returns a description of this set as a product of sets

• smallGeneratingSet – Returns a small set of elements generating the group

Relations to other sets

• hasSameTypeAs – Returns if this finite set has the same type as the given finite set

Image under isomorphism

• imap – Returns the image of this finite set under an isomorphism

General

• fromChain – Creates a permutation group from a BSGS chain

• mtimes –

Representations

• commutingRepsRep – Constructs a representation from commuting representations

• directSumRep – Computes the direct sum of representations on this group

• indexRelabelingRep – Representation that permutes the indices of a tensor

• naturalRep – Returns the natural permutation representation of this permutation group

• permutationRep – Constructs a permutation representation of this group

• regularRep – Returns the left regular representation of this group

• repByImages – Constructs a finite dimensional representation of this group from preimages/images pairs

• signRep – Returns the sign representation of this permutation group

• signedPermutationRep – Returns a real signed permutation representation of this group

• standardRep – Returns the standard representation of this permutation group

• tensorRep – Computes the tensor product of representations

• trivialRep – Returns the trivial representation of this group on a finite dimensional vector space

Group construction

• directPower – Returns the direct product of this group with itself a number of times

• directProduct – Returns the direct product of groups

• semidirectProduct – Describes an external semidirect product of groups

Group properties

• abelianInvariants – Returns the group abelian invariants

• exponent – Returns the group exponent

• fastRecognize – Attempts to recognize this group in the standard atlas

• hasReconstruction – Returns whether the group has a “reconstruction”

• isCommutative – Returns whether this group is commutative

• isCyclic – Returns whether this group is a cyclic group

• isSimple – Returns whether this group is simple

• isTrivial – Tests whether this group is trivial

• knownOrder – Returns whether the order of this group has already been computed

• maximalTorusDimension – Returns, if available, the dimension of the maximal torus contained in the connected component of this group

• order – Returns the group order

• presentation – Returns a presentation of this group as a string

• recognize – Attempts to recognize this group in the standard atlas

• reconstruction – Returns a reconstruction of the group used to speed up group averaging

Isomorphic groups

• abstractGroup – Returns an abstract group isomorphic to this finite gorup

• permutationGroup – Returns the permutation group isomorphic to this finite group

Subgroups

• center – Returns the center of this group

• centralizer – Returns the centralizer of the given object in this group

• derivedSeries – Returns the derived series of this group

• derivedSubgroup – Computes the derived subgroup of this group

• intersection – Computes the intersection of two groups

• randomProperSubgroup – Constructs a random proper subgroup of this group

• randomSubgroup – Constructs a random subgroup of this group

• subgroup – Constructs a subgroup of the current group from elements

• subgroupWithGenerators – Constructs a subgroup of the current group from generators

• trivialSubgroup – Returns the trivial subgroup of this group

Conjugacy classes and character table

• characterTable – Alias for complexCharacterTable

• complexCharacterTable – Returns the complex character table of this group

• conjugacyClass – Returns the conjugacy class corresponding to the given element

• conjugacyClasses – Returns the conjugacy classes of this group

• findLeftConjugations – Returns the set of all elements that left conjugates an element to another element

• knownComplexCharacterTable – Returns whether the complex character table of this group is already known or computed

• knownRealCharacterTable – Returns whether the real character table of this group is already known or computed

• realCharacterTable – Returns the real character table of this group

• setComplexCharacterTable – Sets the complex character table of this group

• setConjugacyClasses – Sets the conjugacy classes of this group

• setRealCharacterTable – Sets the real character table of this group

Construction of groups

• closure – Computes the group generated by the elements of this group and other elements/groups

• leftConjugateGroup – Returns the left conjugate of the current group by the given element

• normalClosure – Computes the normal closure of an object in the closure of this group and this object

• withGeneratorNames – Returns a modified copy of this finite group with renamed generators

Cosets

• doubleCoset – Returns a double coset

• doubleCosets – Returns the set of double cosets in this group by the given groups

• isNormalizedBy – Returns whether a given element/group normalizes this group

• leftCoset – Returns a left coset

• leftCosets – Returns the set of left cosets of the given subgroup in this group

• mldivide – Shorthand for rightCosets

• mrdivide – Shorthand for leftCosets

• normalCoset – Returns a normal coset

• normalCosets – Returns the set of normal cosets of the given subgroup in this group

• rightCoset – Returns a right coset

• rightCosets – Returns the set of right cosets of the given subgroup in this group

Generators-related methods

• factorizeFlat – Factorizes an element or a coset as a flat sequence in the generators

• factorizeWord – Factorizes an element or a coset as a word in the generators

• flatToWord – Prints a word described by letters into a string

• generator – Returns the i-th group generator

• generatorInverse – Returns the inverse of the i-th group generator

• generatorNames – Returns the names of the group generators

• imageFlat – Returns the image of a flat word in the group generators

• imageWord – Computes the image of a word in the group generators

• knownRelators – Returns whether the relators of this group are known

• nGenerators – Returns the number of group generators

• relatorsFlat – Returns the relators of a presentation of this finite group in the flat format

• relatorsWord – Returns the relators of a presentation of this finite group

• wordToFlat – Parses a word into generator letters

Relations to other groups

• isNormalSubgroupOf – Returns whether this group is a normal subgroup of another group

• isSubgroupOf – Returns whether this group is a subgroup of another group

Constructor

• PermutationGroup – Constructs a permutation group

Construction of standard groups

• alternating – Constructs the alternating group

• cyclic – Constructs the cyclic group of order n acting on n points

• dihedral – Constructs the dihedral group of order 2*n

• kleinFourGroup – Constructs the Klein Four-Group

• symmetric – Returns the symmetric group acting on a certain domain size

• trivial – Constructs the trivial permutation group acting on n points

Group internal description

• chain – Returns the stabilizer chain corresponding to this permutation group.

• factorization – Returns an object able to compute factorizations in the group generators

• lexChain – Returns the reduced stabilizer chain corresponding to this permutation group in lexicographic order

• partialChain – Returns the stabilizer chain corresponding to this permutation group if it can be computed quickly

Methods specific to permutation groups

• domainSize –

• generatorsAsMatrix – Returns the generators of this group concatenated in a matrix

• matrixFindPermutationsTo – Finds the permutations that send a matrix to another matrix

• matrixStabilizer – Returns the permutation subgroup that leaves a given matrix invariant by joint permutation of its rows and columns

• orbits – Returns the partition of the domain into orbits under this group

• orderedPartitionStabilizer – Computes the subgroup that leaves the given ordered partition invariant

• pointwiseStabilizer – Returns the subgroup that stabilizes the given set pointwise

• setwiseStabilizer – Returns the subgroup that stabilizes the given set as a set

• stabilizer – Returns the subgroup that stabilizes a given point

• unorderedPartitionStabilizer – Computes the subgroup that leaves the given unordered partition invariant

• vectorFindLexMinimal – Finds the lexicographic minimal vector under permutation of its coefficients by this group

• vectorFindPermutationsTo – Finds the permutations that send a vector to another vector

• vectorStabilizer – Returns the permutation subgroup that leaves a given vector invariant

• wreathProduct – Returns the wreath product of a compact group by this permutation group

Actions

• indexRelabelingMorphism – Returns the morphism the permutation action of this group on tensor coefficients

• indexRelabelingPermutation – Returns the permutation that acts by permuting tensor coefficients

• matrixAction – Returns the simultaneous action of permutations on both rows and columns of square matrices

• naturalAction – Returns the natural action of elements of this group on its domain

• vectorAction – Returns the action of permutations on column vectors

Construction of permutation groups

• of – Constructs a nontrivial permutation group from the given generators

• permutingGivenPoints – Constructs the group that permutes the given points

Inherited elements

abelianInvariants(self)

Documentation in replab.FiniteGroup.abelianInvariants()

abstractGroup(self)

Documentation in replab.FiniteGroup.abstractGroup()

abstractIsomorphism(self)

Documentation in replab.FiniteGroup.abstractIsomorphism()

additionalFields(self)

Documentation in replab.Str.additionalFields()

areCommuting(self, x, y)

Documentation in replab.Monoid.areCommuting()

assertEqv(self, x, y, context)

Documentation in replab.Domain.assertEqv()

assertNotEqv(self, x, y, context)

Documentation in replab.Domain.assertNotEqv()

automorphismGroup(self)

Documentation in replab.Group.automorphismGroup()

cache(self, name, value, handleExisting)

Documentation in replab.Obj.cache()

cached(self, name, fun)

Documentation in replab.Obj.cached()

cachedOrDefault(self, name, defaultValue)

Documentation in replab.Obj.cachedOrDefault()

cachedOrEmpty(self, name)

Documentation in replab.Obj.cachedOrEmpty()

center(self)

Documentation in replab.FiniteGroup.center()

centralizer(self, arg)

Documentation in replab.FiniteGroup.centralizer()

characterTable(self)

Documentation in replab.FiniteGroup.characterTable()

check(self)

Documentation in replab.Obj.check()

checkAndContinue(self)

Documentation in replab.Obj.checkAndContinue()

closure(self, varargin)

Documentation in replab.FiniteGroup.closure()

commutator(self, x, y, startWithInverse)

Documentation in replab.Group.commutator()

commutingMorphismsMorphism(self, target, morphisms)

Documentation in replab.Group.commutingMorphismsMorphism()

commutingRepsRep(self, field, dimension, reps)

Documentation in replab.CompactGroup.commutingRepsRep()

complexCharacterTable(self)

Documentation in replab.FiniteGroup.complexCharacterTable()

compose(self, x, y)

Documentation in replab.Monoid.compose()

composeAll(self, elements)

Documentation in replab.Monoid.composeAll()

composeFlat(self, array, letters)

Documentation in replab.Group.composeFlat()

composeN(self, x, n)

Documentation in replab.Monoid.composeN()

composeWithInverse(self, x, y)

Documentation in replab.Group.composeWithInverse()

conjugacyClass(self, g, varargin)

Documentation in replab.FiniteGroup.conjugacyClass()

conjugacyClasses(self)

Documentation in replab.FiniteGroup.conjugacyClasses()

conjugatingAutomorphism(self, by)

Documentation in replab.FiniteGroup.conjugatingAutomorphism()

contains(self, el)

Documentation in replab.FiniteSet.contains()

derivedSeries(self)

Documentation in replab.FiniteGroup.derivedSeries()

derivedSubgroup(self)

Documentation in replab.FiniteGroup.derivedSubgroup()

directPower(self, n)

Documentation in replab.CompactGroup.directPower()

directProduct(varargin)

Documentation in replab.CompactGroup.directProduct()

directSumRep(self, field, reps)

Documentation in replab.CompactGroup.directSumRep()

disp(self)

Documentation in replab.Str.disp()

domainSize()

No documentation

doubleCoset(self, element, rightSubgroup, varargin)

Documentation in replab.FiniteGroup.doubleCoset()

doubleCosets(self, leftSubgroup, rightSubgroup)

Documentation in replab.FiniteGroup.doubleCosets()

elementOrder(self, g)

Documentation in replab.FiniteGroup.elementOrder()

elements(self)

Documentation in replab.FiniteSet.elements()

elementsSequence(self)

Documentation in replab.FiniteSet.elementsSequence()

eq(self, rhs)

Documentation in replab.Obj.eq()

eqv(self, t, u)

Documentation in replab.Domain.eqv()

exponent(self)

Documentation in replab.FiniteGroup.exponent()

factorizeFlat(self, elementOrCoset)

Documentation in replab.FiniteGroup.factorizeFlat()

factorizeWord(self, elementOrCoset)

Documentation in replab.FiniteGroup.factorizeWord()

fastRecognize(self)

Documentation in replab.FiniteGroup.fastRecognize()

findIsomorphism(self, to)

Documentation in replab.FiniteGroup.findIsomorphism()

findIsomorphisms(self, to, varargin)

Documentation in replab.FiniteGroup.findIsomorphisms()

findLeftConjugations(self, s, t, varargin)

Documentation in replab.FiniteGroup.findLeftConjugations()

findMorphisms(self, to, varargin)

Documentation in replab.FiniteGroup.findMorphisms()

flatToWord(self, letters)

Documentation in replab.FiniteGroup.flatToWord()

generator(self, i)

Documentation in replab.FiniteGroup.generator()

generatorInverse(self, i)

Documentation in replab.FiniteGroup.generatorInverse()

generatorNames(self)

Documentation in replab.FiniteGroup.generatorNames()

generators

Documentation in replab.FiniteGroup.generators

hasReconstruction(self)

Documentation in replab.CompactGroup.hasReconstruction()

hasSameTypeAs(self, rhs)

Documentation in replab.FiniteSet.hasSameTypeAs()

headerStr(self)

Documentation in replab.Str.headerStr()

hiddenFields(self)

Documentation in replab.Str.hiddenFields()

id(self)

Documentation in replab.Obj.id()

identity

Documentation in replab.Monoid.identity

imageFlat(self, letters)

Documentation in replab.FiniteGroup.imageFlat()

imageWord(self, word)

Documentation in replab.FiniteGroup.imageWord()

imap(self, f)

Documentation in replab.FiniteSet.imap()

inCache(self, name)

Documentation in replab.Obj.inCache()

innerAutomorphism(self, by)

Documentation in replab.Group.innerAutomorphism()

intersection(self, G)

Documentation in replab.FiniteGroup.intersection()

inverse(self, x)

Documentation in replab.Group.inverse()

isCommutative(self)

Documentation in replab.FiniteGroup.isCommutative()

isCyclic(self)

Documentation in replab.FiniteGroup.isCyclic()

isIdentity(self, x)

Documentation in replab.Monoid.isIdentity()

isIsomorphicTo(self, target)

Documentation in replab.FiniteGroup.isIsomorphicTo()

isMorphismByImages(self, target, varargin)

Documentation in replab.FiniteGroup.isMorphismByImages()

isNormalSubgroupOf(self, rhs)

Documentation in replab.FiniteGroup.isNormalSubgroupOf()

isNormalizedBy(self, element)

Documentation in replab.FiniteGroup.isNormalizedBy()

isSimple(self)

Documentation in replab.FiniteGroup.isSimple()

isSubgroupOf(self, rhs)

Documentation in replab.FiniteGroup.isSubgroupOf()

isTrivial(self)

Documentation in replab.FiniteGroup.isTrivial()

isequal(self, rhs)

Documentation in replab.FiniteSet.isequal()

isomorphismByFunction(self, target, imageElementFun, varargin)

Documentation in replab.FiniteGroup.isomorphismByFunction()

isomorphismByFunctions(self, target, preimageElementFun, imageElementFun, torusMap)

Documentation in replab.Group.isomorphismByFunctions()

isomorphismByImages(self, target, varargin)

Documentation in replab.FiniteGroup.isomorphismByImages()

knownComplexCharacterTable(self)

Documentation in replab.FiniteGroup.knownComplexCharacterTable()

knownOrder(self)

Documentation in replab.FiniteGroup.knownOrder()

knownRealCharacterTable(self)

Documentation in replab.FiniteGroup.knownRealCharacterTable()

knownRelators(self)

Documentation in replab.FiniteGroup.knownRelators()

laws(self)

Documentation in replab.Obj.laws()

leftConjugate(self, by, on)

Documentation in replab.Group.leftConjugate()

leftConjugateGroup(self, by)

Documentation in replab.FiniteGroup.leftConjugateGroup()

leftCoset(self, element, varargin)

Documentation in replab.FiniteGroup.leftCoset()

leftCosets(self, subgroup)

Documentation in replab.FiniteGroup.leftCosets()

longStr(self, maxRows, maxColumns)

Documentation in replab.Str.longStr()

maximalTorusDimension(self)

Documentation in replab.CompactGroup.maximalTorusDimension()

mldivide(self, supergroup)

Documentation in replab.FiniteGroup.mldivide()

morphismByFunction(self, target, imageElementFun, torusMap)

Documentation in replab.Group.morphismByFunction()

morphismByImages(self, target, varargin)

Documentation in replab.FiniteGroup.morphismByImages()

mrdivide(self, subgroup)

Documentation in replab.FiniteGroup.mrdivide()

mtimes()

No documentation

nElements(self)

Documentation in replab.FiniteSet.nElements()

nGenerators(self)

Documentation in replab.FiniteGroup.nGenerators()

ne(self, rhs)

Documentation in replab.Obj.ne()

normalClosure(self, obj)

Documentation in replab.FiniteGroup.normalClosure()

normalCoset(self, element, varargin)

Documentation in replab.FiniteGroup.normalCoset()

normalCosets(self, subgroup)

Documentation in replab.FiniteGroup.normalCosets()

order(self)

Documentation in replab.FiniteGroup.order()

orderPreservingPermutationIsomorphism(self)

Documentation in replab.FiniteGroup.orderPreservingPermutationIsomorphism()

permutationGroup(self)

Documentation in replab.FiniteGroup.permutationGroup()

permutationIsomorphism(self)

Documentation in replab.FiniteGroup.permutationIsomorphism()

permutationRep(self, dimension, varargin)

Documentation in replab.FiniteGroup.permutationRep()

presentation(self)

Documentation in replab.FiniteGroup.presentation()

randomProperSubgroup(self, nSteps)

Documentation in replab.FiniteGroup.randomProperSubgroup()

randomSubgroup(self)

Documentation in replab.FiniteGroup.randomSubgroup()

realCharacterTable(self)

Documentation in replab.FiniteGroup.realCharacterTable()

recognize(self)

Documentation in replab.FiniteGroup.recognize()

reconstruction(self)

Documentation in replab.CompactGroup.reconstruction()

regularIsomorphism(self)

Documentation in replab.FiniteGroup.regularIsomorphism()

regularRep(self)

Documentation in replab.FiniteGroup.regularRep()

relatorsFlat(self)

Documentation in replab.FiniteGroup.relatorsFlat()

relatorsWord(self)

Documentation in replab.FiniteGroup.relatorsWord()

repByImages(self, field, dimension, varargin)

Documentation in replab.FiniteGroup.repByImages()

representative(self)

Documentation in replab.FiniteSet.representative()

rightCoset(self, element, varargin)

Documentation in replab.FiniteGroup.rightCoset()

rightCosets(self, subgroup)

Documentation in replab.FiniteGroup.rightCosets()

sample(self)

Documentation in replab.Domain.sample()

semidirectProduct(self, N, phi)

Documentation in replab.CompactGroup.semidirectProduct()

setComplexCharacterTable(self, table)

Documentation in replab.FiniteGroup.setComplexCharacterTable()

setConjugacyClasses(self, classes)

Documentation in replab.FiniteGroup.setConjugacyClasses()

setProduct(self)

Documentation in replab.FiniteSet.setProduct()

setRealCharacterTable(self, table)

Documentation in replab.FiniteGroup.setRealCharacterTable()

shortStr(self, maxColumns)

Documentation in replab.Str.shortStr()

signedPermutationRep(self, dimension, varargin)

Documentation in replab.FiniteGroup.signedPermutationRep()

smallGeneratingSet(self)

Documentation in replab.FiniteGroup.smallGeneratingSet()

subgroup(self, elements, varargin)

Documentation in replab.FiniteGroup.subgroup()

subgroupWithGenerators(self, generators, varargin)

Documentation in replab.FiniteGroup.subgroupWithGenerators()

tensorRep(self, field, reps)

Documentation in replab.CompactGroup.tensorRep()

trivialRep(self, field, dimension)

Documentation in replab.CompactGroup.trivialRep()

trivialSubgroup(self)

Documentation in replab.FiniteGroup.trivialSubgroup()

type

Documentation in replab.FiniteSet.type

withGeneratorNames(self, newNames)

Documentation in replab.FiniteGroup.withGeneratorNames()

wordToFlat(self, word)

Documentation in replab.FiniteGroup.wordToFlat()

Own members

generatorNames_

Generator names

Type

cell(1,*) of charstring

PermutationGroup(domainSize, generators, varargin)

Constructs a permutation group

Parameters

• domainSize (integer) – Domain size of this permutation group

• generators (cell(1,*) of permutation) – Group generators

• chain – BSGS chain describing the group

• generatorNames – Names of the generators

• order – Order of the group

• relators – Relators given either in word or letter format

Kwtype chain

replab.bsgs.Chain

Kwtype generatorNames

cell(1,*) of charstring

Kwtype order

vpi, optional

Kwtype relators

cell(1,*) of charstring

static alternating(n)

Constructs the alternating group

Parameters

n (integer) – Group degree

Returns

The alternating group of degree n

Return type

replab.PermutationGroup

chain(self)

Returns the stabilizer chain corresponding to this permutation group.

Returns

Stabilizer chain

Return type

replab.bsgs.Chain

static cyclic(n)

Constructs the cyclic group of order n acting on n points

Parameters

n (integer) – Cyclic group order and domain size

Returns

The cyclic group of given order/domain size

Return type

replab.PermutationGroup

static dihedral(n)

Constructs the dihedral group of order 2*n

This corresponds to the group of symmetries of the polygon with n vertices

Parameters

n (integer) – Half the dihedral group order

Returns

The dihedral group permuting the vertices of the n-gon

Return type

replab.PermutationGroup

factorization(self)

Returns an object able to compute factorizations in the group generators

Returns

A factorization instance

Return type

replab.mrp.Factorization

static fromChain(chain)

Creates a permutation group from a BSGS chain

This method is mostly used internally.

Parameters

chain (replab.bsgs.Chain) – BSGS chain

Returns

Permutation group

Return type

PermutationGroup

generatorsAsMatrix(self)

Returns the generators of this group concatenated in a matrix

Returns

Matrix whose rows are the group generators

Return type

integer(*,*)

indexRelabelingMorphism(self, indexRange)

Returns the morphism the permutation action of this group on tensor coefficients

The tensor coefficients correspond to R^ir x R^ir ... (domainSize times) where ir = indexRange.

The enumeration of indices is done in the same order as in indexRelabelingPermutation: if I = (i1, ..., id) is a sequence of indices, we increment first id, then i_{d-1} and so on.

See also

replab.PermutationGroup.indexRelabelingPermutation

Parameters

indexRange (integer) – Dimension of each subindex

Returns

The permutation group homomorphism

Return type

function_handle

indexRelabelingPermutation(self, g, indexRange)

Returns the permutation that acts by permuting tensor coefficients

Let I = (i_1, ..., i_d) be a sequence of indices, where d = self.domainSize and 1 <= i_1,...,i_d <= indexRange

We enumerate elements of I by first incrementing i_d, then i_{d-1}, etc…

We compute the permutation of domain size indexRange^domainSize that acts on the indices of I according to the argument g.

Parameters

• g (permutation) – Permutation of subindices

• indexRange (integer) – Dimension of each subindex

Returns

The permutation on the enumeration of indices

Return type

permutation

indexRelabelingRep(self, indexRange)

Representation that permutes the indices of a tensor

It acts on the tensor space R^ir x R^ir … (domainSize times) where ir = indexRange, by permuting the indices.

The representation returned is real.

See also

replab.PermutationGroup.indexRelabelingPermutation

Parameters

indexRange (integer) – Dimension of the tensor components/range of the subindices

Returns

The desired permutation representation

Return type

replab.Rep

static kleinFourGroup()

Constructs the Klein Four-Group

This corresponds to the symmetry group of a non-square rectangle, and corresponds to the direct product S2 x S2.

Returns

The Klein four-group as a permutation gorup

Return type

replab.PermutationGroup

lexChain(self)

Returns the reduced stabilizer chain corresponding to this permutation group in lexicographic order

No base points are redundant.

Returns

Stabilizer chain

Return type

replab.bsgs.Chain

matrixAction(self)

Returns the simultaneous action of permutations on both rows and columns of square matrices

Acts on matrices of size self.domainSize x self.domainSize

Returns

The matrix action

Return type

replab.Action

matrixFindPermutationsTo(self, S, T, SStabilizer, TStabilizer)

Finds the permutations that send a matrix to another matrix

We return the set of p such that T == S(inverse(p),inverse(p)) or S == T(p,p).

We use this notation as the left action of p on a matrix S is given by S(inverse(p),inverse(p)).

Parameters

• S (double(1,domainSize)) – Source matrix

• T (double(1,domainSize)) – Target matrix

• SStabilizer (PermutationGroup or [], optional) – Stabilizer of S

• TStabilizer (PermutationGroup or [], optional) – Stabilizer of T

Returns

The set of permutations {p} such that T == S(inverse(p),inverse(p)); or [] if no element found

Return type

replab.LeftCoset

matrixStabilizer(self, matrix)

Returns the permutation subgroup that leaves a given matrix invariant by joint permutation of its rows and columns

Example

>>> S4 = replab.S(4);
>>> A = [1 1 0 1; 1 1 1 0; 0 1 1 1; 1 0 1 1]; % adjacency matrix of the square
>>> G = S4.matrixStabilizer(A);
>>> G.order == 8 % is the dihedral group of order 8
    1

Parameters

matrix (double(domainSize,domainSize)) – Matrix to stabilize under permutation

Returns

The subgroup of this group such that every element g satisfies matrix(g,g) == matrix

Return type

PermutationGroup

naturalAction(self)

Returns the natural action of elements of this group on its domain

This group natural domain is the set of integers {1..domainSize}

Returns

The natural action

Return type

replab.Action

naturalRep(self)

Returns the natural permutation representation of this permutation group

Returns

The (real) natural permutation representation

Return type

replab.Rep

static of(varargin)

Constructs a nontrivial permutation group from the given generators

Example

>>> G = replab.PermutationGroup.of([2 3 4 1], [4 3 2 1]);
>>> G.order
  8

The generators of the group can be named by preceding them all by a charstring:

Example

>>> G = replab.PermutationGroup.of('r', [2 3 4 1], 's', [4 3 2 1]);
>>> G.order
    8
>>> G.factorizeWord([3 4 1 2])
    'r^2'

This method cannot construct trivial groups without any generators. In that case, use the constructor:

Example

>>> generators = {};
>>> domainSize = 4;
>>> G = replab.PermutationGroup(domainSize, generators);
>>> G.order
    1

Parameters

varargin (cell(1,*) of permutation) – Group generators

Returns

The permutation group given as the closure of the generators

Return type

PermutationGroup

orbits(self)

Returns the partition of the domain into orbits under this group

Permutation group orbits are also called domains of transitivity, see https://www.encyclopediaofmath.org/index.php/Transitive_group

Returns

The orbit partition

Return type

Partition

orderedPartitionStabilizer(self, partition)

Computes the subgroup that leaves the given ordered partition invariant

The subgroup maps every block of the partition to itself under permutation of the domain elements.

Example

>>> S4 = replab.S(4);
>>> G = S4.orderedPartitionStabilizer(replab.Partition.fromVector([1 1 2 2]));
>>> G == S4.subgroup({[2 1 3 4] [1 2 4 3]})
    1

Parameters

partition (Partition) – Ordered partition to leave invariant

Returns

The subgroup that stabilizes the ordered partition

Return type

PermutationGroup

partialChain(self)

Returns the stabilizer chain corresponding to this permutation group if it can be computed quickly

static permutingGivenPoints(n, points)

Constructs the group that permutes the given points

Essentially constructs the symmetric group of order |points|.

Parameters

• n (integer) – Domain size of the created group

• points (integer(1,*)) – Set of points being permuted

Returns

The permutation group

Return type

PermutationGroup

pointwiseStabilizer(self, set)

Returns the subgroup that stabilizes the given set pointwise

i.e. for this group G, it returns H = {g \in G : g(i) = i, i \in set}.

Example

>>> S4 = replab.S(4);
>>> G = S4.pointwiseStabilizer([1 2]);
>>> G.order == 2
    1

Parameters

set (integer(1,*)) – The set to stabilize pointwise

Returns

The subgroup that stabilizes the set pointwise

Return type

replab.PermutationGroup

setwiseStabilizer(self, set)

Returns the subgroup that stabilizes the given set as a set

i.e. for this group G, it returns H = {g \in G : g(set) = set}

Example

>>> G = replab.PermutationGroup.of([3 1 2 4], [1 4 2 3]);
>>> H = G.setwiseStabilizer([1 2]);
>>> H == replab.PermutationGroup.of([2 1 4 3])
    1

Example

>>> G = replab.PermutationGroup.of([1,3,2,10,9,8,6,5,7,4], [1,4,3,2,5,6,7,8,9,10]);
>>> H = G.setwiseStabilizer([2 3]);
>>> H.order
    10

Parameters

set (integer(1,*)) – The set to stabilize

Returns

The subgroup that stabilizes the set

Return type

replab.PermutationGroup

signRep(self)

Returns the sign representation of this permutation group

Returns

One dimensional sign representation of this group

Return type

replab.Rep

stabilizer(self, p)

Returns the subgroup that stabilizes a given point

standardRep(self)

Returns the standard representation of this permutation group

It is an abuse of terminology as the “standard representation” is the faithful \(n-1\) dimensional representation of the symmetric group acting on \(n\) elements; but we can reuse that subrepresentation on subgroups of the symmetric group.

It corresponds to the representation complementary to the trivial representation with basis [1, 1, ..., 1]'

Returns

The (real) standard representation

Return type

replab.SubRep

static symmetric(n)

Returns the symmetric group acting on a certain domain size

Parameters

domainSize (integer) – Domain size, must be >= 0

Returns

Symmetric group

Return type

replab.PermutationGroup

static trivial(n)

Constructs the trivial permutation group acting on n points

Example

>>> G = replab.PermutationGroup.trivial(4);
>>> G.order
  1

Parameters

n (integer) – Domain size

Returns

Trivial group

Return type

replab.PermutationGroup

unorderedPartitionStabilizer(self, partition)

Computes the subgroup that leaves the given unordered partition invariant

Example

>>> S4 = replab.S(4);
>>> G = S4.unorderedPartitionStabilizer(replab.Partition.fromVector([1 1 2 2]));
>>> G == S4.subgroup({[2 1 3 4] [3 4 1 2]})
    1

Parameters

partition (Partition) – Unordered partition to leave invariant

Returns

The subgroup that stabilizes the unordered partition

Return type

PermutationGroup

vectorAction(self)

Returns the action of permutations on column vectors

Acts on vectors of size domainSize by permuting their coefficients

Returns

The vector action

Return type

replab.Action

vectorFindLexMinimal(self, s, sStabilizer)

Finds the lexicographic minimal vector under permutation of its coefficients by this group

Example

>>> n = 10;
>>> s = randi([-3 3], 1, n);
>>> G = replab.S(n);
>>> [sml, P] = G.vectorFindLexMinimal(s);
>>> all(sml == sort(s)) % lexmin using the symmetric group is simply a sort
    1
>>> all(sml(P.representative) == s)
    1

Parameters

• s (double(1,domainSize)) – Vector to permute

• sStabilizer (PermutationGroup or [], optional) – Stabilzier of s

Returns

• sMinLex (double(1,domainSize):) – Minimal lexicographic representative of s under permutation by this group

• P (LeftCoset) – Set of permutations p such that sMinLex == s(inverse(p)) or s == sMinLex(p)

vectorFindPermutationsTo(self, s, t, sStabilizer, tStabilizer)

Finds the permutations that send a vector to another vector

We return the set of p such that t == s(inverse(p)) or s == t(p).

We use this notation as the left action of p on a list s is given by s(inverse(p)).

Parameters

• s (double(1,domainSize)) – Source vector

• t (double(1,domainSize)) – Target vector

• sStabilizer (PermutationGroup or [], optional) – Stabilizer of s

• tStabilizer (PermutationGroup or [], optional) – Stabilizer of t

Returns

The set of permutations {p} such that t == s(inverse(p)); or [] if no element found

Return type

replab.LeftCoset

vectorStabilizer(self, vector)

Returns the permutation subgroup that leaves a given vector invariant

Parameters

vector (double(1,domainSize)) – Vector to stabilize under permutation

Returns

The subgroup of this group leaving vector invariant

Return type

PermutationGroup

wreathProduct(self, A)

Returns the wreath product of a compact group by this permutation group

See https://en.wikipedia.org/wiki/Wreath_product

Note that our notation is reversed compared to the Wikipedia page, the permutation group is on the left hand side, as our convention for semidirect product places the group acted upon on the right.

Note that the return type depends on the argument type: if A is a FiniteGroup, the result will be a finite group too.

Parameters

A (CompactGroup) – The group whose copies are acted upon

Returns

A wreath product group

Return type

replab.WreathProductGroup

SignedPermutation

class replab.SignedPermutation

This class regroups functions that are useful when dealing with signed permutations.

Class members list

General

• fromMatrix – Returns the signed permutation corresponding to the given matrix representation or throws an error

• fromPermutation – Returns the signed permutation corresponding to the given permutation encoding

• isSignedPermutationMatrix – Returns true when “mat” is a signed permutation matrix, i.e. a monomial matrix with nonzero entries equal to +1 or -1

• toMatrix – Returns the signed permutation matrix corresponding to the given signed permutation

• toPermutation – Returns the permutation corresponding to the given signed permutation where the permutation acts on the list [-d,..,-1,1,..,d]

• toSparseMatrix –

Inherited elements

toSparseMatrix()

No documentation

Own members

static fromMatrix(mat)

Returns the signed permutation corresponding to the given matrix representation or throws an error

static fromPermutation(perm)

Returns the signed permutation corresponding to the given permutation encoding

See toPermutation

static isSignedPermutationMatrix(mat)

Returns true when “mat” is a signed permutation matrix, i.e. a monomial matrix with nonzero entries equal to +1 or -1

static toMatrix(signedPerm)

Returns the signed permutation matrix corresponding to the given signed permutation

Such that matrix multiplication is compatible with composition of permutations, i.e. S.toMatrix(S.compose(x, y)) = S.toMatrix(x) * S.toMatrix(y) where S = SignedPermutations(domainSize)

static toPermutation(signedPerm)

Returns the permutation corresponding to the given signed permutation where the permutation acts on the list [-d,..,-1,1,..,d]

SignedPermutationGroup

class replab.SignedPermutationGroup(domainSize, generators, varargin)

Bases: replab.gen.FiniteGroup

A base class for all signed permutation groups

Class members list

Properties

• domainSize – The integer \(d\) when this group acts on \(\{-d, .., -1, 1, .., d\}\)

• generators – Group generators

• identity – Monoid identity element

• nice – Nice object where computations are done

• niceIsomorphism – Order-preserving isomorphism from a group containing self to a group containing nice

• type – Type of the contained elements

Prettyprinting

• additionalFields – Returns the name/value pairs corresponding to additional fields to be printed

• disp – Standard MATLAB/Octave display method

• headerStr – Tiny single line description of the current object type

• hiddenFields – Returns the names of the fields that are not printed as a row vector

• longStr – Multi-line description of the current object

• shortStr – Single line text description of the current object

Test helpers

• assertEqv – Compares two elements for equality

• assertNotEqv – Compares two elements for inequality

Sampling and equality test

• eqv – Tests domain elements for equality/equivalence

• sample – Samples an element from this set

Laws

• check – Checks the consistency of this object

• checkAndContinue – Checks the consistency of this object

• laws – Returns the laws that this object obeys

Property cache

• cache – Sets the value of the designated property in the cache

• cached – Returns the cached property if it exists, computing it if necessary

• cachedOrDefault – Returns the cached property if it exists, or the provided default value if it is unknown yet

• cachedOrEmpty – Returns the cached property if it exists, or [] if it is unknown yet

• inCache – Returns whether the value of the given property has already been computed

Unique ID

• eq – Equality test

• id – Returns the unique ID of this object (deprecated)

• ne – Non-equality test

Monoid operations

• areCommuting – Returns whether the two given elements commute

• compose – Composes two monoid/group elements

• composeAll – Composes a sequence of monoid elements

• composeN – Computes the power of a given element by repeated squaring

• isIdentity – Tests if the given element is the identity

Morphisms

• abstractIsomorphism – Returns an isomorphism to an abstract group

• automorphismGroup – Returns the automorphism group of this group

• commutingMorphismsMorphism – Constructs a morphism from morphisms with commuting images

• conjugatingAutomorphism – Returns the morphism that corresponds to left conjugation by an element

• findIsomorphism – Finds an isomorphism from this finite group to another finite group, if it exists

• findIsomorphisms – Finds all the isomorphisms from this finite group to another finite group

• findMorphisms – Finds all the morphisms from this finite group to another finite group

• innerAutomorphism – Returns the inner automorphism given using conjugation by the given element

• isIsomorphicTo – Returns whether this group is isomorphic to another group

• isMorphismByImages – Checks whether the given images describe a group morphism

• isomorphismByFunction – Constructs an isomorphism to a finite group using an image function

• isomorphismByFunctions – Constructs a group isomorphism using preimage/image functions

• isomorphismByImages – Constructs an isomorphism to a group using images of generators

• morphismByFunction – Constructs a group morphism using an image function

• morphismByImages – Constructs a morphism to a group using images of generators

• orderPreservingPermutationIsomorphism – Returns an isomorphism from this group to a permutation group, which preserves element order

• permutationIsomorphism – Returns an isomorphism from this group to a permutation group

• regularIsomorphism – Returns an isomorphism from this group to a permutation group whose degree matches the order of this group

Group methods

• commutator – Returns the commutator of two group elements

• composeFlat – Returns the composition of elements from an array picked according to the given indices/letters

• composeWithInverse – Returns the composition of an element with the inverse of another element

• inverse – Computes the inverse of an element

• leftConjugate – Returns the left conjugate of a group element

Elements

• elementOrder – Returns the order of a group element

• smallGeneratingSet – Returns a small set of elements generating the group

Relations to other sets

• hasSameTypeAs – Returns if this finite set has the same type as the given finite set

Image under isomorphism

• imap – Returns the image of this finite set under an isomorphism

General

• SignedPermutationGroup – Constructs a signed permutation group

• compatibleWithNiceIsomorphism – Returns whether the given finite isomorphism is compatible with this object isomorphism

• mtimes –

• of – Constructs a nontrivial signed permutation group from the given generators

• signedSymmetric – Creates the signed symmetric group of a given degree

Representations

• commutingRepsRep – Constructs a representation from commuting representations

• directSumRep – Computes the direct sum of representations on this group

• permutationRep – Constructs a permutation representation of this group

• regularRep – Returns the left regular representation of this group

• repByImages – Constructs a finite dimensional representation of this group from preimages/images pairs

• signedPermutationRep – Returns a real signed permutation representation of this group

• tensorRep – Computes the tensor product of representations

• trivialRep – Returns the trivial representation of this group on a finite dimensional vector space

Group construction

• directPower – Returns the direct product of this group with itself a number of times

• directProduct – Returns the direct product of groups

• semidirectProduct – Describes an external semidirect product of groups

Group properties

• abelianInvariants – Returns the group abelian invariants

• exponent – Returns the group exponent

• fastRecognize – Attempts to recognize this group in the standard atlas

• hasReconstruction – Returns whether the group has a “reconstruction”

• isCommutative – Returns whether this group is commutative

• isCyclic – Returns whether this group is a cyclic group

• isSimple – Returns whether this group is simple

• isTrivial – Tests whether this group is trivial

• knownOrder – Returns whether the order of this group has already been computed

• maximalTorusDimension – Returns, if available, the dimension of the maximal torus contained in the connected component of this group

• order – Returns the group order

• presentation – Returns a presentation of this group as a string

• recognize – Attempts to recognize this group in the standard atlas

• reconstruction – Returns a reconstruction of the group used to speed up group averaging

Isomorphic groups

• abstractGroup – Returns an abstract group isomorphic to this finite gorup

• permutationGroup – Returns the permutation group isomorphic to this finite group

Subgroups

• center – Returns the center of this group

• centralizer – Returns the centralizer of the given object in this group

• derivedSeries – Returns the derived series of this group

• derivedSubgroup – Computes the derived subgroup of this group

• intersection – Computes the intersection of two groups

• randomProperSubgroup – Constructs a random proper subgroup of this group

• randomSubgroup – Constructs a random subgroup of this group

• subgroup – Constructs a subgroup of the current group from elements

• subgroupWithGenerators – Constructs a subgroup of the current group from generators

• trivialSubgroup – Returns the trivial subgroup of this group

Conjugacy classes and character table

• characterTable – Alias for complexCharacterTable

• complexCharacterTable – Returns the complex character table of this group

• conjugacyClass – Returns the conjugacy class corresponding to the given element

• conjugacyClasses – Returns the conjugacy classes of this group

• findLeftConjugations – Returns the set of all elements that left conjugates an element to another element

• knownComplexCharacterTable – Returns whether the complex character table of this group is already known or computed

• knownRealCharacterTable – Returns whether the real character table of this group is already known or computed

• realCharacterTable – Returns the real character table of this group

• setComplexCharacterTable – Sets the complex character table of this group

• setConjugacyClasses – Sets the conjugacy classes of this group

• setRealCharacterTable – Sets the real character table of this group

Construction of groups

• closure – Computes the group generated by the elements of this group and other elements/groups

• leftConjugateGroup – Returns the left conjugate of the current group by the given element

• normalClosure – Computes the normal closure of an object in the closure of this group and this object

• withGeneratorNames – Returns a modified copy of this finite group with renamed generators

Cosets

• doubleCoset – Returns a double coset

• doubleCosets – Returns the set of double cosets in this group by the given groups

• isNormalizedBy – Returns whether a given element/group normalizes this group

• leftCoset – Returns a left coset

• leftCosets – Returns the set of left cosets of the given subgroup in this group

• mldivide – Shorthand for rightCosets

• mrdivide – Shorthand for leftCosets

• normalCoset – Returns a normal coset

• normalCosets – Returns the set of normal cosets of the given subgroup in this group

• rightCoset – Returns a right coset

• rightCosets – Returns the set of right cosets of the given subgroup in this group

Generators-related methods

• factorizeFlat – Factorizes an element or a coset as a flat sequence in the generators

• factorizeWord – Factorizes an element or a coset as a word in the generators

• flatToWord – Prints a word described by letters into a string

• generator – Returns the i-th group generator

• generatorInverse – Returns the inverse of the i-th group generator

• generatorNames – Returns the names of the group generators

• imageFlat – Returns the image of a flat word in the group generators

• imageWord – Computes the image of a word in the group generators

• knownRelators – Returns whether the relators of this group are known

• nGenerators – Returns the number of group generators

• relatorsFlat – Returns the relators of a presentation of this finite group in the flat format

• relatorsWord – Returns the relators of a presentation of this finite group

• wordToFlat – Parses a word into generator letters

Relations to other groups

• isNormalSubgroupOf – Returns whether this group is a normal subgroup of another group

• isSubgroupOf – Returns whether this group is a subgroup of another group

Bugfix for Octave method selection

• contains – Tests whether this set contains the given element

• elements – Returns a cell array containing all the elements of this set

• elementsSequence – Returns a sequence corresponding to this set

• isequal – Tests finite sets for equality

• nElements – Returns the size of this set

• representative – Returns the minimal element of this set under the type ordering

• setProduct – Returns a description of this set as a product of sets

Signed permutation methods

• elementPermutationPart – Returns the permutation part of a signed permutation, by taking image absolute values

• permutationPart – Returns the permutation part of the current group

Actions

• matrixAction – Returns the action of elements of this group on d x d matrices

• naturalAction – Returns the action of elements of this group on {-d..-1 1..d}

• vectorAction – Returns the action of elements of this group on vectors

Representation construction

• naturalRep – Natural representation on R^d of signed permutations on integers -d..-1, 1..d

Inherited elements

abelianInvariants(self)

Documentation in replab.FiniteGroup.abelianInvariants()

abstractGroup(self)

Documentation in replab.FiniteGroup.abstractGroup()

abstractIsomorphism(self)

Documentation in replab.FiniteGroup.abstractIsomorphism()

additionalFields(self)

Documentation in replab.Str.additionalFields()

areCommuting(self, x, y)

Documentation in replab.Monoid.areCommuting()

assertEqv(self, x, y, context)

Documentation in replab.Domain.assertEqv()

assertNotEqv(self, x, y, context)

Documentation in replab.Domain.assertNotEqv()

automorphismGroup(self)

Documentation in replab.Group.automorphismGroup()

cache(self, name, value, handleExisting)

Documentation in replab.Obj.cache()

cached(self, name, fun)

Documentation in replab.Obj.cached()

cachedOrDefault(self, name, defaultValue)

Documentation in replab.Obj.cachedOrDefault()

cachedOrEmpty(self, name)

Documentation in replab.Obj.cachedOrEmpty()

center(self)

Documentation in replab.FiniteGroup.center()

centralizer(self, arg)

Documentation in replab.FiniteGroup.centralizer()

characterTable(self)

Documentation in replab.FiniteGroup.characterTable()

check(self)

Documentation in replab.Obj.check()

checkAndContinue(self)

Documentation in replab.Obj.checkAndContinue()

closure(self, varargin)

Documentation in replab.FiniteGroup.closure()

commutator(self, x, y, startWithInverse)

Documentation in replab.Group.commutator()

commutingMorphismsMorphism(self, target, morphisms)

Documentation in replab.Group.commutingMorphismsMorphism()

commutingRepsRep(self, field, dimension, reps)

Documentation in replab.CompactGroup.commutingRepsRep()

compatibleWithNiceIsomorphism(self, iso)

Documentation in replab.gen.FiniteSet.compatibleWithNiceIsomorphism()

complexCharacterTable(self)

Documentation in replab.FiniteGroup.complexCharacterTable()

compose(self, x, y)

Documentation in replab.Monoid.compose()

composeAll(self, elements)

Documentation in replab.Monoid.composeAll()

composeFlat(self, array, letters)

Documentation in replab.Group.composeFlat()

composeN(self, x, n)

Documentation in replab.Monoid.composeN()

composeWithInverse(self, x, y)

Documentation in replab.Group.composeWithInverse()

conjugacyClass(self, g, varargin)

Documentation in replab.FiniteGroup.conjugacyClass()

conjugacyClasses(self)

Documentation in replab.FiniteGroup.conjugacyClasses()

conjugatingAutomorphism(self, by)

Documentation in replab.FiniteGroup.conjugatingAutomorphism()

contains(self, el)

Documentation in replab.FiniteSet.contains()

derivedSeries(self)

Documentation in replab.FiniteGroup.derivedSeries()

derivedSubgroup(self)

Documentation in replab.FiniteGroup.derivedSubgroup()

directPower(self, n)

Documentation in replab.CompactGroup.directPower()

directProduct(varargin)

Documentation in replab.CompactGroup.directProduct()

directSumRep(self, field, reps)

Documentation in replab.CompactGroup.directSumRep()

disp(self)

Documentation in replab.Str.disp()

doubleCoset(self, element, rightSubgroup, varargin)

Documentation in replab.FiniteGroup.doubleCoset()

doubleCosets(self, leftSubgroup, rightSubgroup)

Documentation in replab.FiniteGroup.doubleCosets()

elementOrder(self, g)

Documentation in replab.FiniteGroup.elementOrder()

elements(self)

Documentation in replab.FiniteSet.elements()

elementsSequence(self)

Documentation in replab.FiniteSet.elementsSequence()

eq(self, rhs)

Documentation in replab.Obj.eq()

eqv(self, t, u)

Documentation in replab.Domain.eqv()

exponent(self)

Documentation in replab.FiniteGroup.exponent()

factorizeFlat(self, elementOrCoset)

Documentation in replab.FiniteGroup.factorizeFlat()

factorizeWord(self, elementOrCoset)

Documentation in replab.FiniteGroup.factorizeWord()

fastRecognize(self)

Documentation in replab.FiniteGroup.fastRecognize()

findIsomorphism(self, to)

Documentation in replab.FiniteGroup.findIsomorphism()

findIsomorphisms(self, to, varargin)

Documentation in replab.FiniteGroup.findIsomorphisms()

findLeftConjugations(self, s, t, varargin)

Documentation in replab.FiniteGroup.findLeftConjugations()

findMorphisms(self, to, varargin)

Documentation in replab.FiniteGroup.findMorphisms()

flatToWord(self, letters)

Documentation in replab.FiniteGroup.flatToWord()

generator(self, i)

Documentation in replab.FiniteGroup.generator()

generatorInverse(self, i)

Documentation in replab.FiniteGroup.generatorInverse()

generatorNames(self)

Documentation in replab.FiniteGroup.generatorNames()

generators

Documentation in replab.FiniteGroup.generators

hasReconstruction(self)

Documentation in replab.CompactGroup.hasReconstruction()

hasSameTypeAs(self, rhs)

Documentation in replab.FiniteSet.hasSameTypeAs()

headerStr(self)

Documentation in replab.Str.headerStr()

hiddenFields(self)

Documentation in replab.Str.hiddenFields()

id(self)

Documentation in replab.Obj.id()

identity

Documentation in replab.Monoid.identity

imageFlat(self, letters)

Documentation in replab.FiniteGroup.imageFlat()

imageWord(self, word)

Documentation in replab.FiniteGroup.imageWord()

imap(self, f)

Documentation in replab.FiniteSet.imap()

inCache(self, name)

Documentation in replab.Obj.inCache()

innerAutomorphism(self, by)

Documentation in replab.Group.innerAutomorphism()

intersection(self, G)

Documentation in replab.FiniteGroup.intersection()

inverse(self, x)

Documentation in replab.Group.inverse()

isCommutative(self)

Documentation in replab.FiniteGroup.isCommutative()

isCyclic(self)

Documentation in replab.FiniteGroup.isCyclic()

isIdentity(self, x)

Documentation in replab.Monoid.isIdentity()

isIsomorphicTo(self, target)

Documentation in replab.FiniteGroup.isIsomorphicTo()

isMorphismByImages(self, target, varargin)

Documentation in replab.FiniteGroup.isMorphismByImages()

isNormalSubgroupOf(self, rhs)

Documentation in replab.FiniteGroup.isNormalSubgroupOf()

isNormalizedBy(self, element)

Documentation in replab.FiniteGroup.isNormalizedBy()

isSimple(self)

Documentation in replab.FiniteGroup.isSimple()

isSubgroupOf(self, rhs)

Documentation in replab.FiniteGroup.isSubgroupOf()

isTrivial(self)

Documentation in replab.FiniteGroup.isTrivial()

isequal(self, rhs)

Documentation in replab.FiniteSet.isequal()

isomorphismByFunction(self, target, imageElementFun, varargin)

Documentation in replab.FiniteGroup.isomorphismByFunction()

isomorphismByFunctions(self, target, preimageElementFun, imageElementFun, torusMap)

Documentation in replab.Group.isomorphismByFunctions()

isomorphismByImages(self, target, varargin)

Documentation in replab.FiniteGroup.isomorphismByImages()

knownComplexCharacterTable(self)

Documentation in replab.FiniteGroup.knownComplexCharacterTable()

knownOrder(self)

Documentation in replab.FiniteGroup.knownOrder()

knownRealCharacterTable(self)

Documentation in replab.FiniteGroup.knownRealCharacterTable()

knownRelators(self)

Documentation in replab.FiniteGroup.knownRelators()

laws(self)

Documentation in replab.Obj.laws()

leftConjugate(self, by, on)

Documentation in replab.Group.leftConjugate()

leftConjugateGroup(self, by)

Documentation in replab.FiniteGroup.leftConjugateGroup()

leftCoset(self, element, varargin)

Documentation in replab.FiniteGroup.leftCoset()

leftCosets(self, subgroup)

Documentation in replab.FiniteGroup.leftCosets()

longStr(self, maxRows, maxColumns)

Documentation in replab.Str.longStr()

maximalTorusDimension(self)

Documentation in replab.CompactGroup.maximalTorusDimension()

mldivide(self, supergroup)

Documentation in replab.FiniteGroup.mldivide()

morphismByFunction(self, target, imageElementFun, torusMap)

Documentation in replab.Group.morphismByFunction()

morphismByImages(self, target, varargin)

Documentation in replab.FiniteGroup.morphismByImages()

mrdivide(self, subgroup)

Documentation in replab.FiniteGroup.mrdivide()

mtimes()

No documentation

nElements(self)

Documentation in replab.FiniteSet.nElements()

nGenerators(self)

Documentation in replab.FiniteGroup.nGenerators()

ne(self, rhs)

Documentation in replab.Obj.ne()

nice

Documentation in replab.gen.FiniteSet.nice

niceIsomorphism

Documentation in replab.gen.FiniteSet.niceIsomorphism

normalClosure(self, obj)

Documentation in replab.FiniteGroup.normalClosure()

normalCoset(self, element, varargin)

Documentation in replab.FiniteGroup.normalCoset()

normalCosets(self, subgroup)

Documentation in replab.FiniteGroup.normalCosets()

order(self)

Documentation in replab.FiniteGroup.order()

orderPreservingPermutationIsomorphism(self)

Documentation in replab.FiniteGroup.orderPreservingPermutationIsomorphism()

permutationGroup(self)

Documentation in replab.FiniteGroup.permutationGroup()

permutationIsomorphism(self)

Documentation in replab.FiniteGroup.permutationIsomorphism()

permutationRep(self, dimension, varargin)

Documentation in replab.FiniteGroup.permutationRep()

presentation(self)

Documentation in replab.FiniteGroup.presentation()

randomProperSubgroup(self, nSteps)

Documentation in replab.FiniteGroup.randomProperSubgroup()

randomSubgroup(self)

Documentation in replab.FiniteGroup.randomSubgroup()

realCharacterTable(self)

Documentation in replab.FiniteGroup.realCharacterTable()

recognize(self)

Documentation in replab.FiniteGroup.recognize()

reconstruction(self)

Documentation in replab.CompactGroup.reconstruction()

regularIsomorphism(self)

Documentation in replab.FiniteGroup.regularIsomorphism()

regularRep(self)

Documentation in replab.FiniteGroup.regularRep()

relatorsFlat(self)

Documentation in replab.FiniteGroup.relatorsFlat()

relatorsWord(self)

Documentation in replab.FiniteGroup.relatorsWord()

repByImages(self, field, dimension, varargin)

Documentation in replab.FiniteGroup.repByImages()

representative(self)

Documentation in replab.FiniteSet.representative()

rightCoset(self, element, varargin)

Documentation in replab.FiniteGroup.rightCoset()

rightCosets(self, subgroup)

Documentation in replab.FiniteGroup.rightCosets()

sample(self)

Documentation in replab.Domain.sample()

semidirectProduct(self, N, phi)

Documentation in replab.CompactGroup.semidirectProduct()

setComplexCharacterTable(self, table)

Documentation in replab.FiniteGroup.setComplexCharacterTable()

setConjugacyClasses(self, classes)

Documentation in replab.FiniteGroup.setConjugacyClasses()

setProduct(self)

Documentation in replab.FiniteSet.setProduct()

setRealCharacterTable(self, table)

Documentation in replab.FiniteGroup.setRealCharacterTable()

shortStr(self, maxColumns)

Documentation in replab.Str.shortStr()

signedPermutationRep(self, dimension, varargin)

Documentation in replab.FiniteGroup.signedPermutationRep()

smallGeneratingSet(self)

Documentation in replab.FiniteGroup.smallGeneratingSet()

subgroup(self, elements, varargin)

Documentation in replab.FiniteGroup.subgroup()

subgroupWithGenerators(self, generators, varargin)

Documentation in replab.FiniteGroup.subgroupWithGenerators()

tensorRep(self, field, reps)

Documentation in replab.CompactGroup.tensorRep()

trivialRep(self, field, dimension)

Documentation in replab.CompactGroup.trivialRep()

trivialSubgroup(self)

Documentation in replab.FiniteGroup.trivialSubgroup()

type

Documentation in replab.FiniteSet.type

withGeneratorNames(self, newNames)

Documentation in replab.FiniteGroup.withGeneratorNames()

wordToFlat(self, word)

Documentation in replab.FiniteGroup.wordToFlat()

Own members

domainSize

The integer \(d\) when this group acts on \(\{-d, .., -1, 1, .., d\}\)

Type

integer

SignedPermutationGroup(domainSize, generators, varargin)

Constructs a signed permutation group

Additional keyword arguments (type, nice and niceIsomorphism) are used internally but are not part of the public API.

Parameters

• domainSize (integer) – Domain size of this permutation group

• generators (cell(1,*) of integer(1,*)) – Group generators

• generatorNames – Names of the generators

• order – Order of the group

• relators – Relators given either in word or letter format

Kwtype generatorNames

cell(1,*) of charstring

Kwtype order

vpi, optional

Kwtype relators

cell(1,*) of charstring

elementPermutationPart(self, g)

Returns the permutation part of a signed permutation, by taking image absolute values

Computes the permutation p that acts on 1…domainSize as p(i) = abs(g(i))

Parameters

g (signed permutation) – Signed permutation

Returns

The permutation part of g

Return type

permutation

matrixAction(self)

Returns the action of elements of this group on d x d matrices

Note that d = self.domainSize, and this acts by simultaneous permutations of their rows and columns and flipping their signs

naturalAction(self)

Returns the action of elements of this group on {-d..-1 1..d}

Here, d is self.domainSize

naturalRep(self)

Natural representation on R^d of signed permutations on integers -d..-1, 1..d

static of(varargin)

Constructs a nontrivial signed permutation group from the given generators

Example

>>> s = [-1 -2 -3 -4];
>>> i = [2 -1 4 -3];
>>> j = [3 -4 -1 2];
>>> Q = replab.SignedPermutationGroup.of(s, i, j);
>>> Q.order == 8
  1

The generators of the group can be named by preceding them all by a charstring:

Example

>>> s = [-1 -2 -3 -4];
>>> i = [2 -1 4 -3];
>>> j = [3 -4 -1 2];
>>> Q = replab.SignedPermutationGroup.of('s', s, 'i', i, 'j', j);
>>> Q.order == 8
  1

This method cannot construct trivial groups without any generators. In that case, use the constructor:

Example

>>> generators = {};
>>> domainSize = 4;
>>> G = replab.SignedPermutationGroup(domainSize, generators);
>>> G.order
    1

Parameters

varargin (cell(1,*) of signed permutations) – Group generators, pos

Returns

The signed permutation group given as the closure of the generators

Return type

SignedPermutationGroup

permutationPart(self)

Returns the permutation part of the current group

Corresponds to the group image under the homomorphism elementPermutationPart.

Returns

The corresponding permutation group

Return type

replab.PermutationGroup

static signedSymmetric(n)

Creates the signed symmetric group of a given degree

Parameters

n (integer) – Degree of the signed symmetric group

Returns

The signed symmetric group of degree n

Return type

SignedPermutationGroup

vectorAction(self)

Returns the action of elements of this group on vectors

Vectors are (self.domainSize)-dimensional vectors, and this permutes their coefficients and flips their signs