Added the Subring package

.github/workflows/docker-testbot.yml

@@ -0,0 +1,43 @@
+# This workflow builds the Macaulay2 testbot Docker image from
+# M2/BUILD/docker/testbot/Dockerfile and pushes it to GitHub Packages,
+# tagged with the current Macaulay2 version (see M2/VERSION) and "latest".
+#
+# The resulting image is published at
+# https://github.com/Macaulay2/M2/pkgs/container/testbot
+
+name: Build and push testbot Docker image
+
+on: workflow_dispatch
+
+env:
+  IMAGE_NAME: ghcr.io/macaulay2/testbot
+
+jobs:
+  docker-testbot:
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Determine image tags
+        run: |
+          M2_VERSION=$(cat M2/VERSION)
+          echo "M2_VERSION=$M2_VERSION" >> "$GITHUB_ENV"
+
+      - name: Log in to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push image
+        uses: docker/build-push-action@v6
+        with:
+          context: M2/BUILD/docker/testbot
+          push: true
+          tags: |
+            ${{ env.IMAGE_NAME }}:v${{ env.M2_VERSION }}
+            ${{ env.IMAGE_NAME }}:latest

.github/workflows/test_build.yml

@@ -63,6 +63,7 @@ jobs:
         run: |
           brew config
           brew update
+          brew trust macaulay2/tap
           brew tap macaulay2/tap
           brew install automake bison boost libtool tbb ccache ctags llvm make yasm libffi msolve googletest fplll eigen jansson r palp
           brew install texinfo || true # sometimes post-install step fails

M2/Macaulay2/packages/=distributed-packages

@@ -224,6 +224,7 @@ SpecialFanoFourfolds
 RationalPoints2
 SuperLinearAlgebra
 SubalgebraBases
+Subrings
 AInfinity
 LinearTruncations
 ThinSincereQuivers

M2/Macaulay2/packages/SubalgebraBases.m2

@@ -30,6 +30,7 @@ newPackage(
     Headline => "Canonical subalgebra bases (aka SAGBI/Khovanskii bases)",
     AuxiliaryFiles => true, -- set to true if package comes with auxiliary files
     DebuggingMode => false, -- set to true only during development
+    PackageExports => {"Subrings"},
     Keywords => {"Commutative Algebra"},
     Certification => {
 	"journal name" => "Journal of Software for Algebra and Geometry",

M2/Macaulay2/packages/SubalgebraBases/classes.m2

@@ -8,6 +8,12 @@
 -- It also contains in its cache a SAGBIBasis
 -- object which is the 'furthest-advanced'
 -- computation data
+
+-*
+-------------------------------
+-- Moved to Subrings package --
+-------------------------------
+
 Subring = new Type of HashTable
 
 -- Subring constructor
@@ -57,6 +63,8 @@ net Subring := S -> (
     toString(A) | ", subring of " | toString(R)
 )
 
+*-
+
 -- SAGBIBasis computation object data-type that inherits from a HashTable
 -- A SAGBIBasis represents a partial or complete SAGBI computation.
 -- It contains all the data necessary to continue a computation

M2/Macaulay2/packages/SubalgebraBases/documentation.m2

@@ -282,7 +282,7 @@ doc ///
             on a collection of ring elements
             against each other, one at a time.
             This is typically performed on a set of generators of a
-            @TO "Subring"@ or @TO "SAGBIBasis"@.
+            @TO "Subrings:Subring"@ or @TO "SAGBIBasis"@.
             The result of each subduction replaces the
             original element in the collection and zeros are removed from the collection.
             If the elements form a subalgebra basis, then the result of
@@ -1416,7 +1416,7 @@ doc ///
             for the intersection but the algorithm cannot
             guarantee it.
 
-            This function can also be run on a sequence containing both @TO "Subring"@ and 
+            This function can also be run on a sequence containing both @TO "Subrings:Subring"@ and
             @TO "IntersectedSubring"@ types. When @TO "CheckFullIntersection"@ is true, all 
             intermediate intersections are checked for completeness.
         Example
@@ -1441,7 +1441,7 @@ doc ///
         The type of all subrings arising from intersection
     Description
         Text
-            @TT "IntersectedSubring"@ is a type of @TO "Subring"@ produced
+            @TT "IntersectedSubring"@ is a type of @TO "Subrings:Subring"@ produced
             by intersecting two subrings using the function @TO "intersect"@.
             The function @TO "intersect"@ is the constructor for @TT "IntersectedSubring"@.
             Applying the function @TO "isFullIntersection"@ to an instance
@@ -1568,25 +1568,26 @@ doc ///
 -- ## classes.m2 documentation ##
 -- ##############################
 -- Subring
+-*
 doc ///
     Key
         Subring
     Headline
         The type of all subrings
     Description
         Text
-            @TT "Subring"@ is a type that stores information associated
+            @TT "Subrings:Subring"@ is a type that stores information associated
             to a subring of a polynomial ring or quotient ring,
             such as a set of subring generators and
             a reference to the ring containing these generators.
-            An instance of a @TT "Subring"@ is constructed with the function @TO "subring"@.
-            For many uses, it is suggested to use a @ TT "Subring"@,
+            An instance of a @TT "Subrings:Subring"@ is constructed with the function @TO "subring"@.
+            For many uses, it is suggested to use a @ TT "Subrings:Subring"@,
             as the computation objects (@TO "SAGBIBasis"@)
             are handled behind the scenes, and
             the user experience
             is more streamlined.
 
-            Every instance of @TT "Subring"@ has the following keys
+            Every instance of @TT "Subrings:Subring"@ has the following keys
             (some of which are strings):
 
             @UL {
@@ -1629,9 +1630,9 @@ doc ///
         A = subring S
     Inputs
         M:Matrix
-            whose entries are the generators for the constructed @TO "Subring"@.
+            whose entries are the generators for the constructed @TO "Subrings:Subring"@.
         L:List
-            containing generators for the constructed @TO "Subring"@.
+            containing generators for the constructed @TO "Subrings:Subring"@.
         S:SAGBIBasis
         GeneratorSymbol=>Symbol
             a symbol to be used for the variables of the @ TT "presentationRing" @.
@@ -1640,7 +1641,7 @@ doc ///
             generated by the input generators.
     Description
         Text
-            This function serves as the canonical constructor for the @TO "Subring"@ type.
+            This function serves as the canonical constructor for the @TO "Subrings:Subring"@ type.
             For many uses, it is suggested to use @ ofClass Subring@,
             as the computation objects (@TO "SAGBIBasis"@)
             are handled behind the scenes, and
@@ -1677,7 +1678,7 @@ doc ///
         result:Matrix
     Description
         Text
-            Returns a generating set for the @TO "Subring"@ as a one-row matrix.
+            Returns a generating set for the @TO "Subrings:Subring"@ as a one-row matrix.
         Example
             R = QQ[x,y,z];
             S = subring({x^2, y^2, z^2});
@@ -1701,7 +1702,7 @@ doc ///
         result:Ring
     Description
         Text
-            Returns the ambient ring of the generating set of the @TO "Subring"@.
+            Returns the ambient ring of the generating set of the @TO "Subrings:Subring"@.
             This may be a @TO "PolynomialRing"@ or @TO "QuotientRing"@.
         Example
             R = QQ[x,y,z];
@@ -1731,7 +1732,7 @@ doc ///
             the number of generators of S
     Description
         Text
-            Returns the number of generators of a @TO "Subring"@.
+            Returns the number of generators of a @TO "Subrings:Subring"@.
         Example
             R = QQ[x,y,z];
             S = subring({x^2, y^2, z^2, x^2+y^2});
@@ -1745,6 +1746,7 @@ doc ///
         (net, Subring)
         (flattenedRing, Subring)
 ///
+*-
 -- (numgens, SAGBIBasis)
 doc ///
     Key
@@ -1777,6 +1779,7 @@ doc ///
         (net, Subring)
         (flattenedRing, SAGBIBasis)
 ///
+-*
 -- (net, Subring)
 doc ///
     Key
@@ -1792,7 +1795,7 @@ doc ///
             obtained by formatting S for printing.
     Description
         Text
-            Displays the presentation and ambient rings of a @TO "Subring"@.
+            Displays the presentation and ambient rings of a @TO "Subrings:Subring"@.
         Example
             R = QQ[x,y];
             S = subring{x^2,x*y^2,y^4}
@@ -1827,6 +1830,7 @@ doc ///
         subring
         presentationRing
 ///
+*-
 -- SAGBIBasis
 doc ///
     Key
@@ -1909,7 +1913,7 @@ doc ///
         Text
             This function serves as the canonical constructor for the @TO "SAGBIBasis"@ type.
             The @TT "SAGBIBasis"@ type is also the output of the function @TO "sagbi"@.
-            The @ TO "Subring"@ used to construct a @TT "SAGBIBasis"@ may be recovered using
+            The @ TO "Subrings:Subring"@ used to construct a @TT "SAGBIBasis"@ may be recovered using
             @TO "subring"@
         Example
             R = QQ[x,y];
@@ -1951,7 +1955,7 @@ doc ///
     Description
         Text
             Returns a list of subalgebra generators of the
-            @TO "Subring"@ underlying the @TO "SAGBIBasis"@.
+            @TO "Subrings:Subring"@ underlying the @TO "SAGBIBasis"@.
             If the subalgebra generators do not form a complete subalgebra basis
             (for example if they were obtained from a partial computation),
             then the generators obtained from this command
@@ -2015,7 +2019,7 @@ doc ///
     Description
         Text
             Returns the ambient ring of @ ofClass SAGBIBasis @.
-            This is the ambient ring of the generating @TO "Subring"@
+            This is the ambient ring of the generating @TO "Subrings:Subring"@
             This may be a @TO "PolynomialRing"@ or @TO "QuotientRing"@.
         Example
             R = QQ[x,y,z];
@@ -2030,7 +2034,6 @@ doc ///
         SAGBIBasis
         sagbiBasis
         (gens, SAGBIBasis)
-        (ambient, Subring)
 ///
 -- (ring, SAGBIBasis)
 doc ///
@@ -2420,6 +2423,7 @@ doc ///
         UseSubringGens
         SubductionMethod
 ///
+-*
 -- presentationRing
 doc ///
     Key
@@ -2471,6 +2475,7 @@ doc ///
         (ambient, Subring)
         (flattenedRing, Subring)
 ///
+*-
 -- #########################################
 -- ## Short Explanation of Screws Example ##
 -- #########################################
@@ -2634,6 +2639,7 @@ doc ///
         subalgebraBasis
         subduction
 ///
+-*
 -- flatenedRing
 doc ///
     Key
@@ -2643,8 +2649,8 @@ doc ///
     Headline
         The flattened ring of a subring or sagbiBasis
     Usage
-        result = flattened S
-        result = flattened SB
+        result = flattenedRing S
+        result = flattenedRing SB
     Inputs
         S:Subring
         SB:SAGBIBasis
@@ -2667,4 +2673,5 @@ doc ///
         sagbiBasis
         (ambient, SAGBIBasis)
 ///
+*-
 end --

M2/Macaulay2/packages/SubalgebraBases/exports.m2

@@ -16,17 +16,17 @@ export {
 
 -- From classes.m2
 export {
-    "Subring",
+    -- "Subring",
     "SAGBIBasis",
-    "subring",
+    -- "subring",
     "Compute",
     "sagbiBasis",
-    "GeneratorSymbol",
-    "presentationRing",
+    -- "GeneratorSymbol",
+    -- "presentationRing",
     "sagbiStatus",
     "sagbiLimit",
     "sagbiDegree",
-    "flattenedRing"
+    -- "flattenedRing"
 }
 
 -- From sagbi-functions.m2

M2/Macaulay2/packages/SubalgebraBases/sagbi-functions.m2

@@ -566,6 +566,7 @@ subringIntersection(Subring, Subring) := IntersectedSubring => opts -> (S1, S2)
         "ambientRing" => A,
         "flattenedRing" => Q,
         "generators" => intersectionGens,
+        "originalGenerators" => S1#"inverseFlatteningMap" intersectionGens,
         "presentationRing" => subductionRing,
         "presentationMap" => presentationMap,
         cache => new CacheTable from {},