<!-- #################################################################### -->
<!-- ##                                                                ## -->
<!-- ##  resclaux.xml      ResClasses documentation       Stefan Kohl  ## -->
<!-- ##                                                                ## -->
<!-- ##  $Id: resclaux.xml,v 1.15 2005/02/14 11:55:22 stefan Exp $     ## -->
<!-- ##                                                                ## -->
<!-- #################################################################### -->

<Chapter Label="ch:InstallationAndAuxiliaryFunctions">
<Heading>Installation and auxiliary functions</Heading>

<!-- #################################################################### -->

<Section Label="sec:Installation">
<Heading>Installation</Heading>

Like any other &GAP; package, &ResClasses; must be installed in the
<F>pkg</F> 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
<C>LoadPackage( "resclasses" );</C>.

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; <Cite Key="GAPDoc"/> is needed.

</Section>

<!-- #################################################################### -->

<Section Label="sec:BuildingTheManual">
<Heading>Building the manual</Heading>

<ManSection>
  <Func Name="ResClassesBuildManual" Arg=""/>
  <Returns> Nothing. </Returns>
  <Description>
    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.
  </Description>
</ManSection>

</Section>

<!-- #################################################################### -->

<Section Label="sec:TheTestingRoutine">
<Heading>The testing routine</Heading>

<ManSection>
  <Func Name="ResClassesTest" Arg=""/>
  <Returns> Nothing. </Returns>
  <Description>
    Performs tests of the &ResClasses; package.
    This function makes use of an adaptation of the test file
    <F>tst/testall.g</F> of the &GAP; library to this package.
  </Description>
</ManSection>

</Section>

<!-- #################################################################### -->

<Section Label="sec:ChangingTheClassUnionViewingFormat">
<Heading>Changing the viewing format for residue class unions</Heading>

<ManSection>
  <Func Name="ResidueClassUnionViewingFormat" Arg="format" Label="format"/>
  <Returns> Nothing. </Returns>
  <Description>
    Switches between a longer and more descriptive (<A>format</A> =
    <C>"long"</C>) and a shorter and less bulky (<A>format</A> =
    <C>"short"</C>) viewing format for unions of residue classes. <P/>

    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.
<Example>
<![CDATA[
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
]]>
</Example>
  </Description>
</ManSection>

<Alt Only="HTML">&nbsp;</Alt>

</Section>

<!-- #################################################################### -->

</Chapter>

<!-- #################################################################### -->
