Regina 7.3 Calculation Engine
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
regina::Perm< 4 > Class Reference

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

#include <maths/spec/perm4.h>

Public Types

using Index = int
 Denotes a native signed integer type large enough to count all permutations on four elements. More...
 
using ImagePack = uint8_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...
 

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)
 Creates a permutation mapping (0,1,2,3) to (a,b,c,d) respectively. More...
 
constexpr Perm (const std::array< int, 4 > &image)
 Creates a permutation mapping i to image[i] for each i = 0,1,2,3. More...
 
constexpr Perm (int a0, int a1, int b0, int b1, int c0, int c1, int d0, int d1)
 Creates a permutation mapping (a0,b0,c0,d0) to (a1,b1,c1,d1) respectively. More...
 
constexpr Perm (const Perm< 4 > &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...
 
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...
 
constexpr ImagePack imagePack () const
 Returns the image pack that represents this permutation. More...
 
Perm< 4 > & operator= (const Perm< 4 > &cloneMe)=default
 Sets this permutation to be equal to the given permutation. More...
 
constexpr Perm< 4 > operator* (const Perm< 4 > &q) const
 Returns the composition of this permutation with the given permutation. More...
 
Perm< 4 > cachedComp (const Perm< 4 > &q) const
 An alias for the composition operator, provided to assist with writing generic code. More...
 
Perm< 4 > cachedComp (const Perm< 4 > &q, const Perm< 4 > &r) const
 Deprecated alias for using the composition operator twice, provided to assist with writing generic code. More...
 
constexpr Perm< 4 > conjugate (const Perm< 4 > &q) const
 Computes the conjugate of this permutation by q. More...
 
Perm< 4 > cachedConjugate (const Perm< 4 > &q) const
 An alias for conjugate(), provided to assist with writing generic code. More...
 
constexpr Perm< 4 > inverse () const
 Finds the inverse of this permutation. More...
 
Perm< 4 > cachedInverse () const
 An alias for inverse(), provided to assist with writing generic code. More...
 
constexpr Perm< 4 > pow (long exp) const
 Computes the given power of this permutation. More...
 
Perm< 4 > cachedPow (long exp) const
 An alias for pow(), provided to assist with writing generic code. More...
 
constexpr int order () const
 Returns the order of this permutation. More...
 
int cachedOrder () const
 An alias for order(), provided to assist with writing generic code. More...
 
constexpr Perm< 4 > 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 bool operator== (const Perm< 4 > &other) const
 Determines if this is equal to the given permutation. More...
 
constexpr bool operator!= (const Perm< 4 > &other) const
 Determines if this differs from the given permutation. More...
 
constexpr int compareWith (const Perm< 4 > &other) const
 Lexicographically compares the images of (0,1,2,3) under this and the given permutation. More...
 
constexpr bool isIdentity () const
 Determines if this is the identity permutation. More...
 
Perm< 4 > & operator++ ()
 A preincrement operator that changes this to be the next permutation in the array Perm<4>::Sn. More...
 
constexpr Perm< 4 > operator++ (int)
 A postincrement operator that changes this to be the next permutation in the array Perm<4>::Sn. More...
 
constexpr bool operator< (const Perm< 4 > &rhs) const
 Determines if this appears earlier than the given permutation in the array Perm<4>::Sn. More...
 
std::string str () const
 Returns a string representation of this permutation. More...
 
std::string trunc (int 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 included. More...
 
void tightEncode (std::ostream &out) const
 Writes the tight encoding of this permutation to the given output stream. More...
 
std::string tightEncoding () const
 Returns the tight encoding of this permutation. 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<4>::Sn array. More...
 
constexpr Index S4Index () const
 Returns the index of this permutation in the Perm<4>::S4 array. More...
 
constexpr Index orderedSnIndex () const
 Returns the lexicographical index of this permutation. More...
 
constexpr Index orderedS4Index () const
 Returns the lexicographical index of this permutation. More...
 
constexpr bool isConjugacyMinimal () const
 Is this permutation minimal in its conjugacy class? More...
 
constexpr Perm< 6 > pairs () const
 Returns the induced permutation on all six pairs of elements from 0,1,2,3. More...
 

Static Public Member Functions

static constexpr void precompute ()
 A do-nothing routine that assists with writing generic code. More...
 
static constexpr Perm< 4 > fromPermCode1 (Code1 code)
 Creates a permutation from the given first-generation permutation code. More...
 
static constexpr Perm< 4 > fromPermCode2 (Code2 code)
 Creates a permutation from the given second-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 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 4-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 four elements. More...
 
template<class URBG >
static Perm rand (URBG &&gen, bool even=false)
 Returns a random permutation on four elements, using the given uniform random bit generator. More...
 
static Perm tightDecoding (const std::string &enc)
 Reconstructs a permutation from its given tight encoding. More...
 
static Perm tightDecode (std::istream &input)
 Reconstructs a permutation from its given tight encoding. More...
 
template<int k>
static constexpr Perm< 4 > extend (Perm< k > p)
 Extends a k-element permutation to a 4-element permutation, where 2 ≤ k < 4. More...
 
template<int k>
static constexpr Perm< 4 > contract (Perm< k > p)
 Restricts a k-element permutation to an 4-element permutation, where k > 4. 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 = 24
 The total number of permutations on four elements. More...
 
static constexpr Index nPerms_1 = 6
 The total number of permutations on three elements. More...
 
static constexpr int imageBits = 2
 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 S4Lookup Sn {}
 Gives fast array-like access to all possible permutations of four elements. More...
 
static constexpr S4Lookup S4 {}
 Gives fast array-like access to all possible permutations of four elements. More...
 
static constexpr OrderedS4Lookup orderedSn {}
 Gives fast array-like access to all possible permutations of four elements in lexicographical order. More...
 
static constexpr OrderedS4Lookup orderedS4 {}
 Gives fast array-like access to all possible permutations of four elements in lexicographical order. More...
 
static constexpr S3Lookup Sn_1 {}
 Gives fast array-like access to all possible permutations of three elements. More...
 
static constexpr S3Lookup S3 {}
 Gives fast array-like access to all possible permutations of three elements. More...
 
static constexpr OrderedS3Lookup orderedS3 {}
 Gives fast array-like access to all possible permutations of three elements in lexicographical order. More...
 
static constexpr S2Lookup S2 {}
 Gives fast 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 code_
 The internal second-generation permutation code representing this permutation. More...
 

Detailed Description

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

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 3-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. Moreover, Perm<4> in particular is extremely fast to work with.

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<4>, the internal permutation codes have changed as of Regina 4.6.1:

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<4>).

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 Perm4.

Member Typedef Documentation

◆ Code1

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

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

Although types Code1 and Code2 are identical, they are provided as separate type aliases to help communicate in your source code which type of code is being used.

◆ Code2

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

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

Although types Code1 and Code2 are identical, they are provided as separate type aliases to help communicate in your source code which type of code is being used.

◆ ImagePack

using regina::Perm< 4 >::ImagePack = uint8_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< 4 >::Index = int

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

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

Constructor & Destructor Documentation

◆ Perm() [1/7]

constexpr regina::Perm< 4 >::Perm ( )
inlineconstexpr

Creates the identity permutation.

◆ Perm() [2/7]

constexpr regina::Perm< 4 >::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}.
Parameters
athe element to switch with b.
bthe element to switch with a.

◆ Perm() [3/7]

constexpr regina::Perm< 4 >::Perm ( int  a,
int  b,
int  c,
int  d 
)
inlineconstexpr

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

Precondition
{a,b,c,d} = {0,1,2,3}.
Parameters
athe desired image of 0.
bthe desired image of 1.
cthe desired image of 2.
dthe desired image of 3.

◆ Perm() [4/7]

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

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

Precondition
The elements of image are 0, 1, 2 and 3 in some order.
Parameters
imagethe array of images.

◆ Perm() [5/7]

constexpr regina::Perm< 4 >::Perm ( int  a0,
int  a1,
int  b0,
int  b1,
int  c0,
int  c1,
int  d0,
int  d1 
)
inlineconstexpr

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

Precondition
{a0,b0,c0,d0} = {a1,b1,c1,d1} = {0,1,2,3}.
Parameters
a0the desired preimage of a1.
b0the desired preimage of b1.
c0the desired preimage of c1.
d0the desired preimage of d1.
a1the desired image of a0.
b1the desired image of b0.
c1the desired image of c0.
d1the desired image of d0.

◆ Perm() [6/7]

constexpr regina::Perm< 4 >::Perm ( const Perm< 4 > &  cloneMe)
constexprdefault

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

Parameters
cloneMethe permutation to clone.

◆ Perm() [7/7]

constexpr regina::Perm< 4 >::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
codethe second-generation code from which the new permutation will be created.

Member Function Documentation

◆ cachedComp() [1/2]

Perm< 4 > regina::Perm< 4 >::cachedComp ( const Perm< 4 > &  q) const
inline

An alias for the composition operator, provided to assist with writing generic code.

This specialised Perm<4> class does not use precomputation for its optimisations. The only point of having cachedComp() in Perm<4> is to make it easier to write generic code that works with Perm<n> for any n.

  • If you know you are only working with Perm<4>, you should just use the composition operator instead.
  • If you are writing generic code, you must remember to call precompute() at least once in the lifetime of this program before using cachedComp(). (For Perm<4>, which does not use precomputation for its optimisations, precompute() does nothing.)

The permutation that is returned is the same as you would obtain by calling (*this) * q.

Precondition
You must have called precompute() at least once in the lifetime of this program before calling cachedComp(). For Perm<4>, precompute() does nothing; however, for other Perm<n> classes a failure to do this will almost certainly crash your program.
Parameters
qthe permutation to compose this with.
Returns
the composition of both permutations.

◆ cachedComp() [2/2]

Perm< 4 > regina::Perm< 4 >::cachedComp ( const Perm< 4 > &  q,
const Perm< 4 > &  r 
) const
inline

Deprecated alias for using the composition operator twice, provided to assist with writing generic code.

The permutation that is returned is the same as you would obtain by calling (*this) * q * r.

Deprecated:
The three-way cachedComp() was originally written to support conjugation. If you are indeed conjugating, then call cachedConjugate() instead; otherwise just call the two-way cachedComp() twice.
Precondition
You must have called precompute() at least once in the lifetime of this program before calling cachedComp(). For Perm<4>, precompute() does nothing; however, for other Perm<n> classes a failure to do this will almost certainly crash your program.
Parameters
qthe first permutation to compose this with.
rthe second permutation to compose this with.
Returns
the composition of both permutations.

◆ cachedConjugate()

Perm< 4 > regina::Perm< 4 >::cachedConjugate ( const Perm< 4 > &  q) const
inline

An alias for conjugate(), provided to assist with writing generic code.

This specialised Perm<4> class does not use precomputation for its optimisations. The only point of having cachedConjugate() in Perm<4> is to make it easier to write generic code that works with Perm<n> for any n.

  • If you know you are only working with Perm<4>, you should just call conjugate() instead.
  • If you are writing generic code, you must remember to call precompute() at least once in the lifetime of this program before using cachedConjugate(). (For Perm<4>, which does not use precomputation for its optimisations, precompute() does nothing.)
Precondition
You must have called precompute() at least once in the lifetime of this program before calling cachedConjugate(). For Perm<6>, precompute() does nothing; however, for other Perm<n> classes a failure to do this will almost certainly crash your program.
Parameters
qthe permutation to conjugate this by.
Returns
the conjugate of this permutation by q.

◆ cachedInverse()

Perm< 4 > regina::Perm< 4 >::cachedInverse ( ) const
inline

An alias for inverse(), provided to assist with writing generic code.

This specialised Perm<4> class does not use precomputation for its optimisations. The only point of having cachedInverse() in Perm<4> is to make it easier to write generic code that works with Perm<n> for any n.

  • If you know you are only working with Perm<4>, you should just call inverse() instead.
  • If you are writing generic code, you must remember to call precompute() at least once in the lifetime of this program before using cachedInverse(). (For Perm<4>, which does not use precomputation for its optimisations, precompute() does nothing.)
Precondition
You must have called precompute() at least once in the lifetime of this program before calling cachedInverse(). For Perm<4>, precompute() does nothing; however, for other Perm<n> classes a failure to do this will almost certainly crash your program.
Returns
the inverse of this permutation.

◆ cachedOrder()

int regina::Perm< 4 >::cachedOrder ( ) const
inline

An alias for order(), provided to assist with writing generic code.

This specialised Perm<4> class does not use precomputation for its optimisations. The only point of having cachedOrder() in Perm<4> is to make it easier to write generic code that works with Perm<n> for any n.

  • If you know you are only working with Perm<4>, you should just call order() instead.
  • If you are writing generic code, you must remember to call precompute() at least once in the lifetime of this program before using cachedOrder(). (For Perm<4>, which does not use precomputation for its optimisations, precompute() does nothing.)
Precondition
You must have called precompute() at least once in the lifetime of this program before calling cachedOrder(). For Perm<4>, precompute() does nothing; however, for other Perm<n> classes a failure to do this will almost certainly crash your program.
Returns
the order of this permutation.

◆ cachedPow()

Perm< 4 > regina::Perm< 4 >::cachedPow ( long  exp) const
inline

An alias for pow(), provided to assist with writing generic code.

This specialised Perm<4> class does not use precomputation for its optimisations. The only point of having cachedPow() in Perm<4> is to make it easier to write generic code that works with Perm<n> for any n.

  • If you know you are only working with Perm<4>, you should just call pow() instead.
  • If you are writing generic code, you must remember to call precompute() at least once in the lifetime of this program before using cachedPow(). (For Perm<4>, which does not use precomputation for its optimisations, precompute() does nothing.)
Precondition
You must have called precompute() at least once in the lifetime of this program before calling cachedPow(). For Perm<4>, precompute() does nothing; however, for other Perm<n> classes a failure to do this will almost certainly crash your program.
Parameters
expthe exponent; this may be positive, zero or negative.
Returns
this permutation raised to the power of exp.

◆ clear()

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

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

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

Precondition
The images of from,...,3 are exactly from,...,3, but possibly in a different order.
Parameters
fromthe first integer whose image should be reset. This must be between 0 and 4 inclusive.

◆ compareWith()

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

Lexicographically compares the images of (0,1,2,3) 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
otherthe 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.

◆ conjugate()

constexpr Perm< 4 > regina::Perm< 4 >::conjugate ( const Perm< 4 > &  q) const
inlineconstexpr

Computes the conjugate of this permutation by q.

Specifically, calling p.conjugate(q) is equivalent to computing q * p * q.inverse(). The resulting permutation will have the same cycle structure as p, but with the cycle elements translated according to q.

Parameters
qthe permutation to conjugate this by.
Returns
the conjugate of this permutation by q.

◆ contract()

template<int k>
static constexpr Perm< 4 > regina::Perm< 4 >::contract ( Perm< k >  p)
staticconstexpr

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

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

Precondition
The given permutation maps 0,...,3 to 0,...,3 in some order.
Template Parameters
kthe number of elements for the input permutation; this must be strictly greater than 4.
Parameters
pa permutation on k elements.
Returns
the same permutation restricted to a permutation on 4 elements.

◆ extend()

template<int k>
static constexpr Perm< 4 > regina::Perm< 4 >::extend ( Perm< k >  p)
staticconstexpr

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

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

Template Parameters
kthe number of elements for the input permutation; this must be 2 or 3.
Parameters
pa permutation on k elements.
Returns
the same permutation expressed as a permutation on four elements.

◆ fromImagePack()

constexpr Perm< 4 > regina::Perm< 4 >::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<4>, this routine is identical to fromPermCode1().

Precondition
The argument pack is a valid image pack; see isImagePack() for details.
Parameters
packan image pack that describes a permutation.
Returns
the permutation represented by the given image pack.

◆ fromPermCode1()

constexpr Perm< 4 > regina::Perm< 4 >::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<4> now uses second-generation codes internally. See the class notes and the routine fromPermCode2() for details.
Parameters
codethe first-generation code for the new permutation.
Returns
the permutation represented by the given code.

◆ fromPermCode2()

constexpr Perm< 4 > regina::Perm< 4 >::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<4> class.

Precondition
the given code is a valid second-generation permutation code; see isPermCode2() for details.
Parameters
codethe second-generation code for the new permutation.
Returns
the permutation represented by the given code.

◆ imagePack()

constexpr Perm< 4 >::ImagePack regina::Perm< 4 >::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<4>, this routine is identical to permCode1().

Returns
the image pack for this permutation.

◆ inverse()

constexpr Perm< 4 > regina::Perm< 4 >::inverse ( ) const
inlineconstexpr

Finds the inverse of this permutation.

Returns
the inverse of this permutation.

◆ isConjugacyMinimal()

constexpr bool regina::Perm< 4 >::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<4>::Sn.

See Sn for further information on how permutations are indexed.

This routine is extremely fast for Perm<4>, 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< 4 >::isIdentity ( ) const
inlineconstexpr

Determines if this is the identity permutation.

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

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

◆ isImagePack()

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

Determines whether the given argument is the image pack of some 4-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<4>, this routine is identical to isPermCode1().

Parameters
packthe candidate image pack to test.
Returns
true if and only if pack is a valid image pack.

◆ isPermCode1()

constexpr bool regina::Perm< 4 >::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<4> now uses second-generation codes internally. See the class notes and the routine isPermCode2() for details.
Parameters
codethe 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< 4 >::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<4> class.

Parameters
codethe 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< 4 >::operator!= ( const Perm< 4 > &  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 or 3.

Parameters
otherthe permutation with which to compare this.
Returns
true if and only if this and the given permutation differ.

◆ operator*()

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

Returns the composition of this permutation with the given permutation.

If this permutation is p, the resulting permutation will be pq, and will satisfy (p*q)[x] == p[q[x]].

Parameters
qthe permutation with which to compose this.
Returns
the composition of both permutations.

◆ operator++() [1/2]

Perm< 4 > & regina::Perm< 4 >::operator++ ( )
inline

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

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

Python
Not present. 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< 4 > regina::Perm< 4 >::operator++ ( int  )
inlineconstexpr

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

If this is the last such permutation then this will wrap around to become the first permutation in Perm<4>::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< 4 >::operator< ( const Perm< 4 > &  rhs) const
inlineconstexpr

Determines if this appears earlier than the given permutation in the array Perm<4>::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
rhsthe permutation to compare this against.
Returns
true if and only if this appears before rhs in Sn.

◆ operator=()

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

Sets this permutation to be equal to the given permutation.

Parameters
cloneMethe permutation whose value will be assigned to this permutation.
Returns
a reference to this permutation.

◆ operator==()

constexpr bool regina::Perm< 4 >::operator== ( const Perm< 4 > &  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 and 3.

Parameters
otherthe permutation with which to compare this.
Returns
true if and only if this and the given permutation are equal.

◆ operator[]()

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

Determines the image of the given integer under this permutation.

Parameters
sourcethe integer whose image we wish to find. This should be between 0 and 3 inclusive.
Returns
the image of source.

◆ order()

constexpr int regina::Perm< 4 >::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.

◆ orderedS4Index()

constexpr Perm< 4 >::Index regina::Perm< 4 >::orderedS4Index ( ) const
inlineconstexpr

Returns the lexicographical index of this permutation.

This will be the index of this permutation in the Perm<4>::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<7>::orderedS7Index() 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 23 inclusive.

◆ orderedSnIndex()

constexpr Perm< 4 >::Index regina::Perm< 4 >::orderedSnIndex ( ) const
inlineconstexpr

Returns the lexicographical index of this permutation.

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

See orderedSn for further information on lexicographical ordering.

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

◆ pairs()

constexpr Perm< 6 > regina::Perm< 4 >::pairs ( ) const
inlineconstexpr

Returns the induced permutation on all six pairs of elements from 0,1,2,3.

Specifically: suppose we number the six pairs in lexicographical order, so that the pairs 01, 02, 03, 12, 13, 23 are indexed as 0, 1, 2, 3, 4, 5 respectively. Then this permutation induces a corresponding permutation of 0,...,5, where the pair (a, b) maps to the pair (p[a], p[b]). This routine returns that induced permutation.

Note that, if p permutes the four vertices (or equivalently, the four faces) of a tetrahedron, then p.pairs() is the induced permutation on the six edges of the tetrahedron.

Returns
the induced permutation on six pairs of elements.

◆ permCode1()

constexpr Perm< 4 >::Code1 regina::Perm< 4 >::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<4> 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< 4 >::Code2 regina::Perm< 4 >::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<4> class.

Returns
the second-generation permutation code.

◆ pow()

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

Computes the given power of this permutation.

This routine runs in constant time.

Parameters
expthe exponent; this may be positive, zero or negative.
Returns
this permutation raised to the power of exp.

◆ pre()

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

Determines the preimage of the given integer under this permutation.

Parameters
imagethe integer whose preimage we wish to find. This should be between 0 and 3 inclusive.
Returns
the preimage of image.

◆ precompute()

constexpr void regina::Perm< 4 >::precompute ( )
inlinestaticconstexpr

A do-nothing routine that assists with writing generic code.

This specialised Perm<4> class does not use precomputation for its optimisations, and so this precompute() function does nothing. The only point of having precompute() in Perm<4> is to make it easier to write generic code that works with Perm<n> for any n.

  • If you know you are only working with Perm<4>, you do not need to call this function at all.
  • If you are writing generic code, you must remember to call precompute() at least once in the lifetime of this program before using any of the optimised cachedXXX() functions, such as cachedComp(), cachedInverse(), and so on.

All Perm<n>::precompute() routines are thread-safe, and are harmless if called multiple times (since any call after the first will do nothing).

◆ rand() [1/2]

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

Returns a random permutation on four 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
evenif 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< 4 >::rand ( URBG &&  gen,
bool  even = false 
)
static

Returns a random permutation on four 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
URBGA type which, once any references are removed, must adhere to the C++ UniformRandomBitGenerator concept.
Python
Not present. Python users are still able to use the non-thread-safe variant without the gen argument.
Parameters
genthe source of randomness to use (e.g., one of the many options provided in the C++ standard random header).
evenif 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< 4 > regina::Perm< 4 >::reverse ( ) const
inlineconstexpr

Finds the reverse of this permutation.

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

◆ rot()

constexpr Perm< 4 > regina::Perm< 4 >::rot ( int  i)
inlinestaticconstexpr

Returns the ith rotation.

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

Parameters
ithe image of 0; this must be between 0 and 3 inclusive.
Returns
the ith rotation.

◆ S4Index()

constexpr Perm< 4 >::Index regina::Perm< 4 >::S4Index ( ) const
inlineconstexpr

Returns the index of this permutation in the Perm<4>::S4 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<7>::S7Index() 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<4>::S4[i]. This will be between 0 and 23 inclusive.

◆ setPermCode1()

void regina::Perm< 4 >::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<4> now uses second-generation codes internally. See the class notes and the routine setPermCode2() for details.
Parameters
codethe first-generation code that will determine the new value of this permutation.

◆ setPermCode2()

void regina::Perm< 4 >::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<4> class.

Precondition
the given code is a valid second-generation permutation code; see isPermCode2() for details.
Parameters
codethe second-generation code that will determine the new value of this permutation.

◆ sign()

constexpr int regina::Perm< 4 >::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< 4 >::Index regina::Perm< 4 >::SnIndex ( ) const
inlineconstexpr

Returns the index of this permutation in the Perm<4>::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<4>::Sn[i]. This will be between 0 and 23 inclusive.

◆ str()

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

Returns a string representation of this permutation.

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

Returns
a string representation of this permutation.

◆ tightDecode()

Perm< 4 > regina::Perm< 4 >::tightDecode ( std::istream &  input)
inlinestatic

Reconstructs a permutation from its given tight encoding.

See the page on tight encodings for details.

The tight encoding will be read from the given input stream. If the input stream contains leading whitespace then it will be treated as an invalid encoding (i.e., this routine will throw an exception). The input routine may contain further data: if this routine is successful then the input stream will be left positioned immediately after the encoding, without skipping any trailing whitespace.

Tight encodings are fast to work with for small permutation classes (n ≤ 7), but slower for larger permutation classes (8 ≤ n ≤ 16). See tightEncoding() for further details.

Exceptions
InvalidInputThe given input stream does not begin with a tight encoding of a 4-element permutation.
Python
Not present. Use tightDecoding() instead, which takes a string as its argument.
Parameters
inputan input stream that begins with the tight encoding for a 4-element permutation.
Returns
the permutation represented by the given tight encoding.

◆ tightDecoding()

Perm< 4 > regina::Perm< 4 >::tightDecoding ( const std::string &  enc)
inlinestatic

Reconstructs a permutation from its given tight encoding.

See the page on tight encodings for details.

The tight encoding will be given as a string. If this string contains leading whitespace or any trailing characters at all (including trailing whitespace), then it will be treated as an invalid encoding (i.e., this routine will throw an exception).

Tight encodings are fast to work with for small permutation classes (n ≤ 7), but slower for larger permutation classes (8 ≤ n ≤ 16). See tightEncoding() for further details.

Exceptions
InvalidArgumentThe given string is not a tight encoding of a 4-element permutation.
Parameters
encthe tight encoding for a 4-element permutation.
Returns
the permutation represented by the given tight encoding.

◆ tightEncode()

void regina::Perm< 4 >::tightEncode ( std::ostream &  out) const
inline

Writes the tight encoding of this permutation to the given output stream.

See the page on tight encodings for details.

For all permutation classes Perm<n>, the tight encoding is based on the index into the full permutation group S_n. For smaller permutation classes (n ≤ 7), such encodings are very fast to work with since the S_n index is used as the internal permutation code. For larger permutation classes however (8 ≤ n ≤ 16), the S_n index requires some non-trivial work to compute.

Python
Not present. Use tightEncoding() instead, which returns a string.
Parameters
outthe output stream to which the encoded string will be written.

◆ tightEncoding()

std::string regina::Perm< 4 >::tightEncoding ( ) const
inline

Returns the tight encoding of this permutation.

See the page on tight encodings for details.

For all permutation classes Perm<n>, the tight encoding is based on the index into the full permutation group S_n. For smaller permutation classes (n ≤ 7), such encodings are very fast to work with since the S_n index is used as the internal permutation code. For larger permutation classes however (8 ≤ n ≤ 16), the S_n index requires some non-trivial work to compute.

Returns
the resulting encoded string.

◆ trunc()

std::string regina::Perm< 4 >::trunc ( int  len) const

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

Parameters
lenthe length of the prefix required; this must be between 0 and 4 inclusive.
Returns
the corresponding prefix of the string representation of this permutation.

◆ trunc2()

std::string regina::Perm< 4 >::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< 4 >::trunc3 ( ) const

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

The resulting string will therefore have length three.

Returns
a truncated string representation of this permutation.

Member Data Documentation

◆ code_

Code2 regina::Perm< 4 >::code_
protected

The internal second-generation permutation code representing this permutation.

◆ codeType

constexpr PermCodeType regina::Perm< 4 >::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< 4 >::imageBits = 2
staticconstexpr

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

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

◆ imageMask

constexpr ImagePack regina::Perm< 4 >::imageMask
staticconstexpr
Initial value:
=
(static_cast<ImagePack>(1) << imageBits) - 1
uint8_t ImagePack
Indicates the native unsigned integer type used to store a single image pack.
Definition: perm4.h:131
static constexpr int imageBits
Indicates the number of bits used in an image pack to store the image of a single integer.
Definition: perm4.h:140

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< 4 >::nPerms = 24
staticconstexpr

The total number of permutations on four elements.

This is the size of the array Sn.

◆ nPerms_1

constexpr Index regina::Perm< 4 >::nPerms_1 = 6
staticconstexpr

The total number of permutations on three elements.

This is the size of the array Sn_1.

◆ orderedS3

constexpr OrderedS3Lookup regina::Perm< 4 >::orderedS3 {}
staticconstexpr

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

In each permutation, 3 maps to 3.

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.

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

This array is different from Perm<4>::S3, since orderedS3 stores permutations in lexicographical order, whereas S3 (or equivalently, Sn_1) 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).

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. This is now a lightweight object, and is defined in the headers only; in particular, you cannot make a reference to it (but you can always make a copy).

◆ orderedS4

constexpr OrderedS4Lookup regina::Perm< 4 >::orderedS4 {}
staticconstexpr

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

This is a dimension-specific alias for Perm<4>::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 OrderedS4Lookup regina::Perm< 4 >::orderedSn {}
staticconstexpr

Gives fast array-like access to all possible permutations of four 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 23 inclusive. This element access is extremely fast (a fact that is not true for the larger permutation classes Perm<n> with n ≥ 8).

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

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

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. This is now a lightweight object, and is defined in the headers only; in particular, you cannot make a reference to it (but you can always make a copy).

◆ S2

constexpr S2Lookup regina::Perm< 4 >::S2 {}
staticconstexpr

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

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

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.

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.

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. This is now a lightweight object, and is defined in the headers only; in particular, you cannot make a reference to it (but you can always make a copy).

◆ S3

constexpr S3Lookup regina::Perm< 4 >::S3 {}
staticconstexpr

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

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

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< 4 >::S4 {}
staticconstexpr

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

This is a dimension-specific alias for Perm<4>::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.

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).

◆ Sn

constexpr S4Lookup regina::Perm< 4 >::Sn {}
staticconstexpr

Gives fast array-like access to all possible permutations of four 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 23 inclusive. This element access is extremely fast (a fact that is not true for the larger permutation classes Perm<n> with n ≥ 8).

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 array is different from Perm<4>::orderedSn, since Sn alternates between even and odd permutations, whereas orderedSn stores permutations in lexicographical order.

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. This is now a lightweight object, and is defined in the headers only; in particular, you cannot make a reference to it (but you can always make a copy).

◆ Sn_1

constexpr S3Lookup regina::Perm< 4 >::Sn_1 {}
staticconstexpr

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

In each permutation, 3 maps to 3.

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 5 inclusive.

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 array is different from Perm<4>::orderedS3, since Sn_1 (or equivalently, S3) alternates between even and odd permutations, whereas orderedS3 stores permutations in lexicographical order.

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. This is now a lightweight object, and is defined in the headers only; in particular, you cannot make a reference to it (but you can always make a copy).


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

Copyright © 1999-2023, The Regina development team
This software is released under the GNU General Public License, with some additional permissions; see the source code for details.
For further information, or to submit a bug or other problem, please contact Ben Burton (bab@maths.uq.edu.au).