Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove TODOs from Doc #61

Merged
merged 3 commits into from
Mar 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions doc/LINS.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
@phdthesis{Firth,
type = {Ph.D. thesis},
author = {David Firth},
school = {University of Warwick},
title = {An Algorithm to Find Normal Subgroups of a Finitely Presented Group, up to a Given Finite Index},
year = {2005},
}
5 changes: 3 additions & 2 deletions doc/intro.xml
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,9 @@ The package &LINS; provides an algorithm for computing the normal subgroups of a
Moreover it provides an interface for searching in the normal subgroup lattice of a finitely presented group.
For example, one can use this interface to search for <M>l</M> normal subgroups of index <M>n</M>. <P/>

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

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

Expand Down
29 changes: 2 additions & 27 deletions doc/lins_search.xml
Original file line number Diff line number Diff line change
@@ -1,23 +1,9 @@
<Chapter Label="LINS Search">
<Heading>LINS Search</Heading>

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

<Section Label="LINS Search Strategy">
<Heading>LINS Search Strategy</Heading>

In this section, we briefly introduce the basic search strategy for normal subgroups. <P/>

TODO

</Section>

<Section Label="LINS Target Tables">
<Heading>LINS Target Tables</Heading>

TODO

</Section>
<B>(NOTE: The internal options below might change during further development!)</B>

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

</Section>

<Section Label="LINS Custom Search Functions">
<Heading>LINS Custom Search Functions</Heading>

In this section we explain how to write a custom search function by using the options for <C>LowIndexNormalSubgroupsSearch</C>. <P/>

We explain this on the example of <C>LowIndexNormalSubgroupsSearchForIndex</C>. <P/>

TODO

</Section>

</Chapter>
2 changes: 1 addition & 1 deletion gap/LINS.gd
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ DeclareAttribute( "LinsOptions", IsLinsGraph, "mutable" );
## <Description>
## Returns a list of all normal subgroups of <A>G</A> with index at most <A>n</A>.
## If the option <A>allSubgroups</A> is set to <K>false</K>,
## then onlye the normal subgroups of <A>G</A> with index equal to <A>n</A> are returned. <P/>
## then only the normal subgroups of <A>G</A> with index equal to <A>n</A> are returned. <P/>
##
## The generic method uses <Ref BookName="Reference" Attr="IsomorphismFpGroup"/> to transform <A>G</A> into an fp-group
## and then calls some variant of the low-level function <Ref Func="LowIndexNormalSubgroupsSearch"/>. <P/>
Expand Down
Loading