Fix Mandarins

Author: ssiccha

gap/base/recognition.gi

@@ -228,6 +228,28 @@ InstallOtherMethod( RecogNode,
     return RecogNode(H, projective, rec());
   end );
 
+RECOG.SetXNodeForNodeAndString := function(r, s)
+    if not s = MANDARIN_CRISIS then
+        ErrorNoReturn("<s> must be MANDARIN_CRISIS");
+    fi;
+    return;
+  end;
+
+InstallMethod( SetParentRecogNode,
+  "for a recognition node and a string",
+  [ IsRecogNode, IsString ],
+  RECOG.SetXNodeForNodeAndString);
+
+InstallMethod( SetImageRecogNode,
+  "for a recognition node and a string",
+  [ IsRecogNode, IsString ],
+  RECOG.SetXNodeForNodeAndString);
+
+InstallMethod( SetKernelRecogNode,
+  "for a recognition node and a string",
+  [ IsRecogNode, IsString ],
+  RECOG.SetXNodeForNodeAndString);
+
 # Sets the stamp used by RandomElm, RandomElmOrd, and related functions.
 RECOG.SetPseudoRandomStamp := function(g,st)
   if IsBound(g!.pseudorandomfunc) then
@@ -457,9 +479,10 @@ function(ri)
     gensNWasEmpty := IsEmpty(gensN(ri));
     if gensNWasEmpty then
         # This gets reduced during each iteration to a minimal value of 1, to
-        # account for the case where the kernel only has two elements. If the
-        # findgensNmeth discards trivial or already found generators, than in
-        # that case we could never find more than one generator.
+        # account for the case where the kernel only has two elements. The
+        # findgensNmeth might discard trivial or duplicate generators. In that
+        # case we can never find more than one generator, if the kernel has
+        # size two.
         targetNrGensN := 5;
     else
         targetNrGensN := 2 * Length(gensN(ri));
@@ -490,7 +513,7 @@ InstallGlobalFunction( RecogniseGeneric,
       local depth, ri, allmethods, s, factorMandarins, y, counter_image, rifac,
             kernelGenerationSuccess, l, ll, kernelMandarins, x, z,
             mandarinSuccess, immediateVerificationSuccess, N, riker,
-            enlargeKernelSuccess, andarin, i;
+            enlargeKernelSuccess, i;
 
     depth := Length(depthString);
 
@@ -506,18 +529,18 @@ InstallGlobalFunction( RecogniseGeneric,
         Assert(0, depth = 0);
         # HACK: We don't want the mandarins to be reused by any computation.
         # Since PseudoRandom is hacked, it is important that we generate the
-        # mandarins before calling EmptyRecognitionInfoRecord. Otherwise the
-        # mandarins would be reused by RandomElm and RandomElmOrd.
+        # mandarins before calling RecogNode. Otherwise the mandarins would be
+        # reused by RandomElm and RandomElmOrd.
         # 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(
-        knowledge,
         H,
-        IsIdenticalObj( methoddb, FindHomDbProjective )
+        IsIdenticalObj( methoddb, FindHomDbProjective ),
+        knowledge
     );
     if isSafeForMandarins then
         SetFilterObj(ri, IsSafeForMandarins);
@@ -573,11 +596,16 @@ InstallGlobalFunction( RecogniseGeneric,
             fi;
         fi;
 
-        # TODO: store the mandarins and their SLPs?
+        # TODO: store the mandarin SLPs here. Make sure, to only write when succesful.
         # check mandarins now
         for x in mandarins do
             s := SLPforElement(ri, x);
             if s = fail then
+                # TODO: with the master branch rewriting the gens as slps never
+                # fails. at least we never enter a second iteration of the
+                # "recognise image" loop.
+                Info(InfoRecog, 2,
+                     "Enter Mandarin crisis (leaf, depth=", depth, ").");
                 return MANDARIN_CRISIS;
             fi;
         od;
@@ -601,6 +629,9 @@ InstallGlobalFunction( RecogniseGeneric,
     # fails, then somewhere higher up in the recognition tree, a kernel must
     # have been too small.
     if ForAny(mandarins, x->not ValidateHomomInput(ri, x)) then
+        Info(InfoRecog, 2,
+             "Enter Mandarin crisis (depth=", depth, "), ",
+             "ValidateHomomInput failed.");
         return MANDARIN_CRISIS;
     fi;
     # Compute the mandarins of the factor
@@ -648,19 +679,22 @@ InstallGlobalFunction( RecogniseGeneric,
                   factorMandarins,
                   IsSafeForMandarins(ri));
         Remove(depthString);
-        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;
-        fi;
+        PrintTreePos("F",depthString,H);
+        SetImageRecogNode(ri,rifac);
+        SetParentRecogNode(rifac,ri);
         if rifac = MANDARIN_CRISIS 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.");
             return MANDARIN_CRISIS;
         fi;
-        PrintTreePos("F",depthString,H);
-        SetImageRecogNode(ri,rifac);
-        SetParentRecogNode(rifac,ri);
+        # Check for IsReady after checking for MANDARIN_CRISIS, since
+        # IsReady(MANDARIN_CRISIS) always is false.
+        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;
+        fi;
 
         if IsMatrixGroup(H) then
             Info(InfoRecog,2,"Back from image (depth=",depth,
@@ -704,23 +738,14 @@ InstallGlobalFunction( RecogniseGeneric,
         SetgensN(ri,ll);
     fi;
 
-    # evaluate mandarins to get kernel mandarins
-    # TODO: something is suuper iffy about the method BlocksModScalars, which
-    # is called by BlockDiagonal.
-    # Apparently its input is neither to be understood as a projective nor as a
-    # matrix group, but rather as a "all block-scalars being trivial" group.
-    # That ofc completely wrecks the mandarins, since they assume the group to
-    # be projective.
+    # Evaluate mandarins to get kernel mandarins
     kernelMandarins := [];
     for i in [1..Length(mandarins)] do
         x := mandarins[i];
         y := factorMandarins[i];
         s := SLPforElement(rifac, y);
-        # TODO: these SLPs should be stored when they are computed for the
-        # first time.
-        if s = fail then
-            Error("TODO: no SLP for factor");
-        fi;
+        # TODO: These SLPs should be stored when they are computed for the
+        # first time. In particular, they can't be fail.
         z := ResultOfStraightLineProgram(s, pregensfac(ri));
         if not ri!.isequal(x, z) then
             Add( kernelMandarins, x / z );
@@ -732,13 +757,21 @@ InstallGlobalFunction( RecogniseGeneric,
         # Special case, for an explanation see the source of the called function.
         RECOG_HandleSpecialCaseKernelTrivialAndMarkedForImmediateVerification(ri);
     fi;
-    if IsEmpty(gensN(ri)) and not IsEmpty(kernelMandarins) then
-        # We found out that N is the trivial group, but the mandarins disagree!
+    if IsEmpty(gensN(ri)) and not IsEmpty(kernelMandarins)
+            # HACK: something is suuper iffy about the method BlocksModScalars,
+            # see the comment at handling the "Enter mandarin crisis" non-leaf
+            # case.
+            and fhmethsel(ri).successMethod <> "BlocksModScalars" then
+        Info(InfoRecog, 2,
+             "Enter Mandarin crisis (depth=", depth, "), ",
+             "kernel can't be trivial.");
         # We handle this in the same way as if recognition of the
         # kernel returned a MANDARIN_CRISIS.
         if not IsSafeForMandarins(ri) then
             return MANDARIN_CRISIS;
         else
+            Info(InfoRecog, 2,
+                 "Handle the mandarin crisis (depth=", depth, ").");
             if not TryToEnlargeKernelGeneratingSetAndUpdateSLPsDuringMandarinCrisis(ri) then
                 # TODO: discard and re-recognise the image.
                 ErrorNoReturn("TODO");
@@ -777,36 +810,38 @@ InstallGlobalFunction( RecogniseGeneric,
                                    kernelMandarins,
                                    # TODO: extend this such that riker can also
                                    # be IsSafeForMandarins, if the responsible
-                                   # findgensNmeth is guaranteed to feed the
+                                   # findgensNmeth is guaranteed to find the
                                    # generators for the whole kernel.
                                    false);
         Remove(depthString);
+        PrintTreePos("K",depthString,H);
+        SetKernelRecogNode(ri,riker);
+        SetParentRecogNode(riker,ri);
         if riker = MANDARIN_CRISIS then
             # According to the mandarins, there was an error in the kernel
             # generation of the current node or higher up in the recognition
             # tree.
             if not IsSafeForMandarins(ri) then
-                # Backtrack to the first safe node on the way to the root.
+                Info(InfoRecog, 2,
+                     "Backtrack to the last safe node (depth=", depth, ").");
                 return MANDARIN_CRISIS;
             fi;
+            Info(InfoRecog, 2,
+                 "Handle the mandarin crisis (depth=", depth, ").");
             # We are the first safe node on the way to the root and thus need to
             # handle the crisis ourselves.
-            enlargeKernelSuccess :=
-                TryToEnlargeKernelGeneratingSetAndUpdateSLPsDuringMandarinCrisis(ri);
-            if not enlargeKernelSuccess then
+            if not TryToEnlargeKernelGeneratingSetAndUpdateSLPsDuringMandarinCrisis(ri) then
                 # TODO: discard and re-recognise the image.
                 ErrorNoReturn("TODO");
             fi;
             # This restarts the loop, since mandarinSuccess is false.
             continue;
-        else
-            mandarinSuccess := true;
         fi;
-        PrintTreePos("K",depthString,H);
-        SetKernelRecogNode(ri,riker);
-        SetParentRecogNode(riker,ri);
+        mandarinSuccess := true;
         Info(InfoRecog,2,"Back from kernel (depth=",depth,").");
 
+        # Check for IsReady after checking for MANDARIN_CRISIS, since
+        # IsReady(MANDARIN_CRISIS) always is false.
         if not IsReady(riker) then
             # IsReady is not set, thus the whole computation aborts.
             return ri;
@@ -817,29 +852,33 @@ InstallGlobalFunction( RecogniseGeneric,
             Info(InfoRecog,2,"Doing immediate verification (depth=",
                  depth,").");
             immediateVerificationSuccess := ImmediateVerification(ri);
-            if not immediateVerificationSuccess then
-                # Restart the loop since immediateVerificationSuccess is false.
-                continue;
-            fi;
         fi;
-        for x in kernelMandarins do
-            if SLPforElement(ri, x) = fail then
-                # We handle this in the same way as if recognition of the
-                # kernel returned a MANDARIN_CRISIS.
-                if not IsSafeForMandarins(ri) then
-                    return MANDARIN_CRISIS;
-                fi;
-                if not TryToEnlargeKernelGeneratingSetAndUpdateSLPsDuringMandarinCrisis(ri) then
-                    # TODO: discard and re-recognise the image.
-                    ErrorNoReturn("TODO");
-                fi;
-                # This restarts the loop, since mandarinSuccess is false.
-                continue;
-            fi;
-        od;
     until mandarinSuccess and immediateVerificationSuccess;
 
     SetNiceGens(ri,Concatenation(pregensfac(ri), NiceGens(riker)));
+
+    # Check mandarins now
+    for x in mandarins do
+        # TODO: something is suuper iffy about the method BlocksModScalars, which
+        # is called by BlockDiagonal.
+        # Apparently its input is neither to be understood as a projective nor as a
+        # matrix group, but rather as a "all block-scalars being trivial" group.
+        # That ofc completely wrecks the mandarins, since they assume the group to
+        # be projective. Currently we don't check here whether the SLP for a
+        # mandarin evaluates to the mandarin.
+        # This also has to be considered when doing immediate verification.
+        # To solve that situation we hacked SLPforElementGeneric.
+        s := SLPforElement(ri, x);
+        if s = fail then
+            # TODO: with the master branch rewriting the gens as slps never
+            # fails. at least we never enter a second iteration of the
+            # "recognise image" loop.
+            Info(InfoRecog, 2,
+                 "Enter Mandarin crisis (non-leaf, depth=", depth, ").");
+            return MANDARIN_CRISIS;
+        fi;
+    od;
+
     if InfoLevel(InfoRecog) = 1 and depth = 0 then Print("\n"); fi;
     # StopStoringRandEls(ri);
     SetFilterObj(ri,IsReady);