Skip to content

Commit

Permalink
Improve and unify names
Browse files Browse the repository at this point in the history
RecognitionInfoFamily -> RecogNodeFamily
IsRecognitionInfo -> IsRecogNode
RIFac -> ImageRecogNode
RIKer -> KernelRecogNode
  • Loading branch information
ssiccha committed Apr 9, 2021
1 parent 1b08a64 commit def623d
Show file tree
Hide file tree
Showing 18 changed files with 301 additions and 277 deletions.
10 changes: 5 additions & 5 deletions doc/recognition.xml
Original file line number Diff line number Diff line change
Expand Up @@ -195,19 +195,19 @@ A recognition info record is a ⪆ component object. It is a member
of the family

<ManSection>
<Fam Name="RecognitionInfoFamily"/>
<Fam Name="RecogNodeFamily"/>
</ManSection>

and is in the category

<ManSection>
<Filt Name="IsRecognitionInfo" Type="Category"/>
<Filt Name="IsRecogNode" Type="Category"/>
</ManSection>

and is <Ref Filt="IsAttributeStoringRep" BookName="Ref"/>, such that we can
define attributes for it, the values of which are stored once they are
known. A recognition info record always represents a whole binary tree of such
records, see the attributes <Ref Attr="RIFac"/> and <Ref Attr="RIKer"/>
records, see the attributes <Ref Attr="ImageRecogNode"/> and <Ref Attr="KernelRecogNode"/>
below. <P/>

The following filters are defined for recognition info records:
Expand All @@ -221,8 +221,8 @@ The following attributes are defined for recognition info records:
<#Include Label="Homom">
<#Include Label="NiceGens">
<#Include Label="pregensfac">
<#Include Label="RIFac">
<#Include Label="RIKer">
<#Include Label="ImageRecogNode">
<#Include Label="KernelRecogNode">
<#Include Label="RIParent">
<#Include Label="fhmethsel">
<#Include Label="slpforelement">
Expand Down
4 changes: 4 additions & 0 deletions doc/renaming_index.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<Index Key="RecognitionInfoFamily"><C>RecognitionInfoFamily</C></Index>
<Index Key="IsRecognitionInfo"><C>IsRecognitionInfo</C></Index>
<Index Key="RIFac"><C>RIFac</C></Index>
<Index Key="RIKer"><C>RIKer</C></Index>
22 changes: 21 additions & 1 deletion doc/renaming_table.xml
Original file line number Diff line number Diff line change
@@ -1,9 +1,29 @@
<Table Align="|l|l|">
<Caption> renaming of functions</Caption>
<Caption> Renaming</Caption>
<HorLine/>
<Row>
<Item> <E>Old Name</E> </Item>
<Item> <E>New Name</E> </Item>
</Row>
<HorLine/>
<Row>
<Item> <C>RecognitionInfoFamily</C> </Item>
<Item> <Ref Fam="RecogNodeFamily"/> </Item>
</Row>
<HorLine/>
<Row>
<Item> <C>IsRecognitionInfo</C> </Item>
<Item> <Ref Filt="IsRecogNode"/> </Item>
</Row>
<HorLine/>
<Row>
<Item> <C>RIFac</C> </Item>
<Item> <Ref Attr="ImageRecogNode"/> </Item>
</Row>
<HorLine/>
<Row>
<Item> <C>RIKer</C> </Item>
<Item> <Ref Attr="KernelRecogNode"/> </Item>
</Row>
<HorLine/>
</Table>
84 changes: 42 additions & 42 deletions gap/base/recognition.gd
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@
#############################################################################

# The category:
DeclareCategory( "IsRecognitionInfo", IsObject );
DeclareCategory( "IsRecogNode", IsObject );
# The family:
BindGlobal( "RecognitionInfoFamily",
NewFamily("RecognitionInfoFamily", IsRecognitionInfo));
BindGlobal( "RecogNodeFamily",
NewFamily("RecogNodeFamily", IsRecogNode));
# The type:
BindGlobal( "RecognitionInfoType",
NewType(RecognitionInfoFamily, IsRecognitionInfo and IsAttributeStoringRep));
NewType(RecogNodeFamily, IsRecogNode and IsAttributeStoringRep));


# The info class:
Expand All @@ -45,7 +45,7 @@ BindGlobal( "RECOG", rec() );
## <Description>
## This flag indicates, whether or not a recognition info record represents a leaf
## in the recognition tree. If it is not set, one finds at least one of
## the attributes <Ref Attr="RIFac"/> and <Ref Attr="RIKer"/> set for
## the attributes <Ref Attr="ImageRecogNode"/> and <Ref Attr="KernelRecogNode"/> set for
## the corresponding node. This flag is normally reset and has to be set
## by a find homomorphism method to indicate a leaf.
## </Description>
Expand Down Expand Up @@ -80,7 +80,7 @@ DeclareFilter( "IsReady" );
## </Description>
## </ManSection>
## <#/GAPDoc>
DeclareAttribute( "Grp", IsRecognitionInfo, "mutable" );
DeclareAttribute( "Grp", IsRecogNode, "mutable" );

## <#GAPDoc Label="Homom">
## <ManSection>
Expand All @@ -94,7 +94,7 @@ DeclareAttribute( "Grp", IsRecognitionInfo, "mutable" );
## </Description>
## </ManSection>
## <#/GAPDoc>
DeclareAttribute( "Homom", IsRecognitionInfo, "mutable" );
DeclareAttribute( "Homom", IsRecogNode, "mutable" );

## <#GAPDoc Label="NiceGens">
## <ManSection>
Expand All @@ -119,11 +119,11 @@ DeclareAttribute( "Homom", IsRecognitionInfo, "mutable" );
## </Description>
## </ManSection>
## <#/GAPDoc>
DeclareAttribute( "NiceGens", IsRecognitionInfo, "mutable" );
DeclareAttribute( "NiceGens", IsRecogNode, "mutable" );

## <#GAPDoc Label="RIFac">
## <#GAPDoc Label="ImageRecogNode">
## <ManSection>
## <Attr Name="RIFac" Arg="ri"/>
## <Attr Name="ImageRecogNode" Arg="ri"/>
## <Description>
## The value of this attribute is the recognition info record of the
## image of the homomorphism that was found from the group described by
Expand All @@ -135,11 +135,11 @@ DeclareAttribute( "NiceGens", IsRecognitionInfo, "mutable" );
## </Description>
## </ManSection>
## <#/GAPDoc>
DeclareAttribute( "RIFac", IsRecognitionInfo, "mutable" );
DeclareAttribute( "ImageRecogNode", IsRecogNode, "mutable" );

## <#GAPDoc Label="RIKer">
## <#GAPDoc Label="KernelRecogNode">
## <ManSection>
## <Attr Name="RIKer" Arg="ri"/>
## <Attr Name="KernelRecogNode" Arg="ri"/>
## <Description>
## The value of this attribute is the recognition info record of the
## kernel of the homomorphism that was found from the group described by
Expand All @@ -153,7 +153,7 @@ DeclareAttribute( "RIFac", IsRecognitionInfo, "mutable" );
## </Description>
## </ManSection>
## <#/GAPDoc>
DeclareAttribute( "RIKer", IsRecognitionInfo, "mutable" );
DeclareAttribute( "KernelRecogNode", IsRecogNode, "mutable" );

## <#GAPDoc Label="RIParent">
## <ManSection>
Expand All @@ -165,7 +165,7 @@ DeclareAttribute( "RIKer", IsRecognitionInfo, "mutable" );
## </Description>
## </ManSection>
## <#/GAPDoc>
DeclareAttribute( "RIParent", IsRecognitionInfo, "mutable" );
DeclareAttribute( "RIParent", IsRecogNode, "mutable" );

## <#GAPDoc Label="StdPresentation">
## <ManSection>
Expand All @@ -176,10 +176,10 @@ DeclareAttribute( "RIParent", IsRecognitionInfo, "mutable" );
## </Description>
## </ManSection>
## <#/GAPDoc>
DeclareAttribute( "StdPresentation", IsRecognitionInfo, "mutable" ); # TODO: implement
DeclareAttribute( "StdPresentation", IsRecogNode, "mutable" ); # TODO: implement

DeclareProperty( "IsRecogInfoForSimpleGroup", IsRecognitionInfo );
DeclareProperty( "IsRecogInfoForAlmostSimpleGroup", IsRecognitionInfo );
DeclareProperty( "IsRecogInfoForSimpleGroup", IsRecogNode );
DeclareProperty( "IsRecogInfoForAlmostSimpleGroup", IsRecogNode );
InstallTrueMethod( IsRecogInfoForAlmostSimpleGroup, IsRecogInfoForSimpleGroup );

## <#GAPDoc Label="pregensfac">
Expand All @@ -195,8 +195,8 @@ InstallTrueMethod( IsRecogInfoForAlmostSimpleGroup, IsRecogInfoForSimpleGroup );
## </Description>
## </ManSection>
## <#/GAPDoc>
DeclareAttribute( "pregensfac", IsRecognitionInfo, "mutable" );
DeclareAttribute( "validatehomominput", IsRecognitionInfo);
DeclareAttribute( "pregensfac", IsRecogNode, "mutable" );
DeclareAttribute( "validatehomominput", IsRecogNode);

## <#GAPDoc Label="calcnicegens">
## <ManSection>
Expand All @@ -220,7 +220,7 @@ DeclareAttribute( "validatehomominput", IsRecognitionInfo);
## </Description>
## </ManSection>
## <#/GAPDoc>
DeclareAttribute( "calcnicegens", IsRecognitionInfo, "mutable" );
DeclareAttribute( "calcnicegens", IsRecogNode, "mutable" );

## <#GAPDoc Label="slptonice">
## <ManSection>
Expand All @@ -234,7 +234,7 @@ DeclareAttribute( "calcnicegens", IsRecognitionInfo, "mutable" );
## </Description>
## </ManSection>
## <#/GAPDoc>
DeclareAttribute( "slptonice", IsRecognitionInfo, "mutable" );
DeclareAttribute( "slptonice", IsRecogNode, "mutable" );

## <#GAPDoc Label="fhmethsel">
## <ManSection>
Expand All @@ -248,7 +248,7 @@ DeclareAttribute( "slptonice", IsRecognitionInfo, "mutable" );
## </Description>
## </ManSection>
## <#/GAPDoc>
DeclareAttribute( "fhmethsel", IsRecognitionInfo, "mutable" ); # TODO: rename?
DeclareAttribute( "fhmethsel", IsRecogNode, "mutable" ); # TODO: rename?

## <#GAPDoc Label="methodsforfactor">
## <ManSection>
Expand All @@ -268,7 +268,7 @@ DeclareAttribute( "fhmethsel", IsRecognitionInfo, "mutable" ); # TODO: rena
## </Description>
## </ManSection>
## <#/GAPDoc>
DeclareAttribute( "methodsforfactor", IsRecognitionInfo, "mutable" ); # rename to MethodsDBForFactor
DeclareAttribute( "methodsforfactor", IsRecogNode, "mutable" ); # rename to MethodsDBForFactor

## <#GAPDoc Label="slpforelement">
## <ManSection>
Expand All @@ -291,28 +291,28 @@ DeclareAttribute( "methodsforfactor", IsRecognitionInfo, "mutable" ); # rename t
## </Description>
## </ManSection>
## <#/GAPDoc>
DeclareAttribute( "slpforelement", IsRecognitionInfo, "mutable" );
DeclareAttribute( "slpforelement", IsRecogNode, "mutable" );
# Here we collect generators of the kernel:
DeclareAttribute( "gensN", IsRecognitionInfo, "mutable" ); # TODO: rename?
DeclareAttribute( "gensN", IsRecogNode, "mutable" ); # TODO: rename?
# The following holds a method, described by a record, to find generators
# of the kernel:
DeclareAttribute( "findgensNmeth", IsRecognitionInfo, "mutable" );
DeclareAttribute( "findgensNmeth", IsRecogNode, "mutable" );
# Here is one slp to make all the gensN:
DeclareAttribute( "gensNslp", IsRecognitionInfo, "mutable" );
DeclareAttribute( "gensNslp", IsRecogNode, "mutable" );
# Do we have to do an immediate verification of the kernel?
DeclareAttribute( "immediateverification", IsRecognitionInfo, "mutable" );
DeclareAttribute( "immediateverification", IsRecogNode, "mutable" );
# Used to transport information about the group down to the kernel:
DeclareAttribute( "forkernel", IsRecognitionInfo, "mutable" );
DeclareAttribute( "forkernel", IsRecogNode, "mutable" );
# Used to transport information about the group down to the factor:
DeclareAttribute( "forfactor", IsRecognitionInfo, "mutable" );
DeclareAttribute( "forfactor", IsRecogNode, "mutable" );
# Used to check whether group elements are equal to one after recognition:
DeclareAttribute( "isone", IsRecognitionInfo, "mutable" );
DeclareAttribute( "isone", IsRecogNode, "mutable" );
# Used to compare group elements after recognition:
DeclareAttribute( "isequal", IsRecognitionInfo, "mutable" );
DeclareAttribute( "isequal", IsRecogNode, "mutable" );
# Used to compute order of group elements after recognition:
DeclareAttribute( "order", IsRecognitionInfo, "mutable" );
DeclareAttribute( "order", IsRecogNode, "mutable" );
# Used to check whether two group elements commute:
DeclareAttribute( "docommute", IsRecognitionInfo, "mutable" );
DeclareAttribute( "docommute", IsRecogNode, "mutable" );


#############################################################################
Expand Down Expand Up @@ -657,13 +657,13 @@ DeclareGlobalFunction( "FastNormalClosure" );
DeclareGlobalFunction( "FindKernelFastNormalClosure" );
DeclareGlobalFunction( "FindKernelRandom" );
DeclareGlobalFunction( "FindKernelDoNothing" );
DeclareOperation( "RandomElm", [ IsRecognitionInfo, IsString, IsBool ] );
DeclareOperation( "RandomElmOrd", [ IsRecognitionInfo, IsString, IsBool ] );
DeclareOperation( "RandomElmPpd", [ IsRecognitionInfo, IsString, IsBool ] );
DeclareOperation( "RandomOrdersSeen", [ IsRecognitionInfo ] );
DeclareOperation( "StopStoringRandEls", [ IsRecognitionInfo ] );
DeclareOperation( "GetElmOrd", [ IsRecognitionInfo, IsRecord ] );
DeclareOperation( "GetElmPpd", [ IsRecognitionInfo, IsRecord ] );
DeclareOperation( "RandomElm", [ IsRecogNode, IsString, IsBool ] );
DeclareOperation( "RandomElmOrd", [ IsRecogNode, IsString, IsBool ] );
DeclareOperation( "RandomElmPpd", [ IsRecogNode, IsString, IsBool ] );
DeclareOperation( "RandomOrdersSeen", [ IsRecogNode ] );
DeclareOperation( "StopStoringRandEls", [ IsRecogNode ] );
DeclareOperation( "GetElmOrd", [ IsRecogNode, IsRecord ] );
DeclareOperation( "GetElmPpd", [ IsRecogNode, IsRecord ] );


# Finally the generic verification procedure:
Expand Down
Loading

0 comments on commit def623d

Please sign in to comment.