Merge pull request #723 from zickgraf/finalize

Fix the finalize mess

Author: zickgraf

ActionsForCAP/gap/ActionsCategory.gi

@@ -36,7 +36,7 @@ InstallMethod( LeftActionsCategory,
   function( acting_object, name, context_filter_list )
     local underlying_monoidal_category, preconditions, category_weight_list, i,
           structure_record, object_constructor, morphism_constructor, 
-          left_actions_category, identity_of_acting_object, tensor_preserves_epis, finalize;
+          left_actions_category, identity_of_acting_object, tensor_preserves_epis;
 
     underlying_monoidal_category := CapCategory( acting_object );
 
@@ -264,11 +264,7 @@ InstallMethod( LeftActionsCategory,
 
     ## TODO: Logic for left_actions_category
 
-    finalize := CAP_INTERNAL_RETURN_OPTION_OR_DEFAULT( "FinalizeCategory", true );
-    
-    if finalize = true then
-        Finalize( left_actions_category );
-    fi;
+    Finalize( left_actions_category );
 
     return left_actions_category;
 
@@ -295,7 +291,7 @@ InstallMethod( RightActionsCategory,
   function( acting_object, name, context_filter_list )
     local underlying_monoidal_category, preconditions, category_weight_list, i,
           structure_record, object_constructor, morphism_constructor, 
-          right_actions_category, identity_of_acting_object, tensor_preserves_epis, finalize;
+          right_actions_category, identity_of_acting_object, tensor_preserves_epis;
 
     underlying_monoidal_category := CapCategory( acting_object );
 
@@ -523,11 +519,7 @@ InstallMethod( RightActionsCategory,
 
     ## TODO: Logic for right_actions_category
 
-    finalize := CAP_INTERNAL_RETURN_OPTION_OR_DEFAULT( "FinalizeCategory", true );
-    
-    if finalize = true then
-        Finalize( right_actions_category );
-    fi;
+    Finalize( right_actions_category );
 
     return right_actions_category;
 

ActionsForCAP/gap/CoactionsCategory.gi

@@ -35,7 +35,7 @@ InstallMethod( LeftCoactionsCategory,
   function( coacting_object, name, context_filter_list )
     local underlying_monoidal_category, preconditions, category_weight_list, i,
           structure_record, object_constructor, morphism_constructor, 
-          left_coactions_category, identity_of_coacting_object, finalize;
+          left_coactions_category, identity_of_coacting_object;
 
     underlying_monoidal_category := CapCategory( coacting_object );
 
@@ -242,11 +242,7 @@ InstallMethod( LeftCoactionsCategory,
 
     ## TODO: Logic for left_coactions_category
 
-    finalize := CAP_INTERNAL_RETURN_OPTION_OR_DEFAULT( "FinalizeCategory", true );
-    
-    if finalize = true then
-        Finalize( left_coactions_category );
-    fi;
+    Finalize( left_coactions_category );
 
     return left_coactions_category;
 
@@ -273,7 +269,7 @@ InstallMethod( RightCoactionsCategory,
   function( coacting_object, name, context_filter_list )
     local underlying_monoidal_category, preconditions, category_weight_list, i,
           structure_record, object_constructor, morphism_constructor, 
-          right_coactions_category, identity_of_coacting_object, finalize;
+          right_coactions_category, identity_of_coacting_object;
 
     underlying_monoidal_category := CapCategory( coacting_object );
 
@@ -480,11 +476,7 @@ InstallMethod( RightCoactionsCategory,
 
     ## TODO: Logic for right_coactions_category
 
-    finalize := CAP_INTERNAL_RETURN_OPTION_OR_DEFAULT( "FinalizeCategory", true );
-    
-    if finalize = true then
-        Finalize( right_coactions_category );
-    fi;
+    Finalize( right_coactions_category );
 
     return right_coactions_category;
 

ActionsForCAP/gap/SemisimpleCategory.gi

@@ -47,7 +47,7 @@ InstallMethod( SemisimpleCategory,
   function( underlying_category, membership_function, membership_function_name )
     local name, semisimple_category;
 
-    if not HasIsFinalized( underlying_category ) or not IsFinalized( underlying_category ) then
+    if not IsFinalized( underlying_category ) then
 
         Error( "the underlying category must be finalized" );
         return;

CAP/PackageInfo.g

@@ -10,7 +10,7 @@ SetPackageInfo( rec(
 
 PackageName := "CAP",
 Subtitle := "Categories, Algorithms, Programming",
-Version := "2021.10-03",
+Version := "2021.10-04",
 Date := Concatenation( "01/", ~.Version{[ 6, 7 ]}, "/", ~.Version{[ 1 .. 4 ]} ),
 License := "GPL-2.0-or-later",
 

CAP/gap/CAP.gi

@@ -244,6 +244,8 @@ InstallGlobalFunction( "CREATE_CAP_CATEGORY_OBJECT",
 
     obj := CallFuncList( ObjectifyWithAttributes, flatted_attribute_list );
 
+    SetIsFinalized( obj, false );
+    
     obj!.derivations_weight_list := MakeOperationWeightList( obj, CAP_INTERNAL_DERIVATION_GRAPH );
 
     obj!.caches := rec( );

CAP/gap/Finalize.gd

@@ -11,8 +11,9 @@ DeclareGlobalVariable( "CAP_INTERNAL_FINAL_DERIVATION_LIST" );
 DeclareGlobalFunction( "AddFinalDerivation" );
 
 
-DeclareProperty( "IsFinalized",
-                  IsCapCategory );
+DeclareAttribute( "IsFinalized",
+                  IsCapCategory,
+                  "mutable" );
 
 DeclareOperation( "Finalize",
                   [ IsCapCategory ] );

CAP/gap/Finalize.gi

@@ -162,14 +162,21 @@ end );
 InstallMethod( Finalize,
                [ IsCapCategory ],
 
-  IsFinalized );
-
-InstallMethod( IsFinalized,
-               [ IsCapCategory ],
-               
   function( category )
     local current_final_derivation, derivation_list, i, n, weight_list, weight, add_name, current_installs, current_tester_func, current_additional_func;
 
+    if IsFinalized( category ) then
+        
+        return true;
+        
+    fi;
+    
+    if ValueOption( "FinalizeCategory" ) = false then
+        
+        return false;
+        
+    fi;
+    
     derivation_list := ShallowCopy( CAP_INTERNAL_FINAL_DERIVATION_LIST.final_derivation_list );
 
     if not category!.is_computable then
@@ -252,6 +259,8 @@ InstallMethod( IsFinalized,
 
     od;
 
+    SetIsFinalized( category, true );
+    
     return true;
 
 end );

CAP/gap/InstallAdds.gi

@@ -168,7 +168,7 @@ InstallGlobalFunction( CapInternalInstallAdd,
               current_function_argument_number, current_additional_filter_list_length, filter, input_human_readable_identifier_getter, input_sanity_check_functions,
               output_human_readable_identifier_getter, output_sanity_check_function, cap_jit_compiled_function;
 
-        if HasIsFinalized( category ) and IsFinalized( category ) then
+        if IsFinalized( category ) then
             Error( "cannot add methods anymore, category is finalized" );
         fi;
 
@@ -464,6 +464,15 @@ InstallGlobalFunction( CapInternalInstallAdd,
                   function( arg )
                     local redirect_return, pre_func_return, collect_timing_statistics, start_time, result, end_time, i;
 
+                    if not IsFinalized( category ) then
+                        
+                        Display( Concatenation(
+                            "WARNING: You are calling an operation in a unfinalized category with name \"", Name( category ),
+                            "\". This is fine for debugging purposes, but for production use you should finalize the category by calling `Finalize` (with the option `FinalizeCategory := true` if needed)."
+                        ) );
+                        
+                    fi;
+                    
                     if (redirect_function <> false) and (not IsBound( category!.redirects.( function_name ) ) or category!.redirects.( function_name ) <> false) then
                         redirect_return := CallFuncList( redirect_function, arg );
                         if redirect_return[ 1 ] = true then

CAP/gap/OppositeCategory.gi

@@ -430,9 +430,9 @@ InstallMethod( Opposite,
                [ IsCapCategory, IsString ],
 
   function( category, name )
-    local opposite_category, to_be_finalized;
+    local opposite_category;
 
-    if not HasIsFinalized( category ) or not IsFinalized( category ) then
+    if not IsFinalized( category ) then
         Error( "Input category must be finalized to create opposite category" );
     fi;
 
@@ -554,17 +554,7 @@ InstallMethod( Opposite,
 
     fi;
 
-    to_be_finalized := ValueOption( "FinalizeCategory" );
-    
-    if to_be_finalized = false then
-        
-        return opposite_category;
-        
-    else
-        
-        Finalize( opposite_category );
-        
-    fi;
+    Finalize( opposite_category );
 
     return opposite_category;
 

CAP/gap/ProductCategory.gi

@@ -182,7 +182,7 @@ InstallMethodWithCrispCache( ProductOp,
   function( category_list, selector )
     local product_category, namestring;
 
-    if not ForAll( category_list, HasIsFinalized ) or not ForAll( category_list, IsFinalized ) then
+    if not ForAll( category_list, IsFinalized ) then
         Error( "all categories for the product must be finalized" );
     fi;
 

CompilerForCAP/gap/PrecompileCategory.gi

@@ -269,7 +269,7 @@ InstallGlobalFunction( "CapJitPrecompileCategory", function ( category_construct
     # check that category_constructor supports `FinalizeCategory`
     cat := CallFuncList( category_constructor, given_arguments : FinalizeCategory := false, no_precompiled_code := true );
 
-    if HasIsFinalized( cat ) then
+    if IsFinalized( cat ) then
 
         # COVERAGE_IGNORE_NEXT_LINE
         Error( "the category constructor must support the option `FinalizeCategory`" );
@@ -548,12 +548,6 @@ InstallGlobalFunction( "CapJitPrecompileCategory", function ( category_construct
         "    \n",
         "    ADD_FUNCTIONS_FOR_", compiled_category_name, "( cat );\n",
         "    \n",
-        "    if ValueOption( \"FinalizeCategory\" ) = false then\n",
-        "        \n",
-        "        return cat;\n",
-        "        \n",
-        "    fi;\n",
-        "    \n",
         "    Finalize( cat );\n",
         "    \n",
         "    return cat;\n",

FreydCategoriesForCAP/gap/AdditiveClosure.gi

@@ -15,7 +15,7 @@ InstallMethod( AdditiveClosure,
                [ IsCapCategory ],
 
   function( underlying_category )
-    local category, matrix_element_as_morphism, list_list_as_matrix, homalg_ring, precompiled_towers, remaining_constructors_in_tower, precompiled_functions_adder, to_be_finalized, info;
+    local category, matrix_element_as_morphism, list_list_as_matrix, homalg_ring, precompiled_towers, remaining_constructors_in_tower, precompiled_functions_adder, info;
 
     if not ( HasIsAbCategory( underlying_category ) and IsAbCategory( underlying_category ) ) then
 
@@ -156,14 +156,6 @@ InstallMethod( AdditiveClosure,
 
     category!.compiler_hints.precompiled_towers := precompiled_towers;
 
-    to_be_finalized := ValueOption( "FinalizeCategory" );
-    
-    if to_be_finalized = false then
-      
-      return category;
-    
-    fi;
-    
     Finalize( category );
 
     return category;

FreydCategoriesForCAP/gap/AdelmanCategory.gi

@@ -15,7 +15,7 @@ InstallMethod( AdelmanCategory,
                [ IsCapCategory ],
 
   function( underlying_category )
-    local adelman_category, func, to_be_finalized;
+    local adelman_category, func;
 
     if not HasIsAdditiveCategory( underlying_category ) then
 
@@ -68,14 +68,6 @@ InstallMethod( AdelmanCategory,
 
     INSTALL_FUNCTIONS_FOR_ADELMAN_CATEGORY( adelman_category );
 
-    to_be_finalized := ValueOption( "FinalizeCategory" );
-      
-    if to_be_finalized = false then
-      
-      return adelman_category;
-    
-    fi;
-    
     Finalize( adelman_category );
 
     return adelman_category;

FreydCategoriesForCAP/gap/CategoryOfColumns.gi

@@ -20,7 +20,7 @@ InstallMethod( CategoryOfColumns,
                [ IsHomalgRing ],
 
   function( homalg_ring )
-    local cat, to_be_finalized;
+    local cat;
 
     cat := CategoryOfColumnsAsOppositeOfCategoryOfRows( homalg_ring : FinalizeCategory := false );
 
@@ -42,14 +42,6 @@ InstallMethod( CategoryOfColumns,
 
     fi;
 
-    to_be_finalized := ValueOption( "FinalizeCategory" );
-    
-    if to_be_finalized = false then
-        
-        return cat;
-        
-    fi;
-    
     Finalize( cat );
 
     return cat;

FreydCategoriesForCAP/gap/CategoryOfColumnsAsOppositeOfCategoryOfRows.gi

@@ -15,7 +15,7 @@ InstallMethod( CategoryOfColumnsAsOppositeOfCategoryOfRows,
                [ IsHomalgRing ],
 
   function( homalg_ring )
-    local category_of_rows, op, to_be_finalized;
+    local category_of_rows, op;
 
     category_of_rows := CategoryOfRows( homalg_ring : FinalizeCategory := true );
 
@@ -114,14 +114,6 @@ InstallMethod( CategoryOfColumnsAsOppositeOfCategoryOfRows,
 
     INSTALL_FUNCTIONS_FOR_CATEGORY_OF_COLUMNS_AS_OPPOSITE_OF_CATEGORY_OF_ROWS( op );
 
-    to_be_finalized := ValueOption( "FinalizeCategory" );
-    
-    if to_be_finalized = false then
-        
-        return op;
-        
-    fi;
-    
     Finalize( op );
 
     return op;

FreydCategoriesForCAP/gap/CategoryOfGradedRowsAndColumns/CategoryOfGradedColumns.gi

@@ -18,7 +18,7 @@
 InstallMethod( CategoryOfGradedColumns,
                [ IsHomalgGradedRing ],
   function( homalg_graded_ring )
-    local category, to_be_finalized;
+    local category;
 
       # create category
       category := CreateCapCategory( Concatenation( "Category of graded columns over ", RingName( homalg_graded_ring ) ) );
@@ -47,14 +47,6 @@ InstallMethod( CategoryOfGradedColumns,
 
       CapCategorySwitchLogicOff( category );
 
-      to_be_finalized := ValueOption( "FinalizeCategory" );
-      
-      if to_be_finalized = false then
-        
-        return category;
-      
-      fi;
-      
       # finalise it
       Finalize( category );
 

FreydCategoriesForCAP/gap/CategoryOfGradedRowsAndColumns/CategoryOfGradedRows.gi

@@ -18,7 +18,7 @@
 InstallMethod( CategoryOfGradedRows,
                [ IsHomalgGradedRing ],
   function( homalg_graded_ring )
-    local category, to_be_finalized;
+    local category;
 
       # construct the category
       category := CreateCapCategory( Concatenation( "Category of graded rows over ", RingName( homalg_graded_ring ) ) );
@@ -47,14 +47,6 @@ InstallMethod( CategoryOfGradedRows,
 
       CapCategorySwitchLogicOff( category );
 
-      to_be_finalized := ValueOption( "FinalizeCategory" );
-      
-      if to_be_finalized = false then
-        
-        return category;
-      
-      fi;
-      
       # finalise the category
       Finalize( category );