Skip to content

Commit

Permalink
Make documentation compile.
Browse files Browse the repository at this point in the history
Change setup for St Andrews.


git-svn-id: svn://helios.math.rwth-aachen.de/home2/thuban/svnuser/orb/trunk/orb@149 84b55aed-c907-0410-b598-ae02b0970699
  • Loading branch information
neunhoef committed Oct 31, 2007
1 parent 4ac16e2 commit fe3efbd
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 20 deletions.
2 changes: 1 addition & 1 deletion CHANGES
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
They will reappear in GAP >= 4.5.
- New method for finding transversals in matrix groups.
- Use "Rattle" in product replacers (can be switched off)
- Release revision 148 as version 1.5, which is intended to be
- Release revision 149 as version 1.5, which is intended to be
a preliminary version without proper documentation.


Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ clean:
archive: doc
(cd .. ; tar czvf orb-`cat orb/VERSION`.tar.gz --exclude ".svn" --exclude test orb)

WEBPOS=/home/antares/neunhoef/mywebpage/Computer/Software/Gap/orb
WEBPOS=/scratch/neunhoef/mywebpage.pub/Computer/Software/Gap/orb

towww: archive
echo '<?xml version="1.0" encoding="ISO-8859-1"?>' >${WEBPOS}.version
Expand Down
26 changes: 14 additions & 12 deletions doc/bysuborbit.xml
Original file line number Diff line number Diff line change
Expand Up @@ -84,16 +84,17 @@ examples in Chapter <Ref Chap="examples"/>.
after enumerating at least half of it.
<P/>
The result is an <Q>orbit-by-suborbit</Q> object. For such an object
in particular the operations <Ref Meth="Size"/>, <Ref Oper="Seed"/>,
in particular the operations <Ref Meth="Size" Label="fororb"/>,
<Ref Oper="Seed"/>,
<Ref Oper="SuborbitsDb"/>,
<Ref Oper="WordsToSuborbits"/>, <Ref Oper="Memory"/>,
<Ref Oper="WordsToSuborbits"/>, <Ref Oper="Memory" Label="forob"/>,
<Ref Meth="Stabilizer" Label="obso"/>, and
<Ref Oper="Seed"/> are defined, see below.
</Description>
</ManSection>

<ManSection>
<Meth Name="Size" Arg="orb"/>
<Meth Name="Size" Arg="orb" Label="fororb"/>
<Returns> an integer </Returns>
<Description>
Returns the number of points in the orbit-by-suborbit <A>orb</A>.
Expand All @@ -117,7 +118,8 @@ the <M>U_i</M>-minimalisation of the starting point given to
Returns the data base of suborbits of the orbit-by-suborbit object
<A>orb</A>. In particular, such a database object has methods
for the operations
<Ref Oper="Memory"/>, <Ref Oper="TotalLength"/>, and
<Ref Oper="Memory" Label="forob"/>, <Ref Oper="TotalLength"
Label="fordb"/>, and
<Ref Oper="Representatives"/>. For descriptions see below.
</Description>
</ManSection>
Expand All @@ -141,7 +143,7 @@ relative to this new starting point.
</ManSection>

<ManSection>
<Oper Name="Memory" Arg="ob"/>
<Oper Name="Memory" Arg="ob" Label="forob"/>
<Returns> an integer </Returns>
<Description>
Returns the amount of memory needed by the object <A>ob</A>, which can
Expand Down Expand Up @@ -183,7 +185,7 @@ starting point.
</ManSection>

<ManSection>
<Oper Name="SavingFactor" Arg="orb"/>
<Oper Name="SavingFactor" Arg="orb" Label="fororb"/>
<Returns> an integer </Returns>
<Description>
Returns the quotient of the total number of points stored in the
Expand All @@ -196,7 +198,7 @@ here!
The following operations apply to orbit-by-suborbit database objects:

<ManSection>
<Oper Name="TotalLength" Arg="db"/>
<Oper Name="TotalLength" Arg="db" Label="fordb"/>
<Returns> an integer </Returns>
<Description>
Returns the total number of points stored in all suborbits in the
Expand All @@ -214,7 +216,7 @@ orbit-by-suborbit database <A>db</A>.
</ManSection>

<ManSection>
<Oper Name="SavingFactor" Arg="db"/>
<Oper Name="SavingFactor" Arg="db" Label="fordb"/>
<Returns> an integer </Returns>
<Description>
Returns the quotient of the total number of points stored in the
Expand Down Expand Up @@ -541,7 +543,7 @@ writes out, which orbits are in fact identical.
</ManSection>

<ManSection>
<Oper Name="Memory" Arg="obsol"/>
<Oper Name="Memory" Arg="obsol" Label="forobsol"/>
<Returns> an integer </Returns>
<Description>
Returns the total memory used for all orbit-by-suborbits in the
Expand All @@ -551,7 +553,7 @@ writes out, which orbits are in fact identical.
</ManSection>

<ManSection>
<Oper Name="TotalLength" Arg="obsol"/>
<Oper Name="TotalLength" Arg="obsol" Label="forobsol"/>
<Returns> an integer </Returns>
<Description>
Returns the total number of points stored in all orbit-by-suborbits in the
Expand All @@ -560,15 +562,15 @@ orbit-by-suborbit-list <A>obsol</A>.
</ManSection>

<ManSection>
<Meth Name="Size" Arg="obsol"/>
<Meth Name="Size" Arg="obsol" Label="forobsol"/>
<Returns> an integer </Returns>
<Description>
Returns the total number of points in the orbit-by-suborbit-list <A>obsol</A>.
</Description>
</ManSection>

<ManSection>
<Oper Name="SavingFactor" Arg="obsol"/>
<Oper Name="SavingFactor" Arg="obsol" Label="forobsol"/>
<Returns> an integer </Returns>
<Description>
Returns the quotient of the total number of points stored in all
Expand Down
5 changes: 4 additions & 1 deletion doc/orb.bib
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
@article{MNW,
AUTHOR = {J{\"u}rgen M{\"u}ller and Max Neunh{\"o}ffer and Robert A. Wilson},
TITLE = {Enumerating big orbits and an application: ${B}$ acting on the cosets of ${F}i_{23}$},
YEAR = 2006
YEAR = 2007,
JOURNAL = {Journal of Algebra},
NUMBER = 1,
PAGES = {75--96}
}
11 changes: 6 additions & 5 deletions doc/random.xml
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,13 @@ in the same &GAP; job. These ideas have led to the following abstraction.
<Description>
Objects in this category are <Q>random sources</Q> in the sense that
they can produce random numbers using methods for the operation
<Ref Meth="Random"/>.
<Ref Meth="Random" Label="3arg"/>.
</Description>
</ManSection>

<ManSection>
<Meth Name="Random" Arg="rs, from, to"/>
<Meth Name="Random" Arg="rs, list"/>
<Meth Name="Random" Arg="rs, from, to" Label="3arg"/>
<Meth Name="Random" Arg="rs, list" Label="2arg"/>
<Returns> an integer </Returns>
<Description>
<A>rs</A> must be an object in the category <Ref Filt="IsRandomSource"/>
Expand Down Expand Up @@ -73,7 +73,8 @@ installed by installing a method for this operation <Ref Oper="RandomSource"/>,
testing for the string value and calling <C>TryNextMethod()</C> if
the string is not equal to the type description of the new method.
Usually one should create a new representation for the new random
source and provide methods for the operations <Ref Meth="Random"/>
source and provide methods for the operations <Ref Meth="Random"
Label="3arg"/>
above.
</Description>
</ManSection>
Expand All @@ -84,7 +85,7 @@ above.
<Description>
Resets the random source <A>rs</A> if possible. That is, it will produce
the same sequence of random numbers as before when called with the
same sequence of <Ref Meth="Random"/> calls. Note that there might
same sequence of <Ref Meth="Random" Label="3arg"/> calls. Note that there might
be types of random sources that do not support resetting like for
example the <Q>real</Q> random sources.
</Description>
Expand Down

0 comments on commit fe3efbd

Please sign in to comment.