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.

Sign up for GitHub

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

Jump to bottom

rearranged section 5.4 of the manual #36

Merged
merged 1 commit into from
Mar 21, 2024
Merged

rearranged section 5.4 of the manual #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
69 changes: 33 additions & 36 deletions doc/nmo.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@
<Section Label="sec-nmo-intro">
<Heading>Introduction</Heading>

Up until September 2023 the <Package>NMO</Package> manual was provided by
Up until September 2023 the manual for Randall Cone's package
<Package>NMO</Package> was provided by
<Package>GBNP</Package> as a separate <File>manual.pdf</File>.
The <Package>NMO</Package> manual now forms this chapter
in the <Package>GBNP</Package> manual.
Expand Down Expand Up @@ -421,13 +422,12 @@ gap> NP2GPList( gb4, A4 );
</Section>


<Section><Heading>Orderings</Heading>
This section describes the current orderings built into the <Package>GAP</Package>
package <Package>NMO</Package>, and describes some of the internals of the
machinery involved.
<Section><Heading>Orderings - Internals</Heading>
This section, and the following two, describe the current orderings
built into the <Package>GAP</Package> package <Package>NMO</Package>,
and describes some of the internals of the machinery involved.
<P/>

<Subsection><Heading>Internals</Heading>
The orderings portion of <Package>NMO</Package> is divided codewise into the files
<C>ncordmachine.gd, ncordmachine.gi</C> and <C>ncorderings.gd, ncorderings.gi</C>.
The former file pair contains code to set up the machinery to
Expand Down Expand Up @@ -491,47 +491,44 @@ it is utilized in the creation of the ordering:
gap> lexord2 := NCMonomialLeftLexicographicOrdering(A,[2,3,1]);
NCMonomialLeftLexicographicOrdering([ (1)*b, (1)*c, (1)*a ])
</Example>
</Subsection>

<#Include Label="InstallNoncommutativeMonomialOrdering">
<#Include Label="IsNoncommutativeMonomialOrdering">
<#Include Label="LtFunctionListRep">
<#Include Label="NextOrdering">
<#Include Label="ParentAlgebra">
<#Include Label="LexicographicTable">
<#Include Label="LexicographicIndexTable">
<#Include Label="LexicographicPermutation">
<#Include Label="AuxilliaryTable">
<#Include Label="OrderingLtGtFunctions">
</Section>

<ManSection><Heading>Internal Routines</Heading>
<#Include Label="InstallNoncommutativeMonomialOrdering">
<#Include Label="IsNoncommutativeMonomialOrdering">
<#Include Label="LtFunctionListRep">
<#Include Label="NextOrdering">
<#Include Label="ParentAlgebra">
<#Include Label="LexicographicTable">
<#Include Label="LexicographicIndexTable">
<#Include Label="LexicographicPermutation">
<#Include Label="AuxilliaryTable">
<#Include Label="OrderingLtGtFunctions">
</ManSection>

<ManSection><Heading>Provided Orderings</Heading>
<#Include Label="NCMonomialLeftLengthLexicographicOrdering">
<#Include Label="NCMonomialLengthOrdering">
<#Include Label="NCMonomialLeftLexicographicOrdering">
<#Include Label="NCMonomialCommutativeLexicographicOrdering">
<#Include Label="NCMonomialWeightOrdering">
</ManSection>
<Section><Heading>Provided Orderings</Heading>
<#Include Label="NCMonomialLeftLengthLexicographicOrdering">
<#Include Label="NCMonomialLengthOrdering">
<#Include Label="NCMonomialLeftLexicographicOrdering">
<#Include Label="NCMonomialCommutativeLexicographicOrdering">
<#Include Label="NCMonomialWeightOrdering">
</Section>

<Subsection><Heading>Externals</Heading>

<Section><Heading>Orderings - Externals</Heading>

All user-level interface routines in the descriptions following
allow for the comparison
of not only monomials from a given algebra with respect to a given ordering, but
allow for the comparisonof not only monomials from a given algebra
with respect to a given ordering, but
also compare general elements from an algebra by comparing their
leading terms (again, with respect to the given ordering).
These routines are located in the files
<C>ncinterface.gd</C> and <C>ncinterface.gi</C>.
</Subsection>
<P/>

<ManSection><Heading>External Routines</Heading>
<#Include Label="NCLessThanByOrdering">
<#Include Label="NCGreaterThanByOrdering">
<#Include Label="NCEquivalentByOrdering">
<#Include Label="NCSortNP">
</ManSection>
<#Include Label="NCLessThanByOrdering">
<#Include Label="NCGreaterThanByOrdering">
<#Include Label="NCEquivalentByOrdering">
<#Include Label="NCSortNP">

<Subsection><Heading>Flexibility vs. Efficiency</Heading>
We recall that <C>InstallNoncommutativeMonomialOrdering</C> completes
Expand Down
12 changes: 8 additions & 4 deletions lib/nmo/ncinterface.gd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
#############################################################################
##
## <#GAPDoc Label="NCLessThanByOrdering">
## <ManSection>
## <Oper Name="NCLessThanByOrdering"
## Arg="&lt;NoncommutativeMonomialOrdering>, &lt;a>, &lt;b>"/>
##
Expand All @@ -24,7 +25,7 @@
## determined by <C>&lt;NoncommutativeMonomialOrdering></C>.
## <P/>
## </Description>
##
## </ManSection>
## <#/GAPDoc>
##
DeclareOperation("NCLessThanByOrdering",
Expand All @@ -37,6 +38,7 @@ DeclareOperation("NCLessThanByOrdering",
#############################################################################
##
## <#GAPDoc Label="NCGreaterThanByOrdering">
## <ManSection>
## <Oper Name="NCGreaterThanByOrdering"
## Arg="&lt;NoncommutativeMonomialOrdering>, &lt;a>, &lt;b>"/>
##
Expand All @@ -49,7 +51,7 @@ DeclareOperation("NCLessThanByOrdering",
## <P/>
## <P/>
## </Description>
##
## </ManSection>
## <#/GAPDoc>
##
DeclareOperation("NCGreaterThanByOrdering",
Expand All @@ -61,6 +63,7 @@ DeclareOperation("NCGreaterThanByOrdering",
#############################################################################
##
## <#GAPDoc Label="NCEquivalentByOrdering">
## <ManSection>
## <Oper Name="NCEquivalentByOrdering"
## Arg="&lt;NoncommutativeMonomialOrdering>, &lt;a>, &lt;b>"/>
##
Expand Down Expand Up @@ -113,7 +116,7 @@ DeclareOperation("NCGreaterThanByOrdering",
## <P/>
##
## </Description>
##
## </ManSection>
## <#/GAPDoc>
##
DeclareOperation("NCEquivalentByOrdering",
Expand All @@ -126,6 +129,7 @@ DeclareOperation("NCEquivalentByOrdering",
#############################################################################
##
## <#GAPDoc Label="NCSortNP">
## <ManSection>
## <Oper Name="NCSortNP"
## Arg="&lt;NoncommutativeMonomialOrdering>, &lt;list>, &lt;function>"/>
##
Expand All @@ -139,7 +143,7 @@ DeclareOperation("NCEquivalentByOrdering",
## from <Cite Key="gN02"/>.
## <P/>
## </Description>
##
## </ManSection>
## <#/GAPDoc>
##
DeclareOperation("NCSortNP",
Expand Down
15 changes: 10 additions & 5 deletions lib/nmo/ncorderings.gd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
#############################################################################
##
## <#GAPDoc Label="NCMonomialLeftLengthLexicographicOrdering">
## <ManSection>
## <Func Name="NCMonomialLeftLengthLexicographicOrdering"
## Arg="&lt;algebra>, &lt;list>"/>
##
Expand All @@ -27,7 +28,7 @@
## Note: the synonym <C>NCMonomialLeftLengthLexOrdering</C> may also be used.
## <P/>
## </Description>
##
## </ManSection>
## <#/GAPDoc>
##
DeclareGlobalFunction("NCMonomialLeftLengthLexicographicOrdering");
Expand All @@ -38,6 +39,7 @@ DeclareSynonym("NCMonomialLeftLengthLexOrdering",
#############################################################################
##
## <#GAPDoc Label="NCMonomialLengthOrdering">
## <ManSection>
## <Func Name="NCMonomialLengthOrdering"
## Arg="&lt;algebra>"/>
##
Expand All @@ -48,7 +50,7 @@ DeclareSynonym("NCMonomialLeftLengthLexOrdering",
## are compared using this ordering.
## <P/>
## </Description>
##
## </ManSection>
## <#/GAPDoc>
##
DeclareGlobalFunction("NCMonomialLengthOrdering");
Expand All @@ -57,6 +59,7 @@ DeclareGlobalFunction("NCMonomialLengthOrdering");
#############################################################################
##
## <#GAPDoc Label="NCMonomialLeftLexicographicOrdering">
## <ManSection>
## <Func Name="NCMonomialLeftLexicographicOrdering"
## Arg="&lt;algebra>, &lt;list>"/>
##
Expand All @@ -67,7 +70,7 @@ DeclareGlobalFunction("NCMonomialLengthOrdering");
## left-lexicographic ordering object.
## <P/>
## </Description>
##
## </ManSection>
## <#/GAPDoc>
##
DeclareGlobalFunction("NCMonomialLeftLexicographicOrdering");
Expand All @@ -76,6 +79,7 @@ DeclareGlobalFunction("NCMonomialLeftLexicographicOrdering");
#############################################################################
##
## <#GAPDoc Label="NCMonomialCommutativeLexicographicOrdering">
## <ManSection>
## <Func Name="NCMonomialCommutativeLexicographicOrdering"
## Arg="&lt;algebra>, &lt;list>"/>
##
Expand All @@ -88,7 +92,7 @@ DeclareGlobalFunction("NCMonomialLeftLexicographicOrdering");
## using their respective commutative analogues.
## <P/>
## </Description>
##
## </ManSection>
## <#/GAPDoc>
##
DeclareGlobalFunction("NCMonomialCommutativeLexicographicOrdering");
Expand All @@ -97,6 +101,7 @@ DeclareGlobalFunction("NCMonomialCommutativeLexicographicOrdering");
#############################################################################
##
## <#GAPDoc Label="NCMonomialWeightOrdering">
## <ManSection>
## <Func Name="NCMonomialWeightOrdering"
## Arg="&lt;algebra>, &lt;list>, &lt;list2>"/>
##
Expand All @@ -108,7 +113,7 @@ DeclareGlobalFunction("NCMonomialCommutativeLexicographicOrdering");
## weight ordering object.
## <P/>
## </Description>
##
## </ManSection>
## <#/GAPDoc>
##
DeclareGlobalFunction("NCMonomialWeightOrdering");
Expand Down
Loading
Loading