Merge pull request #701 from zickgraf/WithGiven

Support WithGiven operations with both source and range given

Author: zickgraf

CAP/PackageInfo.g

@@ -10,7 +10,7 @@ SetPackageInfo( rec(
 
 PackageName := "CAP",
 Subtitle := "Categories, Algorithms, Programming",
-Version := "2021.08-01",
+Version := "2021.08-02",
 Date := Concatenation( "01/", ~.Version{[ 6, 7 ]}, "/", ~.Version{[ 1 .. 4 ]} ),
 License := "GPL-2.0-or-later",
 
@@ -98,7 +98,7 @@ PackageDoc := rec(
 Dependencies := rec(
   GAP := ">= 4.9.1",
   NeededOtherPackages := [ [ "AutoDoc", ">= 2016.02.16" ],
-                           [ "ToolsForHomalg", ">= 2021.05-02" ],
+                           [ "ToolsForHomalg", ">= 2021.08-01" ],
                            [ "io", ">=0" ],
   ],
   SuggestedOtherPackages := [ [ "Browse", ">=0" ],

CAP/doc/AddFunctions.autodoc

@@ -1941,6 +1941,25 @@ DeclareOperation( "AddHomomorphismStructureOnObjects",
 DeclareOperation( "HomomorphismStructureOnMorphisms",
                   [ IsCapCategoryMorphism, IsCapCategoryMorphism ] );
 
+#! @Description
+#! The arguments are a category $C$ and a function $F$.
+#! This operation adds the given function $F$
+#! to the category for the basic operation <C>HomomorphismStructureOnMorphisms</C>.
+#! $F: ( \alpha: a \rightarrow a', \beta: b \rightarrow b' ) \mapsto H( \alpha, \beta )$.
+#! @Returns nothing
+#! @Arguments C, F
+DeclareOperation( "AddHomomorphismStructureOnMorphisms",
+                  [ IsCapCategory, IsFunction ] );
+
+DeclareOperation( "AddHomomorphismStructureOnMorphisms",
+                  [ IsCapCategory, IsFunction, IsInt ] );
+
+DeclareOperation( "AddHomomorphismStructureOnMorphisms",
+                  [ IsCapCategory, IsList, IsInt ] );
+
+DeclareOperation( "AddHomomorphismStructureOnMorphisms",
+                  [ IsCapCategory, IsList ] );
+
 #! @Description
 #! The arguments are an object $s = H(a',b)$ in $D$,
 #! two morphisms $\alpha: a \rightarrow a', \beta: b \rightarrow b'$ in $C$,
@@ -2025,6 +2044,34 @@ DeclareOperation( "AddInterpretMorphismAsMorphismFromDistinguishedObjectToHomomo
 DeclareOperation( "AddInterpretMorphismAsMorphismFromDistinguishedObjectToHomomorphismStructure",
                   [ IsCapCategory, IsList ] );
 
+#! @Description
+#! The arguments are the distinguished object $1$, a morphism  $\alpha: a \rightarrow a'$, and the object $r = H(a,a')$.
+#! The output is the corresponding morphism
+#! $\nu( \alpha ): 1 \rightarrow r$ in $D$ of the homomorphism structure.
+#! @Returns a morphism in $\mathrm{Hom}_{D}(1, r)$
+#! @Arguments alpha
+DeclareOperation( "InterpretMorphismAsMorphismFromDistinguishedObjectToHomomorphismStructureWithGivenObjects",
+                  [ IsCapCategoryObject, IsCapCategoryMorphism, IsCapCategoryObject ] );
+
+#! @Description
+#! The arguments are a category $C$ and a function $F$.
+#! This operation adds the given function $F$
+#! to the category for the basic operation <C>InterpretMorphismAsMorphismFromDistinguishedObjectToHomomorphismStructureWithGivenObjects</C>.
+#! $F: (1, \alpha: a \rightarrow a', r) \mapsto (\nu(\alpha):1 \rightarrow r)$.
+#! @Returns nothing
+#! @Arguments C, F
+DeclareOperation( "AddInterpretMorphismAsMorphismFromDistinguishedObjectToHomomorphismStructureWithGivenObjects",
+                  [ IsCapCategory, IsFunction ] );
+
+DeclareOperation( "AddInterpretMorphismAsMorphismFromDistinguishedObjectToHomomorphismStructureWithGivenObjects",
+                  [ IsCapCategory, IsFunction, IsInt ] );
+
+DeclareOperation( "AddInterpretMorphismAsMorphismFromDistinguishedObjectToHomomorphismStructureWithGivenObjects",
+                  [ IsCapCategory, IsList, IsInt ] );
+
+DeclareOperation( "AddInterpretMorphismAsMorphismFromDistinguishedObjectToHomomorphismStructureWithGivenObjects",
+                  [ IsCapCategory, IsList ] );
+
 #! @Description
 #! The arguments are
 #! objects $a,a'$ in $C$

CAP/gap/CategoryMorphisms.gd

@@ -524,31 +524,6 @@ InstallMethod( PostCompose,
 
 end );
 
-##
-InstallMethod( HomomorphismStructureOnMorphisms,
-               [ IsCapCategoryMorphism, IsCapCategoryMorphism ],
-               
-  function( alpha, beta )
-    
-    return HomomorphismStructureOnMorphisms( CapCategory( alpha ), alpha, beta );
-    
-end );
-
-##
-InstallOtherMethodForCompilerForCAP( HomomorphismStructureOnMorphisms,
-                                     [ IsCapCategory, IsCapCategoryMorphism, IsCapCategoryMorphism ],
-               
-  function( cat, alpha, beta )
-    
-    return HomomorphismStructureOnMorphismsWithGivenObjects(
-             cat,
-             HomomorphismStructureOnObjects( cat, Range( alpha ), Source( beta ) ),
-             alpha, beta,
-             HomomorphismStructureOnObjects( cat, Source( alpha ), Range( beta ) )
-           );
-    
-end );
-
 ##
 InstallMethod( HomStructure,
                [ IsCapCategoryMorphism, IsCapCategoryMorphism ],

CAP/gap/CategoryMorphisms.gi

@@ -3,6 +3,14 @@
 #
 # Declarations
 #
+
+#! @Chapter Add Functions
+
+#! @Section InstallAdd Function
+
+#! @Description
+#!   See <Ref Sect="Section_CapInternalInstallAdd" />.
+#! @Arguments record
 DeclareGlobalFunction( "CapInternalInstallAdd" );
 
 DeclareGlobalFunction( "CAP_INTERNAL_INSTALL_ADDS_FROM_RECORD" );

CAP/gap/InstallAdds.gd

@@ -208,29 +208,24 @@ InstallGlobalFunction( CapInternalInstallAdd,
             without_given_weight := CurrentOperationWeight( category!.derivations_weight_list, without_given_name );
             with_given_weight := CurrentOperationWeight( category!.derivations_weight_list, with_given_name );
 
-            if record.is_with_given = false then
+            # take the weight of the currently added function into account
+            if record.is_with_given then
 
-                if with_given_weight <= weight then
-                    
-                    category!.redirects.( without_given_name ) := true;
-                    
-                else
-                    
-                    category!.redirects.( without_given_name ) := false;
-                    
-                fi;
+                with_given_weight := weight;
 
             else
 
-                if weight <= without_given_weight then
-                    
-                    category!.redirects.( without_given_name ) := true;
-                    
-                else
-                    
-                    category!.redirects.( without_given_name ) := false;
-                    
-                fi;
+                without_given_weight := weight;
+                
+            fi;
+            
+            if with_given_weight <= without_given_weight then
+                
+                category!.redirects.( without_given_name ) := true;
+                
+            else
+                
+                category!.redirects.( without_given_name ) := false;
 
             fi;
 
@@ -579,10 +574,16 @@ InstallGlobalFunction( CapInternalInstallAdd,
 
 end );
 
-BindGlobal( "CAP_INTERNAL_INSTALL_WITH_GIVEN_DERIVATION_PAIR", function( without_given_name, with_given_name, object_name, with_given_arguments_names, object_arguments_positions )
-  local without_given_arguments_names, with_given_via_without_given_function, without_given_via_with_given_function;
+BindGlobal( "CAP_INTERNAL_INSTALL_WITH_GIVEN_DERIVATION_PAIR", function( without_given_rec, with_given_rec )
+  local without_given_name, with_given_name, without_given_arguments_names, with_given_arguments_names, with_given_object_position, with_given_via_without_given_function, with_given_arguments_strings, without_given_via_with_given_function;
+    
+    without_given_name := without_given_rec.function_name;
+    with_given_name := with_given_rec.function_name;
+    
+    without_given_arguments_names := without_given_rec.input_arguments_names;
+    with_given_arguments_names := with_given_rec.input_arguments_names;
 
-    without_given_arguments_names := with_given_arguments_names{[ 1 .. Length( with_given_arguments_names ) - 1 ]};
+    with_given_object_position := without_given_rec.with_given_object_position;
 
     with_given_via_without_given_function := EvalString( ReplacedStringViaRecord(
         """
@@ -599,78 +600,74 @@ BindGlobal( "CAP_INTERNAL_INSTALL_WITH_GIVEN_DERIVATION_PAIR", function( without
         )
     ) );
 
+    if with_given_object_position = "Source" then
+        
+        with_given_arguments_strings := Concatenation( without_given_arguments_names, [ without_given_rec.output_source_getter_string ] );
+        
+    elif with_given_object_position = "Range" then
+        
+        with_given_arguments_strings := Concatenation( without_given_arguments_names, [ without_given_rec.output_range_getter_string ] );
+        
+    elif with_given_object_position = "both" then
+        
+        with_given_arguments_strings := Concatenation(
+            [ without_given_arguments_names[1] ],
+            [ without_given_rec.output_source_getter_string ],
+            without_given_arguments_names{[ 2 .. Length( without_given_arguments_names ) ]},
+            [ without_given_rec.output_range_getter_string ]
+        );
+        
+    else
+        
+        Error( "this should never happen" );
+        
+    fi;
+    
     without_given_via_with_given_function := EvalString( ReplacedStringViaRecord(
         """
         function( without_given_arguments )
             
-            return with_given_name( without_given_arguments, object_name( object_arguments ) );
+            return with_given_name( with_given_arguments );
             
         end
         """,
         rec(
             without_given_arguments := without_given_arguments_names,
+            with_given_arguments := with_given_arguments_strings,
             with_given_name := with_given_name,
-            object_name := object_name,
-            object_arguments := without_given_arguments_names{object_arguments_positions},
         )
     ) );
 
     AddDerivationToCAP( ValueGlobal( with_given_name ),
-                        [ [ ValueGlobal( without_given_name ), 1 ] ],
       with_given_via_without_given_function
-      : Description := Concatenation( with_given_name, " by calling ", without_given_name, " with the last argument dropped" ) );
+      : Description := Concatenation( with_given_name, " by calling ", without_given_name, " with the WithGiven argument(s) dropped" ) );
 
     AddDerivationToCAP( ValueGlobal( without_given_name ),
-                        [ [ ValueGlobal( with_given_name ), 1 ],
-                          [ ValueGlobal( object_name ), 1 ] ],
       without_given_via_with_given_function
-      : Description := Concatenation( without_given_name, " by calling ", with_given_name, " with ", object_name, " as last argument" ) );
+      : Description := Concatenation( without_given_name, " by calling ", with_given_name, " with the WithGiven object(s)" ) );
 
 end );
 
 BindGlobal( "CAP_INTERNAL_INSTALL_WITH_GIVEN_DERIVATIONS", function( record )
-  local recnames, current_recname, current_rec, without_given_name, with_given_name, object_name, with_given_arguments_names, object_arguments_positions;
+  local recnames, current_rec, without_given_rec, with_given_rec, current_recname;
 
     recnames := RecNames( record );
 
     for current_recname in recnames do
 
         current_rec := record.(current_recname);
-
+        
         if current_rec.is_with_given then
 
-            without_given_name := current_rec.with_given_without_given_name_pair[1];
-            with_given_name := current_rec.with_given_without_given_name_pair[2];
-            object_name := current_rec.with_given_object_name;
-            with_given_arguments_names := current_rec.input_arguments_names;
-            object_arguments_positions := record.( without_given_name ).object_arguments_positions;
+            without_given_rec := record.(current_rec.with_given_without_given_name_pair[1]);
+            with_given_rec := record.(current_rec.with_given_without_given_name_pair[2]);
 
-            if record.( without_given_name ).filter_list[1] <> "category" or record.( object_name ).filter_list[1] <> "category" or record.( with_given_name ).filter_list[1] <> "category" then
-                
-                Display( Concatenation(
-                    "WARNING: You seem to be relying on automatically installed WithGiven derivations but the first arguments of the functions involved are not the category. ",
-                    "The automatic WithGiven derivation will not be installed. ",
-                    "To prevent this warning, add the category as the first argument to all functions involved. ",
-                    "Search for `category_as_first_argument` in the documentation for more details."
-                ) );
-                
-            elif Length( record.( without_given_name ).filter_list ) + 1 <> Length( record.( with_given_name ).filter_list ) then
-                
-                Display( Concatenation(
-                    "WARNING: You seem to be relying on automatically installed WithGiven derivations. ",
-                    "For this, the with given method must have exactly one additional argument compared to the without given method. ",
-                    "This is not the case, so no automatic WithGiven derivation will be installed."
-                ) );
-                
-            else
-                
-                CAP_INTERNAL_INSTALL_WITH_GIVEN_DERIVATION_PAIR( without_given_name, with_given_name, object_name, with_given_arguments_names, object_arguments_positions );
-                
-            fi;
+            CAP_INTERNAL_INSTALL_WITH_GIVEN_DERIVATION_PAIR( without_given_rec, with_given_rec );
 
         fi;
 
     od;
+    
 end );
 
 InstallGlobalFunction( CAP_INTERNAL_INSTALL_ADDS_FROM_RECORD,

CAP/gap/InstallAdds.gi

@@ -6,7 +6,7 @@
 
 InstallGlobalFunction( "CAP_INTERNAL_GENERATE_CONVENIENCE_METHODS_FOR_LIMITS",
   function ( package_name, method_name_record, limits )
-    local output_string, generate_universal_morphism_convenience, generate_functorial_convenience_method, number_of_diagram_arguments, functorial_record, filter_list, input_type, replaced_filter_list, replaced_filter_list_string, arguments_string, source_diagram_arguments_string, range_diagram_arguments_string, source_diagram_input_type, range_diagram_input_type, call_arguments_string, limit, existing_string, output_path;
+    local output_string, generate_universal_morphism_convenience, generate_functorial_convenience_method, number_of_diagram_arguments, functorial_record, filter_list, input_type, replaced_filter_list, replaced_filter_list_string, arguments_string, source_diagram_arguments_string, range_diagram_arguments_string, source_diagram_input_type, range_diagram_input_type, call_arguments_string, limit, output_path;
 
     output_string :=
 """# SPDX-License-Identifier: GPL-2.0-or-later
@@ -562,9 +562,7 @@ InstallGlobalFunction( "CAP_INTERNAL_GENERATE_CONVENIENCE_METHODS_FOR_LIMITS",
 
     od;
 
-    existing_string := ReadFileFromPackageForHomalg( package_name, "LimitConvenienceOutput.gi" );
-    
-    if output_string <> existing_string then
+    if not IsExistingFileInPackageForHomalg( package_name, "LimitConvenienceOutput.gi" ) or output_string <> ReadFileFromPackageForHomalg( package_name, "LimitConvenienceOutput.gi" ) then
 
         output_path := Filename( DirectoryTemporary( ), "LimitConvenienceOutput.gi" );