Goto Chapter: | Top | 1 | 2 | 3 | 4 | 5 | Bib | Ind

### 5. Installation and auxiliary functions

#### 5.1 Installation

Like any other GAP package, ResClasses must be installed in the `pkg` subdirectory of the GAP distribution. This is done by extracting the distribution file in this directory. By default, the package ResClasses is autoloaded, otherwise you can load it via `LoadPackage( "resclasses" );`. The ResClasses Package needs at least version 4.4 of GAP, is completely written in the GAP language and does neither contain nor require external binaries. For the documentation the package GAPDoc [LN02] is needed.

#### 5.2 Building the manual

##### 5.2-1 ResClassesBuildManual

`> ResClassesBuildManual`( ) | ( function )

Returns: Nothing.

This function builds the manual of the ResClasses package in the file formats LaTeX, DVI, Postscript, PDF, HTML and ASCII text. This is done using the GAPDoc package by Frank Lübeck and Max Neunhöffer.

#### 5.3 The testing routine

##### 5.3-1 ResClassesTest

`> ResClassesTest`( ) | ( function )

Returns: Nothing.

Performs tests of the ResClasses package. This function makes use of an adaptation of the test file `tst/testall.g` of the GAP library to this package.

#### 5.4 Changing the viewing format for residue class unions

##### 5.4-1 ResidueClassUnionViewingFormat

`> ResidueClassUnionViewingFormat`( format ) | ( function )

Returns: Nothing.

Switches between a longer and more descriptive (format = `"long"`) and a shorter and less bulky (format = `"short"`) viewing format for unions of residue classes.

The former is the default and should be used when not many residue classes have to be displayed or residue classes of different rings are used, but the latter is usually preferable if it is always clear which the base ring is and if the printed representation of many residue classes should fit on one screen.

    gap> ResidueClassUnionViewingFormat("short");
    gap> ResidueClassUnion(Integers,12,[1,4,5,7,10,11]);
    1(3) U 5(6)
    gap> ResidueClassUnionViewingFormat("long");
    gap> ResidueClassUnion(Integers,12,[1,4,5,7,10,11]);
    Union of the residue classes 1(3) and 5(6) of Z

Top of Book | Previous Chapter | Next Chapter

Goto Chapter: | Top | 1 | 2 | 3 | 4 | 5 | Bib | Ind

generated by GAPDoc2HTML