Skip to content

Commit afa44bb

Browse files
Remove TODOs from Doc (#61)
1 parent 3c1708e commit afa44bb

File tree

4 files changed

+13
-30
lines changed

4 files changed

+13
-30
lines changed

doc/LINS.bib

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
@phdthesis{Firth,
2+
type = {Ph.D. thesis},
3+
author = {David Firth},
4+
school = {University of Warwick},
5+
title = {An Algorithm to Find Normal Subgroups of a Finitely Presented Group, up to a Given Finite Index},
6+
year = {2005},
7+
}

doc/intro.xml

+3-2
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,9 @@ The package &LINS; provides an algorithm for computing the normal subgroups of a
1111
Moreover it provides an interface for searching in the normal subgroup lattice of a finitely presented group.
1212
For example, one can use this interface to search for <M>l</M> normal subgroups of index <M>n</M>. <P/>
1313

14-
The algorithm is based on work of Derek Holt and David Firth.
15-
They have implemented this algorithm in the algebra software MAGMA. <P/>
14+
The algorithm is based on work of David Firth <Cite Key="Firth"/>.
15+
He implemented that algorithm in the algebra software MAGMA.
16+
That implementation in MAGMA has been revised and rewritten to a great extent by Derek Holt. <P/>
1617

1718
The current implementation in &GAP; uses a table of groups that was computed by the code in <F>createTables.gi</F>.
1819

doc/lins_search.xml

+2-27
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,9 @@
11
<Chapter Label="LINS Search">
22
<Heading>LINS Search</Heading>
33

4-
This chapter is for advanced users and those interested in a brief introduction to the mathematical background of &LINS;.
4+
This chapter is for advanced users and those interested in a brief introduction to the mathematical background of &LINS;. <P/>
55

6-
<Section Label="LINS Search Strategy">
7-
<Heading>LINS Search Strategy</Heading>
8-
9-
In this section, we briefly introduce the basic search strategy for normal subgroups. <P/>
10-
11-
TODO
12-
13-
</Section>
14-
15-
<Section Label="LINS Target Tables">
16-
<Heading>LINS Target Tables</Heading>
17-
18-
TODO
19-
20-
</Section>
6+
<B>(NOTE: The internal options below might change during further development!)</B>
217

228
<Section Label="LINS Search Options">
239
<Heading>LINS Search Options</Heading>
@@ -118,15 +104,4 @@ with elementary abelian <A>p</A>-quotient in <A>rH</A> should be computed.
118104

119105
</Section>
120106

121-
<Section Label="LINS Custom Search Functions">
122-
<Heading>LINS Custom Search Functions</Heading>
123-
124-
In this section we explain how to write a custom search function by using the options for <C>LowIndexNormalSubgroupsSearch</C>. <P/>
125-
126-
We explain this on the example of <C>LowIndexNormalSubgroupsSearchForIndex</C>. <P/>
127-
128-
TODO
129-
130-
</Section>
131-
132107
</Chapter>

gap/LINS.gd

+1-1
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ DeclareAttribute( "LinsOptions", IsLinsGraph, "mutable" );
181181
## <Description>
182182
## Returns a list of all normal subgroups of <A>G</A> with index at most <A>n</A>.
183183
## If the option <A>allSubgroups</A> is set to <K>false</K>,
184-
## then onlye the normal subgroups of <A>G</A> with index equal to <A>n</A> are returned. <P/>
184+
## then only the normal subgroups of <A>G</A> with index equal to <A>n</A> are returned. <P/>
185185
##
186186
## The generic method uses <Ref BookName="Reference" Attr="IsomorphismFpGroup"/> to transform <A>G</A> into an fp-group
187187
## and then calls some variant of the low-level function <Ref Func="LowIndexNormalSubgroupsSearch"/>. <P/>

0 commit comments

Comments
 (0)