WIP make RecogniseGeneric take a RecogNode

Author: ssiccha

gap/base/recognition.gd

@@ -599,7 +599,9 @@ DeclareSynonym("RecognizeGroup", RecogniseGroup);
 ## </Description>
 ## </ManSection>
 ## <#/GAPDoc>
-DeclareGlobalFunction( "RecogniseGeneric" );
+# TODO: change documentation and update references from func to oper
+DeclareOperation( "RecogniseGeneric",
+                  [ IsRecogNode, IsObject, IsString, IsRecord, IsObject, IsBool ] );
 DeclareSynonym("RecognizeGeneric", RecogniseGeneric);
 
 DeclareGlobalFunction( "PrintTreePos" );

gap/base/recognition.gi

@@ -580,15 +580,36 @@ end);
 InstallMethod(ViewString, "for recognition crises", [IsRecogCrisis],
               crisis -> "<recog crisis>");
 
-InstallGlobalFunction( RecogniseGeneric,
-  function(H, methoddb, depthString, knowledge, mandarins, isSafeForMandarins)
+# TODO, disable this to run test suite.
+InstallMethod( RecogniseGeneric,
+"compatibility method",
+[ IsGroup, IsObject, IsString, IsRecord, IsObject, IsBool ],
+function(H, methoddb, depthString, knowledge, mandarins, isSafeForMandarins)
+    local ri;
+    ri := RecogNode(
+        H,
+        IsIdenticalObj( methoddb, FindHomDbProjective ),
+        knowledge
+    );
+    RecogniseGeneric(ri, methoddb, depthString, knowledge,
+                     mandarins, isSafeForMandarins);
+    return ri;
+end);
+
+# TODO: Update docs: new return value: crisis or true
+# TODO: Rename this into RecogniseRecogNode
+InstallMethod( RecogniseGeneric,
+"TODO",
+[ IsRecogNode, IsObject, IsString, IsObject, IsBool ],
+function(ri, methoddb, depthString, mandarins, isSafeForMandarins)
     # Assume all the generators have no memory!
       local depth, ri, allmethods, s, imageMandarins, y, counter_image, rifac,
             kernelGenerationSuccess, l, ll, kernelMandarins, x, z, crisis,
             kernelMandarinSuccess, immediateVerificationSuccess, N, riker,
             enlargeKernelSuccess, i, mandarinSLPs, nrNiceGensOfImageNode;
 
     depth := Length(depthString);
+    H := Grp(ri);
 
     PrintTreePos("E",depthString,H);
     Info(InfoRecog,4,"Recognising: ",H);
@@ -607,24 +628,19 @@ InstallGlobalFunction( RecogniseGeneric,
         # TODO: enable passing NUM_MANDARINS as optional arg
         mandarins := List([1..NUM_MANDARINS_DEFAULT_VALUE], i -> PseudoRandom(H));
     fi;
-
-    # Set up the record and the group object:
-    ri := RecogNode(
-        H,
-        IsIdenticalObj( methoddb, FindHomDbProjective ),
-        knowledge
-    );
     ri!.mandarins := mandarins;
     if isSafeForMandarins then
         SetFilterObj(ri, IsSafeForMandarins);
     fi;
+
     # was here earlier: Setcalcnicegens(ri,CalcNiceGensGeneric);
+
     Setmethodsforimage(ri,methoddb);
 
     # Combine database of find homomorphism methods with hints
     allmethods := methoddb;
-    if IsBound(knowledge.hints) then
-        allmethods := Concatenation(allmethods, knowledge.hints);
+    if IsBound(ri!.hints) then
+        allmethods := Concatenation(allmethods, ri!.hints);
         SortBy(allmethods, a -> -a.rank);
     fi;
     # verify no rank occurs more than once
@@ -645,7 +661,7 @@ InstallGlobalFunction( RecogniseGeneric,
         Info(InfoRecog, 1,
              "RecogNode <ri> could not be recognised,",
              " IsReady(<ri>) is not set, recognition aborts");
-        return ri;
+        return true;
     fi;
 
     # Handle the leaf case:
@@ -686,7 +702,7 @@ InstallGlobalFunction( RecogniseGeneric,
         if InfoLevel(InfoRecog) = 1 and depth = 0 then Print("\n"); fi;
         # StopStoringRandEls(ri);
         SetFilterObj(ri,IsReady);
-        return ri;
+        return true;
     fi;
 
     # The non-leaf case:
@@ -733,7 +749,7 @@ InstallGlobalFunction( RecogniseGeneric,
                  "Kernel generation for RecogNode <ri> failed ",
                  counter_image, " times, ",
                  " IsReady(<ri>) is not set, recognition aborts");
-            return ri;
+            return true;
         fi;
 
         if IsMatrixGroup(Image(Homom(ri))) then
@@ -745,30 +761,33 @@ InstallGlobalFunction( RecogniseGeneric,
               counter_image,").");
         fi;
 
-        Add(depthString,'F');
-        rifac := RecogniseGeneric(
+        rifac := RecogNode(
                   Group(List(GeneratorsOfGroup(H), x->ImageElm(Homom(ri),x))),
-                  methodsforimage(ri), depthString,
-                  InitialDataForImageRecogNode(ri),
+                  methodsforimage(ri),
+                  InitialDataForImageRecogNode(ri));
+        SetImageRecogNode(ri,rifac);
+        SetParentRecogNode(rifac,ri);
+        Add(depthString,'F');
+        # TODO Change return value
+        imageStatus := RecogniseGeneric(
+                  rifac,
+                  methodsforimage(ri),
+                  depthString,
                   imageMandarins,
                   IsSafeForMandarins(ri));
         Remove(depthString);
         PrintTreePos("F",depthString,H);
-        SetImageRecogNode(ri,rifac);
-        SetParentRecogNode(rifac,ri);
-        if IsRecogCrisis(rifac) then
+        if IsRecogCrisis(imageStatus) then
             # According to the mandarins, somewhere higher up in the recognition
             # tree, a kernel must have been too small.
             Info(InfoRecog, 2,
                  "Backtrack to the last safe node (depth=", depth, ").");
-            return rifac;
+            return imageStatus;
         fi;
-        # Check for IsReady after checking for a crisis, since
-        # IsReady always returns false for a crisis.
         if not IsReady(rifac) then
             # IsReady was not set, thus abort the whole computation.
             if InfoLevel(InfoRecog) = 1 and depth = 0 then Print("\n"); fi;
-            return ri;
+            return true;
         fi;
 
         if IsMatrixGroup(H) then
@@ -786,6 +805,7 @@ InstallGlobalFunction( RecogniseGeneric,
 
         # Now create the kernel generators with the stored method:
         # The value of kernelGenerationSuccess is either true or fail.
+        # TODO: why doesn't this throw a crisis?
         kernelGenerationSuccess :=
             CallFuncList(findgensNmeth(ri).method,
                          Concatenation([ri],findgensNmeth(ri).args));
@@ -863,7 +883,7 @@ InstallGlobalFunction( RecogniseGeneric,
         if InfoLevel(InfoRecog) = 1 and depth = 0 then Print("\n"); fi;
         # StopStoringRandEls(ri);
         SetFilterObj(ri,IsReady);
-        return ri;
+        return true;
     fi;
 
     Info(InfoRecog,2,"Going to the kernel (depth=",depth,").");
@@ -879,9 +899,11 @@ InstallGlobalFunction( RecogniseGeneric,
         # This is now in terms of the generators of H!
         N := Group(StripMemory(gensN(ri)));
 
+        riker := RecogNode(N, methoddb, InitialDataForKernelRecogNode(ri));
+        SetKernelRecogNode(ri,riker);
+        SetParentRecogNode(riker,ri);
         Add(depthString,'K');
-        riker := RecogniseGeneric( N, methoddb, depthString,
-                                   InitialDataForKernelRecogNode(ri),
+        kernelStatus := RecogniseGeneric( N, methoddb, depthString,
                                    kernelMandarins,
                                    # TODO: extend this such that riker can also
                                    # be IsSafeForMandarins, if the responsible
@@ -890,9 +912,7 @@ InstallGlobalFunction( RecogniseGeneric,
                                    false);
         Remove(depthString);
         PrintTreePos("K",depthString,H);
-        SetKernelRecogNode(ri,riker);
-        SetParentRecogNode(riker,ri);
-        if IsRecogCrisis(riker) then
+        if IsRecogCrisis(kernelStatus) then
             # According to the mandarins, there was an error in the kernel
             # generation of the current node or higher up in the recognition
             # tree.
@@ -916,11 +936,9 @@ InstallGlobalFunction( RecogniseGeneric,
         kernelMandarinSuccess := true;
         Info(InfoRecog,2,"Back from kernel (depth=",depth,").");
 
-        # Check for IsReady after checking for a crisis, since
-        # IsReady always returns false for a crisis.
         if not IsReady(riker) then
             # IsReady is not set, thus the whole computation aborts.
-            return ri;
+            return true;
         fi;
         if not immediateverification(ri) then
             immediateVerificationSuccess := true;
@@ -954,7 +972,7 @@ InstallGlobalFunction( RecogniseGeneric,
     if InfoLevel(InfoRecog) = 1 and depth = 0 then Print("\n"); fi;
     # StopStoringRandEls(ri);
     SetFilterObj(ri,IsReady);
-    return ri;
+    return true;
   end);
 
 InstallGlobalFunction( ValidateHomomInput,