Merge pull request #1524 from zickgraf/master

Allow to specify full data types for variables in logic templates

Author: zickgraf

CompilerForCAP/PackageInfo.g

@@ -10,7 +10,7 @@ SetPackageInfo( rec(
 
 PackageName := "CompilerForCAP",
 Subtitle := "Speed up and verify categorical algorithms",
-Version := "2023.12-07",
+Version := "2023.12-08",
 Date := (function ( ) if IsBound( GAPInfo.SystemEnvironment.GAP_PKG_RELEASE_DATE ) then return GAPInfo.SystemEnvironment.GAP_PKG_RELEASE_DATE; else return Concatenation( ~.Version{[ 1 .. 4 ]}, "-", ~.Version{[ 6, 7 ]}, "-01" ); fi; end)( ),
 License := "GPL-2.0-or-later",
 

CompilerForCAP/gap/LogicTemplates.gd

@@ -17,7 +17,8 @@ DeclareGlobalFunction( "CAP_JIT_INTERNAL_TREE_MATCHES_TEMPLATE_TREE" );
 #!   Logic templates are records with the following entries:
 #!     * `src_template` and `dst_template` (required): strings containing valid GAP code defining expressions
 #!     * `variable_names` (required): a list of strings (which must not be keywords in GAP)
-#!     * `variable_filters` (optional): a list of filters with the same length as `variable_names`, defaults to a list of `IsObject`
+#!     * `variable_filters` (optional): a list of filters or data types (see <Ref Func="CapJitInferredDataTypes" />)
+#!        with the same length as `variable_names`, defaults to a list of `IsObject`
 #!     * `new_funcs` (optional): a list of lists of strings, defaults to the empty list
 #!     * `needed_packages` (optional): a list of pairs (i.e. lists with two entries) of strings, defaults to the empty list
 #!     * `debug` (optional): a boolean
@@ -29,7 +30,7 @@ DeclareGlobalFunction( "CAP_JIT_INTERNAL_TREE_MATCHES_TEMPLATE_TREE" );
 #!     * When trying to find an occurence of `src_template` in a tree, all strings occuring in the list `variable_names`
 #!       are considered as variables, i.e., they match any value in the tree. If a variable occurs
 #!       multiple times, the corresponding parts of the tree must be equal.
-#!       The template is only applied if all values match the corresponding filters in `variable_filters`.
+#!       The template is only applied if all values match the corresponding filters or data types in `variable_filters`.
 #!     * For each function in `dst_template`, <Ref Func="CapJitAppliedLogicTemplates" /> tries to find a corresponding function in
 #!       `src_template`. The functions are matched by comparing the lists of names of function arguments. If for a function in
 #!       `dst_template` no corresponding function in `src_template` exists, you have to add the list of names of function arguments

CompilerForCAP/gap/LogicTemplates.gi

@@ -60,13 +60,6 @@ InstallGlobalFunction( CAP_JIT_INTERNAL_ENHANCE_LOGIC_TEMPLATE, function ( templ
 
     od;
 
-    if IsBound( template.variable_filters ) and Length( template.variable_names ) <> Length( template.variable_filters ) then
-        
-        # COVERAGE_IGNORE_NEXT_LINE
-        Error( "the length of the record entries variable_names and variable_filters of a logic template must be equal" );
-        
-    fi;
-    
     if Last( NormalizedWhitespace( template.src_template ) ) = ';' then
 
         # COVERAGE_IGNORE_NEXT_LINE
@@ -112,6 +105,20 @@ InstallGlobalFunction( CAP_JIT_INTERNAL_ENHANCE_LOGIC_TEMPLATE, function ( templ
 
     fi;
 
+    if Length( template.variable_names ) <> Length( template.variable_filters ) then
+        
+        # COVERAGE_IGNORE_NEXT_LINE
+        Error( "the length of the record entries variable_names and variable_filters of a logic template must be equal" );
+        
+    fi;
+    
+    if not ForAll( template.variable_filters, f -> IsFilter( f ) or IsRecord( f ) ) then
+        
+        # COVERAGE_IGNORE_NEXT_LINE
+        Error( "the entries of variable_filters must be filters or records" );
+        
+    fi;
+    
     # default new funcs: none
     if not IsBound( template.new_funcs ) then
 
@@ -636,7 +643,7 @@ InstallGlobalFunction( CAP_JIT_INTERNAL_TREE_MATCHES_TEMPLATE_TREE, function ( t
     end;
 
     result_func := function ( template_tree, result, keys, tree )
-      local var_number, filter, key;
+      local var_number, filter_or_data_type, key;
 
         if debug then
             # COVERAGE_IGNORE_BLOCK_START
@@ -661,38 +668,75 @@ InstallGlobalFunction( CAP_JIT_INTERNAL_TREE_MATCHES_TEMPLATE_TREE, function ( t
 
             if not IsBound( variables[var_number] ) then
 
-                filter := variable_filters[var_number];
+                filter_or_data_type := variable_filters[var_number];
 
-                if IsIdenticalObj( filter, IsObject ) or (IsBound( tree.data_type ) and IsSpecializationOfFilter( filter, tree.data_type.filter )) then
-                    
-                    variables[var_number] := tree;
+                if IsRecord( filter_or_data_type ) then
 
-                    if debug then
-                        # COVERAGE_IGNORE_BLOCK_START
-                        Display( "matched via variable1" );
-                        Display( true );
-                        # COVERAGE_IGNORE_BLOCK_END
+                    if IsBound( tree.data_type ) and tree.data_type = filter_or_data_type then
+                        
+                        variables[var_number] := tree;
+                        
+                        if debug then
+                            # COVERAGE_IGNORE_BLOCK_START
+                            Display( "matched via new variable with data type" );
+                            Display( true );
+                            # COVERAGE_IGNORE_BLOCK_END
+                        fi;
+                        
+                        return true;
+                        
+                    else
+                        
+                        if debug then
+                            # COVERAGE_IGNORE_BLOCK_START
+                            Display( "type could not be inferred or did not match" );
+                            # COVERAGE_IGNORE_BLOCK_END
+                        fi;
+                        
+                        return false;
+                        
                     fi;
 
-                    return true;
 
-                else
+                elif IsFilter( filter_or_data_type ) then
 
-                    if debug then
-                        # COVERAGE_IGNORE_BLOCK_START
-                        Display( "type could not be inferred or did not match" );
-                        # COVERAGE_IGNORE_BLOCK_END
+                    if IsIdenticalObj( filter_or_data_type, IsObject ) or (IsBound( tree.data_type ) and IsSpecializationOfFilter( filter_or_data_type, tree.data_type.filter )) then
+                        
+                        variables[var_number] := tree;
+                        
+                        if debug then
+                            # COVERAGE_IGNORE_BLOCK_START
+                            Display( "matched via new variable with filter" );
+                            Display( true );
+                            # COVERAGE_IGNORE_BLOCK_END
+                        fi;
+                        
+                        return true;
+                        
+                    else
+                        
+                        if debug then
+                            # COVERAGE_IGNORE_BLOCK_START
+                            Display( "type could not be inferred or did not match" );
+                            # COVERAGE_IGNORE_BLOCK_END
+                        fi;
+                        
+                        return false;
+                        
                     fi;
 
-                    return false;
+                else
+                    
+                    # COVERAGE_IGNORE_NEXT_LINE
+                    Error( "this should never happen" );
 
                 fi;
 
             else
 
                 if debug then
                     # COVERAGE_IGNORE_BLOCK_START
-                    Display( "matched via variable2" );
+                    Display( "matched via existing variable" );
                     Display( CapJitIsEqualForEnhancedSyntaxTrees( variables[var_number], tree ) );
                     # COVERAGE_IGNORE_BLOCK_END
                 fi;

CompilerForCAP/tst/LogicTemplates.tst

@@ -324,5 +324,26 @@ end
 gap> Length( CAP_JIT_LOGIC_TEMPLATES ) = orig_number_of_logic_templates;
 true
 
+# test full data types in variable_filters
+gap> template := rec(
+>     variable_names := [ "list" ],
+>     variable_filters := [ CapJitDataTypeOfListOf( IsStringRep ) ],
+>     src_template := "list{[ 1 ]}",
+>     dst_template := "[ list[1] ]",
+> );;
+gap> CAP_JIT_INTERNAL_ENHANCE_LOGIC_TEMPLATE( template );
+
+#
+gap> Display( applied_logic_template_to_func( { } -> [ "1", "2" ]{[ 1 ]}, template, Pair( [ ], fail ) ) );
+function (  )
+    return [ [ "1", "2" ][1] ];
+end
+
+#
+gap> Display( applied_logic_template_to_func( { } -> [ 1, 2 ]{[ 1 ]}, template, Pair( [ ], fail ) ) );
+function (  )
+    return [ 1, 2 ]{[ 1 ]};
+end
+
 #
 gap> STOP_TEST( "LogicTemplates" );