Represents a permutation of {0,1,2,3,4}. More...

#include <maths/spec/perm5.h>

Public Types
using	Index = int
	Denotes a native signed integer type large enough to count all permutations on five elements. More...

using	ImagePack = uint16_t
	Indicates the native unsigned integer type used to store a single image pack. More...

using	Code1 = ImagePack
	Indicates the native unsigned integer type used to store a first-generation permutation code. More...

using	Code2 = uint8_t
	Indicates the native unsigned integer type used to store a second-generation permutation code. More...

using	Code = Code1
	An alias for the first-generation code type Code1. More...

Public Member Functions
constexpr	Perm ()
	Creates the identity permutation. More...

constexpr	Perm (int a, int b)
	Creates the transposition of a and b. More...

constexpr	Perm (int a, int b, int c, int d, int e)
	Creates a permutation mapping (0,1,2,3,4) to (a,b,c,d,e) respectively. More...

constexpr	Perm (const std::array< int, 5 > &image)
	Creates a permutation mapping i to image[i] for each i = 0,1,2,3,4. More...

constexpr	Perm (const int *image)
	Deprecated constructor that creates a permutation mapping i to image[i] for each i = 0,1,2,3,4. More...

constexpr	Perm (const int a, const int b)
	Deprecated constuctor that creates a permutation mapping (a[0], ..., a[4]) to (b[0], ..., b[4]) respectively. More...

constexpr	Perm (int a0, int a1, int b0, int b1, int c0, int c1, int d0, int d1, int e0, int e1)
	Creates a permutation mapping (a0,b0,c0,d0,e0) to (a1,b1,c1,d1,e1) respectively. More...

constexpr	Perm (const Perm< 5 > &cloneMe)=default
	Creates a permutation that is a clone of the given permutation. More...

constexpr Code1	permCode1 () const
	Returns the first-generation code representing this permutation. More...

constexpr Code2	permCode2 () const
	Returns the second-generation code representing this permutation. More...

constexpr Code1	permCode () const
	Deprecated routine that returns the first-generation code representing this permutation. More...

void	setPermCode1 (Code1 code)
	Sets this permutation to that represented by the given first-generation permutation code. More...

void	setPermCode2 (Code2 code)
	Sets this permutation to that represented by the given second-generation permutation code. More...

void	setPermCode (Code1 code)
	Deprecated routine that sets this permutation to that represented by the given first-generation permutation code. More...

constexpr ImagePack	imagePack () const
	Returns the image pack that represents this permutation. More...

Perm< 5 > &	operator= (const Perm< 5 > &cloneMe)=default
	Sets this permutation to be equal to the given permutation. More...

constexpr Perm< 5 >	operator* (const Perm< 5 > &q) const
	Returns the composition of this permutation with the given permutation. More...

constexpr Perm< 5 >	inverse () const
	Finds the inverse of this permutation. More...

constexpr Perm< 5 >	pow (long exp) const
	Computes the given power of this permutation. More...

constexpr int	order () const
	Returns the order of this permutation. More...

constexpr Perm< 5 >	reverse () const
	Finds the reverse of this permutation. More...

constexpr int	sign () const
	Determines the sign of this permutation. More...

constexpr int	operator[] (int source) const
	Determines the image of the given integer under this permutation. More...

constexpr int	pre (int image) const
	Determines the preimage of the given integer under this permutation. More...

constexpr int	preImageOf (int image) const
	Deprecated routine that determines the preimage of the given integer under this permutation. More...

constexpr bool	operator== (const Perm< 5 > &other) const
	Determines if this is equal to the given permutation. More...

constexpr bool	operator!= (const Perm< 5 > &other) const
	Determines if this differs from the given permutation. More...

constexpr int	compareWith (const Perm< 5 > &other) const
	Lexicographically compares the images of (0,1,2,3,4) under this and the given permutation. More...

constexpr bool	isIdentity () const
	Determines if this is the identity permutation. More...

Perm< 5 > &	operator++ ()
	A preincrement operator that changes this to be the next permutation in the array Perm<5>::Sn. More...

constexpr Perm< 5 >	operator++ (int)
	A postincrement operator that changes this to be the next permutation in the array Perm<5>::Sn. More...

constexpr bool	operator< (const Perm< 5 > &rhs) const
	Determines if this appears earlier than the given permutation in the array Perm<5>::Sn. More...

std::string	str () const
	Returns a string representation of this permutation. More...

std::string	trunc (unsigned len) const
	Returns a prefix of the string representation of this permutation, containing only the images of the first len integers. More...

std::string	trunc2 () const
	Returns a string representation of this permutation with only the images of 0 and 1. More...

std::string	trunc3 () const
	Returns a string representation of this permutation with only the images of 0, 1 and 2. More...

std::string	trunc4 () const
	Returns a string representation of this permutation with only the images of 0, 1, 2 and 3. More...

void	clear (unsigned from)
	Resets the images of all integers from from onwards to the identity map. More...

constexpr Index	SnIndex () const
	Returns the index of this permutation in the Perm<5>::Sn array. More...

constexpr Index	S5Index () const
	Returns the index of this permutation in the Perm<5>::S5 array. More...

constexpr Index	orderedSnIndex () const
	Returns the lexicographical index of this permutation. More...

constexpr Index	orderedS5Index () const
	Returns the lexicographical index of this permutation. More...

constexpr Index	index () const
	Deprecated routine that returns the lexicographical index of this permutation. More...

constexpr bool	isConjugacyMinimal () const
	Is this permutation minimal in its conjugacy class? More...

template<class URBG >
Perm< 5 >	rand (URBG &&gen, bool even)

Static Public Member Functions
static constexpr Perm< 5 >	fromPermCode1 (Code1 code)
	Creates a permutation from the given first-generation permutation code. More...

static constexpr Perm< 5 >	fromPermCode2 (Code2 code)
	Creates a permutation from the given second-generation permutation code. More...

static constexpr Perm< 5 >	fromPermCode (Code1 code)
	Deprecated routine that creates a permutation from the given first-generation permutation code. More...

static constexpr bool	isPermCode1 (Code1 code)
	Determines whether the given character is a valid first-generation permutation code. More...

static constexpr bool	isPermCode2 (Code2 code)
	Determines whether the given character is a valid second-generation permutation code. More...

static constexpr bool	isPermCode (Code1 code)
	Deprecated routine that determines whether the given character is a valid first-generation permutation code. More...

static constexpr Perm	fromImagePack (ImagePack pack)
	Creates a permutation from the given image pack. More...

static constexpr bool	isImagePack (ImagePack pack)
	Determines whether the given argument is the image pack of some 5-element permutation. More...

static constexpr Perm	rot (int i)
	Returns the ith rotation. More...

static Perm	rand (bool even=false)
	Returns a random permutation on five elements. More...

template<class URBG >
static Perm	rand (URBG &&gen, bool even=false)
	Returns a random permutation on five elements, using the given uniform random bit generator. More...

static constexpr Perm	atIndex (Index i)
	Deprecated routine that returns the ith permutation on five elements, where permutations are numbered lexicographically. More...

template<int k>
static constexpr Perm< 5 >	extend (Perm< k > p)
	Extends a k-element permutation to a 5-element permutation, where 2 ≤ k < 5. More...

template<int k>
static constexpr Perm< 5 >	contract (Perm< k > p)
	Restricts a k-element permutation to an 5-element permutation, where k > 5. More...

Static Public Attributes
static constexpr PermCodeType	codeType = PERM_CODE_INDEX
	Indicates what type of internal permutation code is used by this instance of the Perm class template. More...

static constexpr Index	nPerms = 120
	The total number of permutations on five elements. More...

static constexpr Index	nPerms_1 = 24
	The total number of permutations on four elements. More...

static constexpr int	imageBits = 3
	Indicates the number of bits used in an image pack to store the image of a single integer. More...

static constexpr ImagePack	imageMask
	A bitmask whose lowest imageBits bits are 1, and whose remaining higher order bits are all 0. More...

static constexpr S5Lookup	Sn {}
	Gives array-like access to all possible permutations of five elements. More...

static constexpr S5Lookup	S5 {}
	Gives array-like access to all possible permutations of five elements. More...

static constexpr OrderedS5Lookup	orderedSn {}
	Gives array-like access to all possible permutations of five elements in lexicographical order. More...

static constexpr OrderedS5Lookup	orderedS5 {}
	Gives array-like access to all possible permutations of five elements in lexicographical order. More...

static constexpr S4Lookup	Sn_1 {}
	Gives array-like access to all possible permutations of four elements. More...

static constexpr S4Lookup	S4 {}
	Gives array-like access to all possible permutations of four elements. More...

static constexpr OrderedS4Lookup	orderedS4 {}
	Gives array-like access to all possible permutations of four elements in lexicographical order. More...

static constexpr S3Lookup	S3 {}
	Gives array-like access to all possible permutations of three elements. More...

static constexpr OrderedS3Lookup	orderedS3 {}
	Gives array-like access to all possible permutations of three elements in lexicographical order. More...

static constexpr S2Lookup	S2 {}
	Gives array-like access to all possible permutations of two elements. More...

Protected Member Functions
constexpr	Perm (Code2 code)
	Creates a permutation from the given second-generation permutation code. More...

Protected Attributes
Code2	code2_
	The internal second-generation permutation code representing this permutation. More...

Detailed Description

Represents a permutation of {0,1,2,3,4}.

This is a specialisation of the generic Perm template: it is highly optimised, and also offers some additional functionality. Amongst other things, this permutation class is used to specify how simplices of a 4-manifold triangulation are glued together.

As with all Perm template classes, these objects are small enough to pass by value and swap with std::swap(), with no need for any specialised move operations or swap functions.

Each permutation has an internal code, which is a single native integer that is sufficient to reconstruct the permutation. Thus the internal code may be a useful means for passing permutation objects to and from the engine. For Perm<5>, the internal permutation codes have changed as of Regina 7.0:

First-generation codes were used internally in Regina 6.0.1 and earlier. These are image packs: integers whose lowest three bits represent the image of 0, whose next lowest three bits represent the image of 1, and so on. The routines permCode1(), setPermCode1(), fromPermCode1() and isPermCode1() continue to work with first-generation codes for backward compatibility. Likewise, the XML data file format continues to use first-generation codes to describe pentachoron gluings.
Second-generation codes are used internally in Regina 7.0 and above. These codes are integers between 0 and 119 inclusive, representing the index of the permutation in the array Perm<5>::S5. The routines permCode2(), setPermCode2(), fromPermCode2() and isPermCode2() work with second-generation codes.

It is highly recommended that, if you need to work with permutation codes at all, you use second-generation codes where possible. This is because the first-generation routines incur additional overhead in converting back and forth between the second-generation codes (which are used internally by Perm<5>).

To use this class, simply include the main permutation header maths/perm.h.

Python: Since Python does not support templates, this class is made available under the name Perm5.

Member Typedef Documentation

◆ Code

using regina::Perm< 5 >::Code = Code1

An alias for the first-generation code type Code1.

Instead of Code, you should use either Code1 or Code2 to more clearly express which kind of permutation code you are using.

◆ Code1

using regina::Perm< 5 >::Code1 = ImagePack

Indicates the native unsigned integer type used to store a first-generation permutation code.

◆ Code2

using regina::Perm< 5 >::Code2 = uint8_t

Indicates the native unsigned integer type used to store a second-generation permutation code.

◆ ImagePack

using regina::Perm< 5 >::ImagePack = uint16_t

Indicates the native unsigned integer type used to store a single image pack.

See the class notes for more information on image packs, and how they are used to build the old first-generation permutation codes.

◆ Index

using regina::Perm< 5 >::Index = int

Denotes a native signed integer type large enough to count all permutations on five elements.

In other words, this is a native signed integer type large enough to store (5!).

Constructor & Destructor Documentation

◆ Perm() [1/9]

constexpr regina::Perm< 5 >::Perm ( )

inlineconstexpr

Creates the identity permutation.

◆ Perm() [2/9]

constexpr regina::Perm< 5 >::Perm	(	int	a,
		int	b
	)

inlineconstexpr

Creates the transposition of a and b.

Note that a and b need not be distinct.

Precondition: a and b are in {0,1,2,3,4}.

Parameters

a	the element to switch with b.
b	the element to switch with a.

◆ Perm() [3/9]

constexpr regina::Perm< 5 >::Perm	(	int	a,
		int	b,
		int	c,
		int	d,
		int	e
	)

inlineconstexpr

Creates a permutation mapping (0,1,2,3,4) to (a,b,c,d,e) respectively.

Precondition: {a,b,c,d,e} = {0,1,2,3,4}.

Parameters

a	the desired image of 0.
b	the desired image of 1.
c	the desired image of 2.
d	the desired image of 3.
e	the desired image of 4.

◆ Perm() [4/9]

constexpr regina::Perm< 5 >::Perm ( const std::array< int, 5 > & image )

inlineconstexpr

Creates a permutation mapping i to image[i] for each i = 0,1,2,3,4.

Precondition: The elements of image are 0, 1, 2, 3 and 4 in some order.

Parameters

image the array of images.

◆ Perm() [5/9]

constexpr regina::Perm< 5 >::Perm ( const int * image )

inlineconstexpr

Deprecated constructor that creates a permutation mapping i to image[i] for each i = 0,1,2,3,4.

Deprecated:: Use the five-integer constructor or the std::array constructor instead.

Precondition: The array image contains five elements, which are 0, 1, 2, 3 and 4 in some order.

Parameters

image the array of images.

◆ Perm() [6/9]

constexpr regina::Perm< 5 >::Perm	(	const int *	a,
		const int *	b
	)

inlineconstexpr

Deprecated constuctor that creates a permutation mapping (a[0], ..., a[4]) to (b[0], ..., b[4]) respectively.

Deprecated:: Use the ten-integer constructor or the std::array constructor instead.

Precondition: Both arrays a and b contain 5 elements, which are 0,...,4 in some order.

Python: Not present; use the single-array constructor instead.

Parameters

a	the array of preimages; this must have length 5.
b	the corresponding array of images; this must also have length 5.

◆ Perm() [7/9]

constexpr regina::Perm< 5 >::Perm	(	int	a0,
		int	a1,
		int	b0,
		int	b1,
		int	c0,
		int	c1,
		int	d0,
		int	d1,
		int	e0,
		int	e1
	)

inlineconstexpr

Creates a permutation mapping (a0,b0,c0,d0,e0) to (a1,b1,c1,d1,e1) respectively.

Precondition: {a0,b0,c0,d0,e0} = {a1,b1,c1,d1,e1} = {0,1,2,3,4}.

Parameters

a0	the desired preimage of a1.
b0	the desired preimage of b1.
c0	the desired preimage of c1.
d0	the desired preimage of d1.
e0	the desired preimage of e1.
a1	the desired image of a0.
b1	the desired image of b0.
c1	the desired image of c0.
d1	the desired image of d0.
e1	the desired image of e0.

◆ Perm() [8/9]

constexpr regina::Perm< 5 >::Perm ( const Perm< 5 > & cloneMe )

constexprdefault

Creates a permutation that is a clone of the given permutation.

Parameters

cloneMe the permutation to clone.

◆ Perm() [9/9]

constexpr regina::Perm< 5 >::Perm ( Code2 code )

inlineconstexprprotected

Creates a permutation from the given second-generation permutation code.

Precondition: the given code is a valid second-generation permutation code; see isPermCode2() for details.

Parameters

code	the second-generation code from which the new permutation will be created.

Member Function Documentation

◆ atIndex()

constexpr Perm< 5 > regina::Perm< 5 >::atIndex ( Index i )

inlinestaticconstexpr

Deprecated routine that returns the ith permutation on five elements, where permutations are numbered lexicographically.

Deprecated:: Use orderedSn[i] instead.

Parameters

i	the lexicographical index of the permutation; this must be between 0 and 119 inclusive.

Returns: the ith permutation.

◆ clear()

void regina::Perm< 5 >::clear ( unsigned from )

Resets the images of all integers from from onwards to the identity map.

Specifically, for each i in the range from,...,4, this routine will ensure that image[i] == i. The images of 0,1,...,from-1 will not be altered.

Precondition: The images of from,...,4 are exactly from,...,4, but possibly in a different order.

Parameters

from	the first integer whose image should be reset. This must be between 0 and 5 inclusive.

◆ compareWith()

constexpr int regina::Perm< 5 >::compareWith ( const Perm< 5 > & other ) const

inlineconstexpr

Lexicographically compares the images of (0,1,2,3,4) under this and the given permutation.

Note that this does not yield the same ordering of permutations as used by the less-than and increment operators. Moreover, compareWith() is slower than the less-than operator to compute.

Parameters

other the permutation with which to compare this.

Returns: -1 if this permutation produces a smaller image, 0 if the permutations are equal and 1 if this permutation produces a greater image.

◆ contract()

template<int k>

static constexpr Perm< 5 > regina::Perm< 5 >::contract ( Perm< k > p )

staticconstexpr

Restricts a k-element permutation to an 5-element permutation, where k > 5.

The resulting permutation will map 0,...,4 to their respective images under p, and will ignore the "unused" images p[5],...,p[k-1].

Precondition: The given permutation maps 0,...,4 to 0,...,4 in some order.

Template Parameters

k	the number of elements for the input permutation; this must be strictly greater than 5.

Parameters

p	a permutation on k elements.

Returns: the same permutation restricted to a permutation on 5 elements.

◆ extend()

template<int k>

static constexpr Perm< 5 > regina::Perm< 5 >::extend ( Perm< k > p )

staticconstexpr

Extends a k-element permutation to a 5-element permutation, where 2 ≤ k < 5.

The resulting permutation will map 0,...,k-1 to their respective images under p, and will map the "unused" elements k,...,4 to themselves.

Template Parameters

k	the number of elements for the input permutation; this must be 2, 3 or 4.

Parameters

p	a permutation on k elements.

Returns: the same permutation expressed as a permutation on five elements.

◆ fromImagePack()

constexpr Perm< 5 > regina::Perm< 5 >::fromImagePack ( ImagePack pack )

inlinestaticconstexpr

Creates a permutation from the given image pack.

See the class notes for more information on image packs, and how they are used to build the old first-generation permutation codes.

For Perm<5>, this routine is identical to fromPermCode1().

Precondition: The argument pack is a valid image pack; see isImagePack() for details.

Parameters

pack	an image pack that describes a permutation.

Returns: the permutation represented by the given image pack.

◆ fromPermCode()

constexpr Perm< 5 > regina::Perm< 5 >::fromPermCode ( Code1 code )

inlinestaticconstexpr

Deprecated routine that creates a permutation from the given first-generation permutation code.

Precondition: the given code is a valid first-generation permutation code; see isPermCode1() for details.

Deprecated:: Use fromPermCode1() to reproduce this behaviour. However, unless you need backward compatibility, it is strongly recommended to switch to the much faster second-generation codes instead.

Warning: This routine will incur additional overhead, since Perm<5> now uses second-generation codes internally. See the class notes and the routine fromPermCode2() for details.

Parameters

code	the first-generation code for the new permutation.

Returns: the permutation represented by the given code.

◆ fromPermCode1()

constexpr Perm< 5 > regina::Perm< 5 >::fromPermCode1 ( Code1 code )

inlinestaticconstexpr

Creates a permutation from the given first-generation permutation code.

Precondition: the given code is a valid first-generation permutation code; see isPermCode1() for details.

Warning: This routine will incur additional overhead, since Perm<5> now uses second-generation codes internally. See the class notes and the routine fromPermCode2() for details.

Parameters

code	the first-generation code for the new permutation.

Returns: the permutation represented by the given code.

◆ fromPermCode2()

constexpr Perm< 5 > regina::Perm< 5 >::fromPermCode2 ( Code2 code )

inlinestaticconstexpr

Creates a permutation from the given second-generation permutation code.

Second-generation codes are fast to work with, since they are used internally by the Perm<5> class.

Precondition: the given code is a valid second-generation permutation code; see isPermCode2() for details.

Parameters

code	the second-generation code for the new permutation.

Returns: the permutation represented by the given code.

◆ imagePack()

constexpr Perm< 5 >::ImagePack regina::Perm< 5 >::imagePack ( ) const

inlineconstexpr

Returns the image pack that represents this permutation.

See the class notes for more information on image packs, and how they are used to build the old first-generation permutation codes.

For Perm<5>, this routine is identical to permCode1().

Returns: the image pack for this permutation.

◆ index()

constexpr Perm< 5 >::Index regina::Perm< 5 >::index ( ) const

inlineconstexpr

Deprecated routine that returns the lexicographical index of this permutation.

Deprecated:: Use the equivalent routine orderedSnIndex() instead.

Returns: the lexicographical index of this permutation.

◆ inverse()

constexpr Perm< 5 > regina::Perm< 5 >::inverse ( ) const

inlineconstexpr

Finds the inverse of this permutation.

Returns: the inverse of this permutation.

◆ isConjugacyMinimal()

constexpr bool regina::Perm< 5 >::isConjugacyMinimal ( ) const

inlineconstexpr

Is this permutation minimal in its conjugacy class?

Here "minimal" means that, amongst all its conjugates, this permutation has the smallest index in the array Perm<5>::Sn.

See Sn for further information on how permutations are indexed.

This routine is extremely fast for Perm<5>, since it essentially uses a hard-coded lookup table.

Returns: true if and only if this permutation is minimal in its conjugacy class.

◆ isIdentity()

constexpr bool regina::Perm< 5 >::isIdentity ( ) const

inlineconstexpr

Determines if this is the identity permutation.

This is true if and only if each of 0, 1, 2, 3 and 4 is mapped to itself.

Returns: true if and only if this is the identity permutation.

◆ isImagePack()

constexpr bool regina::Perm< 5 >::isImagePack ( ImagePack pack )

inlinestaticconstexpr

Determines whether the given argument is the image pack of some 5-element permutation.

See the class notes for more information on image packs, and how they are used to build the old first-generation permutation codes.

For Perm<5>, this routine is identical to isPermCode1().

Parameters

pack	the candidate image pack to test.

Returns: true if and only if pack is a valid image pack.

◆ isPermCode()

constexpr bool regina::Perm< 5 >::isPermCode ( Code1 code )

inlinestaticconstexpr

Deprecated routine that determines whether the given character is a valid first-generation permutation code.

Deprecated:: Use isPermCode1() to reproduce this behaviour. However, unless you need backward compatibility, it is strongly recommended to switch to the much faster second-generation codes instead.

Warning: This routine will incur additional overhead, since Perm<5> now uses second-generation codes internally. See the class notes and the routine isPermCode2() for details.

Parameters

code	the permutation code to test.

Returns: true if and only if the given code is a valid first-generation permutation code.

◆ isPermCode1()

constexpr bool regina::Perm< 5 >::isPermCode1 ( Code1 code )

inlinestaticconstexpr

Determines whether the given character is a valid first-generation permutation code.

Valid first-generation codes can be passed to setPermCode1() or fromPermCode1(), and are returned by permCode1().

Warning: This routine will incur additional overhead, since Perm<5> now uses second-generation codes internally. See the class notes and the routine isPermCode2() for details.

Parameters

code	the permutation code to test.

Returns: true if and only if the given code is a valid first-generation permutation code.

◆ isPermCode2()

constexpr bool regina::Perm< 5 >::isPermCode2 ( Code2 code )

inlinestaticconstexpr

Determines whether the given character is a valid second-generation permutation code.

Valid second-generation codes can be passed to setPermCode2() or fromPermCode2(), and are returned by permCode2().

Second-generation codes are fast to work with, since they are used internally by the Perm<5> class.

Parameters

code	the permutation code to test.

Returns: true if and only if the given code is a valid second-generation permutation code.

◆ operator!=()

constexpr bool regina::Perm< 5 >::operator!= ( const Perm< 5 > & other ) const

inlineconstexpr

Determines if this differs from the given permutation.

This is true if and only if the two permutations have different images for at least one of 0, 1, 2, 3 or 4.

Parameters

other the permutation with which to compare this.

Returns: true if and only if this and the given permutation differ.

◆ operator*()

constexpr Perm< 5 > regina::Perm< 5 >::operator* ( const Perm< 5 > & q ) const

inlineconstexpr

Returns the composition of this permutation with the given permutation.

If this permutation is p, the resulting permutation will be p o q, satisfying (p*q)[x] == p[q[x]].

Parameters

q	the permutation with which to compose this.

Returns: the composition of both permutations.

◆ operator++() [1/2]

Perm< 5 > & regina::Perm< 5 >::operator++ ( )

inline

A preincrement operator that changes this to be the next permutation in the array Perm<5>::Sn.

If this is the last such permutation then this will wrap around to become the first permutation in Perm<5>::Sn, which is the identity.

Python: Not present, although the postincrement operator is present in python as the member function inc().

Returns: a reference to this permutation after the increment.

◆ operator++() [2/2]

constexpr Perm< 5 > regina::Perm< 5 >::operator++ ( int )

inlineconstexpr

A postincrement operator that changes this to be the next permutation in the array Perm<5>::Sn.

If this is the last such permutation then this will wrap around to become the first permutation in Perm<5>::Sn, which is the identity.

Python: This routine is named inc() since python does not support the increment operator.

Returns: a copy of this permutation before the increment took place.

◆ operator<()

constexpr bool regina::Perm< 5 >::operator< ( const Perm< 5 > & rhs ) const

inlineconstexpr

Determines if this appears earlier than the given permutation in the array Perm<5>::Sn.

Note that this is not the same ordering of permutations as the ordering implied by compareWith(). This is, however, consistent with the ordering implied by the ++ operators, and this order is also faster to compute than compareWith().

Parameters

rhs	the permutation to compare this against.

Returns: true if and only if this appears before rhs in Sn.

◆ operator=()

Perm< 5 > & regina::Perm< 5 >::operator= ( const Perm< 5 > & cloneMe )

default

Sets this permutation to be equal to the given permutation.

Parameters

cloneMe the permutation whose value will be assigned to this permutation.

Returns: a reference to this permutation.

◆ operator==()

constexpr bool regina::Perm< 5 >::operator== ( const Perm< 5 > & other ) const

inlineconstexpr

Determines if this is equal to the given permutation.

This is true if and only if both permutations have the same images for 0, 1, 2, 3 and 4.

Parameters

other the permutation with which to compare this.

Returns: true if and only if this and the given permutation are equal.

◆ operator[]()

constexpr int regina::Perm< 5 >::operator[] ( int source ) const

inlineconstexpr

Determines the image of the given integer under this permutation.

Parameters

source the integer whose image we wish to find. This should be between 0 and 4 inclusive.

Returns: the image of source.

◆ order()

constexpr int regina::Perm< 5 >::order ( ) const

inlineconstexpr

Returns the order of this permutation.

In other words; this routine returns the smallest positive integer k for which the kth power of this permutation is the identity.

Returns: the order of this permutation.

◆ orderedS5Index()

constexpr Perm< 5 >::Index regina::Perm< 5 >::orderedS5Index ( ) const

inlineconstexpr

Returns the lexicographical index of this permutation.

This will be the index of this permutation in the Perm<5>::orderedSn array.

This is a dimension-specific alias for orderedSnIndex(). In general, for every n there will be a member function Perm<n>::orderedSnIndex(); however, these numerical aliases Perm<2>::orderedS2Index(), ..., Perm<5>::orderedS5Index() are only available for small n.

See orderedSn for further information on lexicographical ordering.

Returns: the lexicographical index of this permutation. This will be between 0 and 119 inclusive.

◆ orderedSnIndex()

constexpr Perm< 5 >::Index regina::Perm< 5 >::orderedSnIndex ( ) const

inlineconstexpr

Returns the lexicographical index of this permutation.

This will be the index of this permutation in the Perm<5>::orderedSn array.

See orderedSn for further information on lexicographical ordering.

Returns: the lexicographical index of this permutation. This will be between 0 and 119 inclusive.

◆ permCode()

constexpr Perm< 5 >::Code1 regina::Perm< 5 >::permCode ( ) const

inlineconstexpr

Deprecated routine that returns the first-generation code representing this permutation.

The code returned will be a valid first-generation permutation code as determined by isPermCode1().

Deprecated:: Use permCode1() to reproduce this behaviour. However, unless you need backward compatibility, it is strongly recommended to switch to the much faster second-generation codes instead.

Warning: This routine will incur additional overhead, since Perm<5> now uses second-generation codes internally. See the class notes and the routine permCode2() for details.

Returns: the first-generation permutation code.

◆ permCode1()

constexpr Perm< 5 >::Code1 regina::Perm< 5 >::permCode1 ( ) const

inlineconstexpr

Returns the first-generation code representing this permutation.

This code is sufficient to reproduce the entire permutation.

The code returned will be a valid first-generation permutation code as determined by isPermCode1().

Warning: This routine will incur additional overhead, since Perm<5> now uses second-generation codes internally. See the class notes and the routine permCode2() for details.

Returns: the first-generation permutation code.

◆ permCode2()

constexpr Perm< 5 >::Code2 regina::Perm< 5 >::permCode2 ( ) const

inlineconstexpr

Returns the second-generation code representing this permutation.

This code is sufficient to reproduce the entire permutation.

The code returned will be a valid second-generation permutation code as determined by isPermCode2().

Second-generation codes are fast to work with, since they are used internally by the Perm<5> class.

Returns: the second-generation permutation code.

◆ pow()

constexpr Perm< 5 > regina::Perm< 5 >::pow ( long exp ) const

inlineconstexpr

Computes the given power of this permutation.

This routine runs in constant time.

Parameters

exp	the exponent; this may be positive, zero or negative.

Returns: this permutation raised to the power of exp.

◆ pre()

constexpr int regina::Perm< 5 >::pre ( int image ) const

inlineconstexpr

Determines the preimage of the given integer under this permutation.

Parameters

image the integer whose preimage we wish to find. This should be between 0 and 4 inclusive.

Returns: the preimage of image.

◆ preImageOf()

constexpr int regina::Perm< 5 >::preImageOf ( int image ) const

inlineconstexpr

Deprecated routine that determines the preimage of the given integer under this permutation.

Deprecated:: This routine has been renamed to pre().

Parameters

image the integer whose preimage we wish to find. This should be between 0 and 4 inclusive.

Returns: the preimage of image.

◆ rand() [1/2]

Perm< 5 > regina::Perm< 5 >::rand ( bool even = false )

inlinestatic

Returns a random permutation on five elements.

All permutations are returned with equal probability.

This routine is thread-safe, and uses RandomEngine for its random number generation.

Warning: This routine is expensive, since it locks and unlocks the mutex protecting Regina's global uniform random bit generator. If you are calling this many times in quick succession, consider creating a single RandomEngine object yourself and then calling rand(randomEngine.engine(), even).

Parameters

even	if `true`, then the resulting permutation is guaranteed to be even (and again all even permutations are returned with equal probability).

Returns: a random permutation.

◆ rand() [2/2]

template<class URBG >

static Perm regina::Perm< 5 >::rand	(	URBG &&	gen,
		bool	even = `false`
	)

static

Returns a random permutation on five elements, using the given uniform random bit generator.

All permutations are returned with equal probability.

The thread safety of this routine is of course dependent on the thread safety of your uniform random bit generator gen.

Template Parameters

URBG	A type which, once any references are removed, must adhere to the C++ UniformRandomBitGenerator concept.

Python: Not present, though the non-thread-safe variant without the gen argument is available.

Parameters

gen	the source of randomness to use (e.g., one of the many options provided in the C++ standard `random` header).
even	if `true`, then the resulting permutation is guaranteed to be even (and again all even permutations are returned with equal probability).

Returns: a random permutation.

◆ reverse()

constexpr Perm< 5 > regina::Perm< 5 >::reverse ( ) const

inlineconstexpr

Finds the reverse of this permutation.

Here reverse means that we reverse the images of 0,...,4. In other words, if permutation q is the reverse of p, then p[i] == q[4 - i] for all i.

◆ rot()

constexpr Perm< 5 > regina::Perm< 5 >::rot ( int i )

inlinestaticconstexpr

Returns the ith rotation.

This maps k to k + i (mod 5) for all k.

Parameters

i	the image of 0; this must be between 0 and 4 inclusive.

Returns: the ith rotation.

◆ S5Index()

constexpr Perm< 5 >::Index regina::Perm< 5 >::S5Index ( ) const

inlineconstexpr

Returns the index of this permutation in the Perm<5>::S5 array.

This is a dimension-specific alias for SnIndex(). In general, for every n there will be a member function Perm<n>::SnIndex(); however, these numerical aliases Perm<2>::S2Index(), ..., Perm<5>::S5Index() are only available for small n.

See Sn for further information on how these permutations are indexed.

Returns: the index i for which this permutation is equal to Perm<5>::S5[i]. This will be between 0 and 119 inclusive.

◆ setPermCode()

void regina::Perm< 5 >::setPermCode ( Code1 code )

inline

Deprecated routine that sets this permutation to that represented by the given first-generation permutation code.

Deprecated:: Use setPermCode1() to reproduce this behaviour. However, unless you need backward compatibility, it is strongly recommended to switch to the much faster second-generation codes instead.

Precondition: the given code is a valid first-generation permutation code; see isPermCode1() for details.

Warning: This routine will incur additional overhead, since Perm<5> now uses second-generation codes internally. See the class notes and the routine setPermCode2() for details.

Parameters

code	the first-generation code that will determine the new value of this permutation.

◆ setPermCode1()

void regina::Perm< 5 >::setPermCode1 ( Code1 code )

inline

Sets this permutation to that represented by the given first-generation permutation code.

Precondition: the given code is a valid first-generation permutation code; see isPermCode1() for details.

Warning: This routine will incur additional overhead, since Perm<5> now uses second-generation codes internally. See the class notes and the routine setPermCode2() for details.

Parameters

code	the first-generation code that will determine the new value of this permutation.

◆ setPermCode2()

void regina::Perm< 5 >::setPermCode2 ( Code2 code )

inline

Sets this permutation to that represented by the given second-generation permutation code.

Second-generation codes are fast to work with, since they are used internally by the Perm<5> class.

Precondition: the given code is a valid second-generation permutation code; see isPermCode2() for details.

Parameters

code	the second-generation code that will determine the new value of this permutation.

◆ sign()

constexpr int regina::Perm< 5 >::sign ( ) const

inlineconstexpr

Determines the sign of this permutation.

Returns: 1 if this permutation is even, or -1 if this permutation is odd.

◆ SnIndex()

constexpr Perm< 5 >::Index regina::Perm< 5 >::SnIndex ( ) const

inlineconstexpr

Returns the index of this permutation in the Perm<5>::Sn array.

See Sn for further information on how these permutations are indexed.

Returns: the index i for which this permutation is equal to Perm<5>::Sn[i]. This will be between 0 and 119 inclusive.

◆ str()

std::string regina::Perm< 5 >::str ( ) const

Returns a string representation of this permutation.

The representation will consist of five adjacent digits representing the images of 0, 1, 2, 3 and 4 respectively. An example of a string representation is 30421.

Returns: a string representation of this permutation.

◆ trunc()

std::string regina::Perm< 5 >::trunc ( unsigned len ) const

Returns a prefix of the string representation of this permutation, containing only the images of the first len integers.

Parameters

len	the length of the prefix required; this must be between 0 and 5 inclusive.

Returns: the corresponding prefix of the string representation of this permutation.

◆ trunc2()

std::string regina::Perm< 5 >::trunc2 ( ) const

Returns a string representation of this permutation with only the images of 0 and 1.

The resulting string will therefore have length two.

Returns: a truncated string representation of this permutation.

◆ trunc3()

std::string regina::Perm< 5 >::trunc3 ( ) const

Returns a string representation of this permutation with only the images of 0, 1 and 2.

The resulting string will therefore have length three.

Returns: a truncated string representation of this permutation.

◆ trunc4()

std::string regina::Perm< 5 >::trunc4 ( ) const

Returns a string representation of this permutation with only the images of 0, 1, 2 and 3.

The resulting string will therefore have length four.

Returns: a truncated string representation of this permutation.

Member Data Documentation

◆ code2_

Code2 regina::Perm< 5 >::code2_

protected

The internal second-generation permutation code representing this permutation.

◆ codeType

constexpr PermCodeType regina::Perm< 5 >::codeType = PERM_CODE_INDEX

staticconstexpr

Indicates what type of internal permutation code is used by this instance of the Perm class template.

◆ imageBits

constexpr int regina::Perm< 5 >::imageBits = 3

staticconstexpr

Indicates the number of bits used in an image pack to store the image of a single integer.

A full image pack combines 5 such images together, and so uses 5 * imageBits bits in total.

◆ imageMask

constexpr ImagePack regina::Perm< 5 >::imageMask

staticconstexpr

Initial value:

=

(static_cast<ImagePack>(1) << imageBits) - 1

regina::Perm< 5 >::ImagePack

uint16_t ImagePack

Indicates the native unsigned integer type used to store a single image pack.

Definition: perm5.h:257

regina::Perm< 5 >::imageBits

static constexpr int imageBits

Indicates the number of bits used in an image pack to store the image of a single integer.

Definition: perm5.h:249

A bitmask whose lowest imageBits bits are 1, and whose remaining higher order bits are all 0.

This may be useful when creating or analysing image packs.

◆ nPerms

constexpr Index regina::Perm< 5 >::nPerms = 120

staticconstexpr

The total number of permutations on five elements.

This is the size of the array Sn.

◆ nPerms_1

constexpr Index regina::Perm< 5 >::nPerms_1 = 24

staticconstexpr

The total number of permutations on four elements.

This is the size of the array Sn_1.

◆ orderedS3

constexpr OrderedS3Lookup regina::Perm< 5 >::orderedS3 {}

staticconstexpr

Gives array-like access to all possible permutations of three elements in lexicographical order.

In each permutation, 3 maps to 3 and 4 maps to 4.

To access the permutation at index i, you simply use the square bracket operator: orderedS3[i]. The index i must be between 0 and 5 inclusive.

In Regina 6.0.1 and earlier, this was a hard-coded C-style array; since Regina 7.0 it has changed type, but accessing elements as described above remains extremely fast. The object that is returned is lightweight and is defined in the headers only; in particular, you cannot make a reference to it (but you can always make a copy).

This is different from Perm<5>::S3, since this array orderedS3 stores permutations in lexicographical order, whereas S3 alternates between even and odd permutations.

Note that the small permutation classes Perm<3>, Perm<4> and Perm<5> all have an orderedS3 array; these all store the same six permutations in the same order (but of course using different data types).

◆ orderedS4

constexpr OrderedS4Lookup regina::Perm< 5 >::orderedS4 {}

staticconstexpr

Gives array-like access to all possible permutations of four elements in lexicographical order.

In each permutation, 4 maps to 4.

To access the permutation at index i, you simply use the square bracket operator: orderedS4[i]. The index i must be between 0 and 23 inclusive.

In Regina 6.0.1 and earlier, this was a hard-coded C-style array; since Regina 7.0 it has changed type, but accessing elements as described above remains extremely fast. The object that is returned is lightweight and is defined in the headers only; in particular, you cannot make a reference to it (but you can always make a copy).

This is different from Perm<5>::S4, since this array orderedS4 stores permutations in lexicographical order, whereas S4 (or equivalently, Sn_1) alternates between even and odd permutations.

Note that both permutation classes Perm<4> and Perm<5> have an orderedS4 array; these both store the same 24 permutations in the same order (but of course using different data types).

◆ orderedS5

constexpr OrderedS5Lookup regina::Perm< 5 >::orderedS5 {}

staticconstexpr

Gives array-like access to all possible permutations of five elements in lexicographical order.

This is a dimension-specific alias for Perm<5>::orderedSn; see that member for further information. In general, for every n there will be a static member Perm<n>::orderedSn; however, these numerical aliases Perm<2>::orderedS2, ..., Perm<5>::orderedS5 are only available for small n.

◆ orderedSn

constexpr OrderedS5Lookup regina::Perm< 5 >::orderedSn {}

staticconstexpr

Gives array-like access to all possible permutations of five elements in lexicographical order.

To access the permutation at index i, you simply use the square bracket operator: orderedSn[i]. The index i must be between 0 and 119 inclusive.

Lexicographical ordering treats each permutation p as the ordered pair (p[0], ..., p[4]).

In Regina 6.0.1 and earlier, this was a hard-coded C-style array; since Regina 7.0 it has changed type, but accessing elements as described above remains extremely fast. The object that is returned is lightweight and is defined in the headers only; in particular, you cannot make a reference to it (but you can always make a copy).

This is different from Perm<5>::Sn, since this array orderedSn stores permutations in lexicographical order, whereas Sn alternates between even and odd permutations.

◆ S2

constexpr S2Lookup regina::Perm< 5 >::S2 {}

staticconstexpr

Gives array-like access to all possible permutations of two elements.

In each permutation, 2 maps to 2, 3 maps to 3, and 4 maps to 4.

To access the permutation at index i, you simply use the square bracket operator: S2[i]. The index i must be between 0 and 1 inclusive.

In Regina 6.0.1 and earlier, this was a hard-coded C-style array; since Regina 7.0 it has changed type, but accessing elements as described above remains extremely fast. The object that is returned is lightweight and is defined in the headers only; in particular, you cannot make a reference to it (but you can always make a copy).

The permutations with even indices in the array are the even permutations, and those with odd indices in the array are the odd permutations.

Note that all small permutation classes (Perm<2>, ..., Perm<5>) have an S2 array: these all store the same two permutations in the same order (but of course using different data types).

There is no corresponding orderedS2 array, since the (trivial) arrays S2 and orderedS2 are identical.

◆ S3

constexpr S3Lookup regina::Perm< 5 >::S3 {}

staticconstexpr

Gives array-like access to all possible permutations of three elements.

In each permutation, 3 maps to 3 and 4 maps to 4.

To access the permutation at index i, you simply use the square bracket operator: S3[i]. The index i must be between 0 and 5 inclusive.

In Regina 6.0.1 and earlier, this was a hard-coded C-style array; since Regina 7.0 it has changed type, but accessing elements as described above remains extremely fast. The object that is returned is lightweight and is defined in the headers only; in particular, you cannot make a reference to it (but you can always make a copy).

The permutations with even indices in the array are the even permutations, and those with odd indices in the array are the odd permutations.

This is different from Perm<5>::orderedS3, since this array S3 alternates between even and odd permutations, whereas orderedS3 stores permutations in lexicographical order.

Note that the small permutation classes Perm<3>, Perm<4> and Perm<5> all have an S3 array; these all store the same six permutations in the same order (but of course using different data types).

◆ S4

constexpr S4Lookup regina::Perm< 5 >::S4 {}

staticconstexpr

Gives array-like access to all possible permutations of four elements.

This is a dimension-specific alias for Perm<5>::Sn_1; see that member for further information.

Note that both permutation classes Perm<4> and Perm<5> have an S4 array; these both store the same 24 permutations in the same order (but of course using different data types).

◆ S5

constexpr S5Lookup regina::Perm< 5 >::S5 {}

staticconstexpr

Gives array-like access to all possible permutations of five elements.

This is a dimension-specific alias for Perm<5>::Sn; see that member for further information. In general, for every n there will be a static member Perm<n>::Sn; however, these numerical aliases Perm<2>::S2, ..., Perm<5>::S5 are only available for small n.

◆ Sn

constexpr S5Lookup regina::Perm< 5 >::Sn {}

staticconstexpr

Gives array-like access to all possible permutations of five elements.

To access the permutation at index i, you simply use the square bracket operator: Sn[i]. The index i must be between 0 and 119 inclusive.

In Regina 6.0.1 and earlier, this was a hard-coded C-style array; since Regina 7.0 it has changed type, but accessing elements as described above remains extremely fast. The object that is returned is lightweight and is defined in the headers only; in particular, you cannot make a reference to it (but you can always make a copy).

The permutations with even indices in the array are the even permutations, and those with odd indices in the array are the odd permutations.

This is different from Perm<5>::orderedSn, since this array Sn alternates between even and odd permutations, whereas orderedSn stores permutations in lexicographical order.

◆ Sn_1

constexpr S4Lookup regina::Perm< 5 >::Sn_1 {}

staticconstexpr

Gives array-like access to all possible permutations of four elements.

In each permutation, 4 maps to 4.

To access the permutation at index i, you simply use the square bracket operator: Sn_1[i]. The index i must be between 0 and 23 inclusive.

In Regina 6.0.1 and earlier, this was a hard-coded C-style array; since Regina 7.0 it has changed type, but accessing elements as described above remains extremely fast. The object that is returned is lightweight and is defined in the headers only; in particular, you cannot make a reference to it (but you can always make a copy).

The permutations with even indices in the array are the even permutations, and those with odd indices in the array are the odd permutations.

This is different from Perm<5>::orderedS4, since this array Sn_1 (or equivalently, S4) alternates between even and odd permutations, whereas orderedS4 stores permutations in lexicographical order.

The documentation for this class was generated from the following file:

maths/spec/perm5.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Code

◆ Code1

◆ Code2

◆ ImagePack

◆ Index

Constructor & Destructor Documentation

◆ Perm() [1/9]

◆ Perm() [2/9]

◆ Perm() [3/9]

◆ Perm() [4/9]

◆ Perm() [5/9]

◆ Perm() [6/9]

◆ Perm() [7/9]

◆ Perm() [8/9]

◆ Perm() [9/9]

Member Function Documentation

◆ atIndex()

◆ clear()

◆ compareWith()

◆ contract()

◆ extend()

◆ fromImagePack()

◆ fromPermCode()

◆ fromPermCode1()

◆ fromPermCode2()

◆ imagePack()

◆ index()

◆ inverse()

◆ isConjugacyMinimal()

◆ isIdentity()

◆ isImagePack()

◆ isPermCode()

◆ isPermCode1()

◆ isPermCode2()

◆ operator!=()

◆ operator*()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator<()

◆ operator=()

◆ operator==()

◆ operator[]()

◆ order()

◆ orderedS5Index()

◆ orderedSnIndex()

◆ permCode()

◆ permCode1()

◆ permCode2()

◆ pow()

◆ pre()

◆ preImageOf()

◆ rand() [1/2]

◆ rand() [2/2]

◆ reverse()

◆ rot()

◆ S5Index()

◆ setPermCode()

◆ setPermCode1()

◆ setPermCode2()

◆ sign()

◆ SnIndex()

◆ str()

◆ trunc()

◆ trunc2()

◆ trunc3()

◆ trunc4()

Member Data Documentation

◆ code2_

◆ codeType

◆ imageBits

◆ imageMask

◆ nPerms