MeatAxe  2.4
Data Structures | Functions
Permutations

Detailed Description

In the MeatAxe, a permutation of degree n operates on {0,1,...,n-1} and is represented by a Perm_t structure. However, in the textual representation produced by PermPrint() or by the zpr program, the points are numbered from 1...n.

Only permutations of equal degree can be multiplied. This could cause confusion because the textual representation produced by PermPrint() does not include the degree, and fixed points are always suppressed. For example "(3 4)(5 6 7)" could be interpreted as a permutation of degree 8 or any higher degree. All these permutations are in some natural way equal to each other, but they are different and incompatible in the MeatAxe.

Permutations are usually created with PermAlloc() or read from a file with PermRead(). When a permutation is no longer used, the application must release the associated memory by calling PermFree().

Data Structures

class  Perm_t
 A Permutation. More...
 

Functions

int PermCompare (const Perm_t *a, const Perm_t *b)
 Compare two permutations. More...
 
int PermIsValid (const Perm_t *p)
 Check a permutation. More...
 
Perm_t * PermAlloc (int deg)
 Allocate a permutation This function creates a permutation of the specified degree. More...
 
int PermFree (Perm_t *p)
 Free a permutation. More...
 
Perm_t * PermDup (const Perm_t *src)
 Duplicate a permutation. More...
 
Perm_t * PermInverse (const Perm_t *src)
 Inverse of a permutation This function calulates the inverse of a permutation. More...
 
Perm_t * PermMul (Perm_t *dest, const Perm_t *src)
 Multiply permutations. More...
 
int PermOrder (const Perm_t *perm)
 Order of a permutation. More...
 
void PermPrint (const char *name, const Perm_t *perm)
 Print a permutation This function prints a permutation on the standard output using cycle notation. More...
 
Perm_t * PermPower (const Perm_t *p, int n)
 Power of a permutation This function calculates the n-th power of a permutation. More...
 
Perm_t * PermRead (FILE *f)
 Read a Permutation from a File. More...
 
Perm_t * PermLoad (const char *fn)
 Read a permutation. More...
 
int PermWrite (const Perm_t *perm, FILE *f)
 Write a Permutation to a File. More...
 
int PermSave (const Perm_t *perm, const char *fn)
 Write a Permutation to a File. More...
 

Function Documentation

◆ PermAlloc()

Perm_t* PermAlloc ( int  deg)

Allocate a permutation This function creates a permutation of the specified degree.

The new permutation is initialized to the identity.

Parameters
degDegree.
Returns
Pointer to the new permutation, or 0 on error.

◆ PermCompare()

int PermCompare ( const Perm_t *  a,
const Perm_t *  b 
)

Compare two permutations.

This function compares two permutations. If the permutations are equal, the return value is 0. Otherwise the return value is positive if a is "greater" than b, and negative if a is "less" than b. The ordering of permutations is defined as follows. If the permutations have different degrees, the permutations with the smaller degree is smaller. Otherwise, the result of the comparison is unspecified.

Note that the return value -1 does not necessarily mean that an error occured.

Parameters
aPointer to the first permutation.
bPointer to the second permutation.
Returns
0, if the matrices are equal, a nonzero value otherwise, -1 on error.

◆ PermDup()

Perm_t* PermDup ( const Perm_t *  src)

Duplicate a permutation.

This function creates a copy of an existing permutation.

Parameters
srcPointer to the permutation.
Returns
Pointer to a copy of src or 0 on error.

◆ PermFree()

int PermFree ( Perm_t *  p)

Free a permutation.

This function deletes a permutation and returns the memory to the system. Do not use SysFree() on permutations because this would only free the Perm_t structure but not the data buffer.

Parameters
pPointer to the permutation.
Returns
0 on success, -1 on error.

◆ PermInverse()

Perm_t* PermInverse ( const Perm_t *  src)

Inverse of a permutation This function calulates the inverse of a permutation.

Parameters
srcPointer to the permutation.
Returns
The inverse of src, or 0 on error.

◆ PermIsValid()

int PermIsValid ( const Perm_t *  p)

Check a permutation.

This function checks if the argument, is a pointer to a valid permutation. If the permutation is o.k., the function return 1. Otherwise, an error is signalled and, if the error handler does not terminate the program, the function returns 0.

Returns
1 if p is valid permutation, 0 otherwise.

◆ PermLoad()

Perm_t* PermLoad ( const char *  fn)

Read a permutation.

This function opens a file, reads a single permutation, and closes the file. The return value is a pointer to the permutation or 0 on error. If the file contains more than one permutation, only the first one is read. If a permutation was successfully read, the function returns a pointer to a newly created Perm_t object. The caller is responsible for deleting this object as soon as the permutation is no longer needed.

See also
PermRead()
Parameters
fnFile name.
Returns
Pointer to the permutation read from the file, or 0 on error.

◆ PermMul()

Perm_t* PermMul ( Perm_t *  dest,
const Perm_t *  src 
)

Multiply permutations.

This function multiplies dest from the right by src. Both permutations must have the same degree.

Parameters
destPointer to the first permutation.
srcPointer to the second permutation.
Returns
dest, or 0 on error.

◆ PermOrder()

int PermOrder ( const Perm_t *  perm)

Order of a permutation.

Parameters
permPointer to the permutation.
Returns
The order of 0, or -1 on error.

◆ PermPower()

Perm_t* PermPower ( const Perm_t *  p,
int  n 
)

Power of a permutation This function calculates the n-th power of a permutation.

It allocates a new permutation, leaving the original permutation intact. The caller is responsible for deleting the result when it is no longer needed.

Parameters
pPointer to the permutation.
nExponent. Must be greather than or equal to 0.
Returns
n-th power of p or 0 on error.

◆ PermPrint()

void PermPrint ( const char *  name,
const Perm_t *  perm 
)

Print a permutation This function prints a permutation on the standard output using cycle notation.

If name is not 0, the name followed by an equal sign is printed before the permutation. For example, the statement PermPrint("Perm",P); could produce the following output: 

Perm=(1 9)(2 3 6)(4 5 7)

Fixed points are always suppressed in the output.

Parameters
nameName to print before the permutation or 0.
permPointer to the permutation.
Returns
The function returns 0 on success and -1 on error.

◆ PermRead()

Perm_t* PermRead ( FILE *  f)

Read a Permutation from a File.

This function reads a permutation from a file. f must be a pointer to an open file with read permission. If a permutation was successfully read, the function returns a pointer to a newly created Perm_t object. The caller is responsible for deleting this object as soon as the permutation is no longer needed.

See also
PermLoad()
Parameters
fFile to read from.
Returns
Pointer to the permutation, or 0 on error.

◆ PermSave()

int PermSave ( const Perm_t *  perm,
const char *  fn 
)

Write a Permutation to a File.

This function creates a file, writes a single permutation to the file and closes the file. If a file with the specified name already exists, its contents are destroyed.

See also
PermWrite
Parameters
permPermutation to write.
fnFile name.
Returns
The function returns 0 on success and -1 on error.

◆ PermWrite()

int PermWrite ( const Perm_t *  perm,
FILE *  f 
)

Write a Permutation to a File.

This function writes a permutation to a file. The file must be open for writing.

See also
PermSave
Parameters
permPermutation to write.
fFile to write to.
Returns
The function returns 0 on success and -1 on error.
MeatAxe 2.4 documentation, generated on Mon Jun 7 2021 11:42:24