passagemath-modules 10.6.31rc3__cp314-cp314-musllinux_1_2_x86_64.whl

sage/modules/quotient_module.py

@@ -0,0 +1,699 @@
+# sage_setup: distribution = sagemath-modules
+r"""
+Quotients of free modules
+
+AUTHORS:
+
+- William Stein (2009): initial version
+
+- Kwankyu Lee (2022-05): added quotient module over domain
+"""
+
+# ****************************************************************************
+#       Copyright (C) 2009 William Stein <wstein@gmail.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 2 of the License, or
+# (at your option) any later version.
+#                  https://www.gnu.org/licenses/
+# ****************************************************************************
+
+from sage.modules.free_module import (
+    FreeModule_ambient,
+    FreeModule_ambient_field,
+    Module_free_ambient,
+)
+
+###############################################################################
+#
+# Quotients of ambient free modules over a domain
+#
+###############################################################################
+
+
+class QuotientModule_free_ambient(Module_free_ambient):
+    """
+    Quotients of ambient free modules by a submodule.
+
+    INPUT:
+
+    - ``module`` -- an ambient free module
+
+    - ``sub`` -- a submodule of ``module``
+
+    EXAMPLES::
+
+        sage: S.<x,y,z> = PolynomialRing(QQ)
+        sage: M = S**2
+        sage: N = M.submodule([vector([x - y, z]), vector([y*z, x*z])])
+        sage: M.quotient_module(N)
+        Quotient module by Submodule of Ambient free module of rank 2 over
+         the integral domain Multivariate Polynomial Ring in x, y, z over Rational Field
+         Generated by the rows of the matrix:
+         [x - y     z]
+         [  y*z   x*z]
+    """
+    def __init__(self, module, sub):
+        """
+        Create this quotient module of ``module`` by a submodule ``sub``.
+
+        TESTS::
+
+            sage: S.<x,y,z> = PolynomialRing(QQ)
+            sage: M = S**2
+            sage: N = M.submodule([vector([x - y, z]), vector([y*z, x*z])])
+            sage: Q = M.quotient_module(N)
+            sage: TestSuite(Q).run(skip=['_test_elements', '_test_pickling', '_test_zero'])
+        """
+        base_ring = module.base_ring()
+        degree = module.degree()
+        sparse = module.is_sparse()
+        # We store these in order to retain the information of how this was constructed
+        self._module = module
+        self._sub = sub
+        self.__hash = hash((self._module, self._sub))
+
+        # We then convert the data into maps from free modules
+        if isinstance(module, QuotientModule_free_ambient):
+            self._free_cover = module.cover()
+            C = self._free_cover.element_class
+            v = [C(self._free_cover, x.list(), coerce=False, copy=False) for x in sub.gens()]
+            w = [C(self._free_cover, x.list(), coerce=False, copy=False) for x in module.free_relations().gens()]
+            self._relations = self._free_cover.submodule(v + w, check=False)
+        else:  # Otherwise module should be a free module
+            self._free_cover = module
+            self._relations = sub
+
+        Module_free_ambient.__init__(self, base_ring, degree=degree, sparse=sparse)
+
+    def _repr_(self):
+        r"""
+        Return the string representation of this quotient module.
+
+        EXAMPLES::
+
+            sage: S.<x,y,z> = PolynomialRing(QQ)
+            sage: M = S**2
+            sage: N = M.submodule([vector([x - y, z]), vector([y*z , x*z])])
+            sage: M.quotient_module(N)
+            Quotient module by Submodule of Ambient free module of rank 2 over
+             the integral domain Multivariate Polynomial Ring in x, y, z over Rational Field
+             Generated by the rows of the matrix:
+             [x - y     z]
+             [  y*z   x*z]
+        """
+        return "Quotient module by %s" % self._sub
+
+    def __hash__(self):
+        r"""
+        Return the hash of this quotient module.
+
+        TESTS::
+
+            sage: S.<x,y,z> = PolynomialRing(QQ)
+            sage: M = S**2
+            sage: N = M.submodule([vector([x - y, z]), vector([y*z, x*z])])
+            sage: Q = M.quotient_module(N)
+            sage: hash(Q) == hash((M,N))
+            True
+        """
+        return self.__hash
+
+    def gens(self) -> tuple:
+        """
+        Return the generators of this module.
+
+        EXAMPLES::
+
+            sage: S.<x,y,z> = PolynomialRing(QQ)
+            sage: M = S**2
+            sage: N = M.submodule([vector([x - y, z]), vector([y*z, x*z])])
+            sage: Q = M.quotient_module(N)
+            sage: Q.gens()
+            ((1, 0), (0, 1))
+        """
+        return tuple(self(list(g)) for g in self._module.gens())
+
+    def gen(self, i=0):
+        """
+        Return the `i`-th generator of this module.
+
+        EXAMPLES::
+
+            sage: S.<x,y,z> = PolynomialRing(QQ)
+            sage: M = S**2
+            sage: N = M.submodule([vector([x - y, z]), vector([y*z, x*z])])
+            sage: Q = M.quotient_module(N)
+            sage: Q.gen(0)
+            (1, 0)
+        """
+        if i < 0 or i >= self._module.degree():
+            raise ValueError('generator %s not defined' % i)
+        return self.gens()[i]
+
+    def _coerce_map_from_(self, M):
+        """
+        Return a coercion map from `M` to ``self``, or ``None``.
+
+        TESTS::
+
+            sage: S.<x,y,z> = PolynomialRing(QQ)
+            sage: M = S**2
+            sage: N = M.submodule([vector([x - y, z]), vector([y*z, x*z])])
+            sage: Q = M.quotient_module(N)
+            sage: Q.coerce_map_from(M)
+            Coercion map:
+              From: Ambient free module of rank 2 over the integral domain
+                    Multivariate Polynomial Ring in x, y, z over Rational Field
+              To:   Quotient module by Submodule of
+                    Ambient free module of rank 2 over the integral domain
+                    Multivariate Polynomial Ring in x, y, z over Rational Field
+                    Generated by the rows of the matrix:
+                    [x - y     z]
+                    [  y*z   x*z]
+        """
+        if isinstance(M, FreeModule_ambient):
+            return (self.base_ring().has_coerce_map_from(M.base_ring()) and
+                    self.degree() == M.degree())
+        from sage.modules.submodule import Submodule_free_ambient
+        if isinstance(M, Submodule_free_ambient):
+            return self._module.has_coerce_map_from(self.ambient_module())
+        if (isinstance(M, QuotientModule_free_ambient)
+                and M.free_cover() == self.free_cover()):
+            try:
+                return M.free_relations().is_submodule(self.free_relations())
+            except NotImplementedError:
+                pass
+
+    def ambient_module(self):
+        """
+        Return ``self``, since ``self`` is ambient.
+
+        EXAMPLES::
+
+            sage: S.<x,y,z> = PolynomialRing(QQ)
+            sage: M = S**2
+            sage: N = M.submodule([vector([x - y, z]), vector([y*z, x*z])])
+            sage: Q = M.quotient_module(N)
+            sage: Q.ambient_module() is Q
+            True
+        """
+        return self
+
+    def cover(self):
+        r"""
+        Given this quotient space `Q = V/W`, return `V`.
+
+        EXAMPLES::
+
+            sage: S.<x,y,z> = PolynomialRing(QQ)
+            sage: M = S**2
+            sage: N = M.submodule([vector([x - y, z]), vector([y*z, x*z])])
+            sage: Q = M.quotient_module(N)
+            sage: Q.cover() is M
+            True
+        """
+        return self._module
+
+    V = cover
+
+    def relations(self):
+        r"""
+        Given this quotient space `Q = V/W`, return `W`.
+
+        EXAMPLES::
+
+            sage: S.<x,y,z> = PolynomialRing(QQ)
+            sage: M = S**2
+            sage: N = M.submodule([vector([x - y, z]), vector([y*z, x*z])])
+            sage: Q = M.quotient_module(N)
+            sage: Q.relations() is N
+            True
+        """
+        return self._sub
+
+    W = relations
+
+    def free_cover(self):
+        r"""
+        Given this quotient space `Q = V/W`, return the free module
+        that covers `V`.
+
+        EXAMPLES::
+
+            sage: S.<x,y,z> = PolynomialRing(QQ)
+            sage: M = S**2
+            sage: N = M.submodule([vector([x - y, z]), vector([y*z, x*z])])
+            sage: Q = M / N
+            sage: NQ = Q.submodule([Q([1,x])])
+            sage: QNQ = Q / NQ
+            sage: QNQ.free_cover() is Q.free_cover() is M
+            True
+
+        Note that this is different than the immediate cover::
+
+            sage: QNQ.cover() is Q
+            True
+            sage: QNQ.cover() is QNQ.free_cover()
+            False
+        """
+        return self._free_cover
+
+    V = cover
+
+    def free_relations(self):
+        r"""
+        Given this quotient space `Q = V/W`, return the submodule that
+        generates all relations of `Q`.
+
+        When `V` is a free module, then this returns `W`. Otherwise this
+        returns the union of `W` lifted to the cover of `V` and the relations
+        of `V` (repeated until `W` is a submodule of a free module).
+
+        EXAMPLES::
+
+            sage: S.<x,y,z> = PolynomialRing(QQ)
+            sage: M = S**2
+            sage: N = M.submodule([vector([x - y, z]), vector([y*z, x*z])])
+            sage: Q = M / N
+            sage: NQ = Q.submodule([Q([1, x])])
+            sage: QNQ = Q / NQ
+            sage: QNQ.free_relations()
+            Submodule of Ambient free module of rank 2 over the integral domain
+            Multivariate Polynomial Ring in x, y, z over Rational Field
+            Generated by the rows of the matrix:
+            [    1     x]
+            [x - y     z]
+            [  y*z   x*z]
+
+        Note that this is different than the defining relations::
+
+            sage: QNQ.relations() is NQ
+            True
+            sage: QNQ.relations() == QNQ.free_relations()
+            False
+        """
+        return self._relations
+
+
+###############################################################################
+#
+# Quotients of ambient free modules over a field
+#
+###############################################################################
+
+class FreeModule_ambient_field_quotient(FreeModule_ambient_field):
+    """
+    A quotient `V/W` of two vector spaces as a vector space.
+
+    To obtain `V` or `W` use ``self.V()`` and ``self.W()``.
+
+    EXAMPLES::
+
+        sage: # needs sage.rings.number_field
+        sage: k.<i> = QuadraticField(-1)
+        sage: A = k^3; V = A.span([[1,0,i], [2,i,0]])
+        sage: W = A.span([[3,i,i]])
+        sage: U = V/W; U
+        Vector space quotient V/W of dimension 1 over Number Field in i
+         with defining polynomial x^2 + 1 with i = 1*I where
+         V: Vector space of degree 3 and dimension 2 over Number Field in i
+            with defining polynomial x^2 + 1 with i = 1*I
+            Basis matrix:
+            [ 1  0  i]
+            [ 0  1 -2]
+         W: Vector space of degree 3 and dimension 1 over Number Field in i
+            with defining polynomial x^2 + 1 with i = 1*I
+            Basis matrix:
+            [    1 1/3*i 1/3*i]
+        sage: U.V()
+        Vector space of degree 3 and dimension 2 over Number Field in i
+         with defining polynomial x^2 + 1 with i = 1*I
+         Basis matrix:
+         [ 1  0  i]
+         [ 0  1 -2]
+        sage: U.W()
+        Vector space of degree 3 and dimension 1 over Number Field in i
+         with defining polynomial x^2 + 1 with i = 1*I
+         Basis matrix:
+         [    1 1/3*i 1/3*i]
+        sage: U.quotient_map()
+        Vector space morphism represented by the matrix:
+        [  1]
+        [3*i]
+        Domain:   Vector space of degree 3 and dimension 2 over Number Field in i
+                  with defining polynomial x^2 + 1 with i = 1*I
+                  Basis matrix:
+                  [ 1  0  i]
+                  [ 0  1 -2]
+        Codomain: Vector space quotient V/W of dimension 1 over Number Field in i
+                  with defining polynomial x^2 + 1 with i = 1*I where
+                  V: Vector space of degree 3 and dimension 2 over Number Field in i
+                     with defining polynomial x^2 + 1 with i = 1*I
+                     Basis matrix:
+                     [ 1  0  i]
+                     [ 0  1 -2]
+                  W: Vector space of degree 3 and dimension 1 over Number Field in i
+                     with defining polynomial x^2 + 1 with i = 1*I
+                     Basis matrix:
+                     [    1 1/3*i 1/3*i]
+        sage: Z = V.quotient(W)
+        sage: Z == U
+        True
+
+    We create three quotient spaces and compare them::
+
+        sage: A = QQ^2
+        sage: V = A.span_of_basis([[1,0], [1,1]])
+        sage: W0 = V.span([V.1, V.0])
+        sage: W1 = V.span([V.1])
+        sage: W2 = V.span([V.1])
+        sage: Q0 = V/W0
+        sage: Q1 = V/W1
+        sage: Q2 = V/W2
+
+        sage: Q0 == Q1
+        False
+        sage: Q1 == Q2
+        True
+
+    TESTS::
+
+        sage: A = QQ^0; V = A.span([])  # corner case
+        sage: W = A.span([])
+        sage: U = V/W
+
+        sage: loads(dumps(U)) == U
+        True
+        sage: type(loads(dumps(U)) )
+        <class 'sage.modules.quotient_module.FreeModule_ambient_field_quotient_with_category'>
+    """
+    def __init__(self, domain, sub, quotient_matrix, lift_matrix, inner_product_matrix=None):
+        """
+        Create this quotient space, from the given domain, submodule,
+        and quotient_matrix.
+
+        EXAMPLES::
+
+            sage: A = QQ^5; V = A.span_of_basis([[1,0,-1,1,1], [1,-1,0,2/3,3/4]]); V
+            Vector space of degree 5 and dimension 2 over Rational Field
+            User basis matrix:
+            [  1   0  -1   1   1]
+            [  1  -1   0 2/3 3/4]
+            sage: W = V.span_of_basis([V.0 - 2/3*V.1]); W
+            Vector space of degree 5 and dimension 1 over Rational Field
+            User basis matrix:
+            [1/3 2/3  -1 5/9 1/2]
+
+        This creates a quotient vector space::
+
+            sage: Q = V / W
+
+        Behold the type of Q::
+
+            sage: type(Q)
+            <class 'sage.modules.quotient_module.FreeModule_ambient_field_quotient_with_category'>
+
+        We do some consistency checks on the extra quotient and
+        lifting structure of Q::
+
+            sage: Q(V.0)
+            (1)
+            sage: Q(V.0 - 2/3*V.1)
+            (0)
+            sage: v = Q.lift(Q.0); v
+            (1, 0, -1, 1, 1)
+            sage: Q( v )
+            (1)
+        """
+        base_field = domain.base_field()
+        dimension = quotient_matrix.ncols()
+        sparse = domain.is_sparse()
+        self._sub = sub
+        self._domain = domain
+        self.__hash = hash((domain, sub))
+        FreeModule_ambient_field.__init__(self, base_field, dimension, sparse)
+        self.__quo_map = domain.Hom(self)(quotient_matrix)
+        self.__quo_map.register_as_coercion()
+        self.__lift_map = self.Hom(domain)(lift_matrix)
+
+    def _repr_(self):
+        r"""
+        Return the rather verbose string representation of this quotient space V/W.
+
+        EXAMPLES:
+
+        We create a quotient vector space over a finite field::
+
+            sage: # needs sage.rings.finite_rings
+            sage: k.<a> = GF(9); A = k^3; V = A.span_of_basis([[1,0,a], [a,a,1]]); W = V.span([V.1])
+            sage: Q = V/W
+
+        Note the type::
+
+            sage: type(Q)                                                               # needs sage.rings.finite_rings
+            <class 'sage.modules.quotient_module.FreeModule_ambient_field_quotient_with_category'>
+
+        The string representation mentions that this is a quotient
+        `V/W`, that the quotient has dimension 1 and is over a finite
+        field, and also describes `V` and `W`::
+
+            sage: Q._repr_()                                                            # needs sage.rings.finite_rings
+            'Vector space quotient V/W of dimension 1 over Finite Field in a of size 3^2 where\nV: Vector space of degree 3 and dimension 2 over Finite Field in a of size 3^2\nUser basis matrix:\n[1 0 a]\n[a a 1]\nW: Vector space of degree 3 and dimension 1 over Finite Field in a of size 3^2\nBasis matrix:\n[    1     1 a + 2]'
+        """
+        return "%s space quotient V/W of dimension %s over %s where\nV: %s\nW: %s" % (
+            "Sparse vector" if self.is_sparse() else "Vector",
+            self.dimension(), self.base_ring(),
+            self.V(), self.W())
+
+    def __hash__(self):
+        """
+        Return hash of this quotient space `V/W`, which is, by definition,
+        the hash of the tuple `(V, W)`.
+
+        EXAMPLES:
+
+        We compute the hash of a certain 0-dimension quotient vector
+        space::
+
+            sage: A = QQ^2; V = A.span_of_basis([[1,0], [1,1]]); W = V.span([V.1, V.0])
+            sage: Q = V/W; Q.dimension()
+            0
+            sage: hash(Q) == hash((V,W))
+            True
+        """
+        return self.__hash
+
+    def _element_constructor_(self, x):
+        """
+        Convert an element into this quotient space `V/W` if there is
+        a way to make sense of it.
+
+        An element converts into ``self`` if it can be converted into `V`,
+        or if not at least if it can be made sense of as a list of
+        length the dimension of ``self``.
+
+        EXAMPLES:
+
+        We create a 2-dimensional quotient of a 3-dimension ambient
+        vector space::
+
+            sage: M = QQ^3 / [[1,2,3]]
+
+        A list of length 3 converts into ``QQ^3``, so it converts into
+        `M`::
+
+            sage: M([1,2,4])  #indirect doctest
+            (-1/3, -2/3)
+            sage: M([1,2,3])
+            (0, 0)
+
+        A list of length 2 converts into M, where here it just gives
+        the corresponding linear combination of the basis for `M`::
+
+            sage: M([1,2])
+            (1, 2)
+            sage: M.0 + 2*M.1
+            (1, 2)
+
+        Of course, elements of ``QQ^3`` convert into the quotient
+        module as well. Here is a different example::
+
+            sage: V = QQ^3; W = V.span([[1,0,0]]); Q = V/W
+            sage: Q(V.0)
+            (0, 0)
+            sage: Q(V.1)
+            (1, 0)
+            sage: Q.0
+            (1, 0)
+            sage: Q.0 + V.1
+            (2, 0)
+
+        Here we start with something that is over ZZ, so it
+        canonically coerces into ``QQ^3``, hence into ``self``::
+
+            sage: Q((ZZ^3)([1,2,3]))
+            (2, 3)
+
+        TESTS:
+
+        Ensure that :issue:`39507` is fixed::
+
+            sage: V = VectorSpace(GF(2),3)
+            sage: A = V.subspace([(0,1,0), (1,1,1)])
+            sage: B = A.subspace([])
+            sage: list(A/B)
+            [(0, 0), (1, 0), (0, 1), (1, 1)]
+        """
+        if isinstance(x, self.element_class) and x.parent() is self:
+            return x
+        if isinstance(x, (list, tuple)) and len(x) == self._domain.rank():
+            return self.__quo_map(self._domain.linear_combination_of_basis(x))
+        return FreeModule_ambient_field._element_constructor_(self, x)
+
+    def _coerce_map_from_(self, M):
+        """
+        Return a coercion map from `M` to ``self``, or None.
+
+        EXAMPLES::
+
+            sage: V = QQ^2 / [[1, 2]]
+            sage: V.coerce_map_from(ZZ^2)
+            Composite map:
+              From: Ambient free module of rank 2 over the principal ideal domain Integer Ring
+              To:   Vector space quotient V/W of dimension 1 over Rational Field where
+                    V: Vector space of dimension 2 over Rational Field
+                    W: Vector space of degree 2 and dimension 1 over Rational Field
+                       Basis matrix:
+                       [1 2]
+              Defn:   Coercion map:
+                      From: Ambient free module of rank 2 over the principal ideal domain Integer Ring
+                      To:   Vector space of dimension 2 over Rational Field
+                    then
+                      Vector space morphism represented by the matrix:
+                      [   1]
+                      [-1/2]
+                      Domain:   Vector space of dimension 2 over Rational Field
+                      Codomain: Vector space quotient V/W of dimension 1 over Rational Field where
+                                V: Vector space of dimension 2 over Rational Field
+                                W: Vector space of degree 2 and dimension 1 over Rational Field
+                                   Basis matrix:
+                                   [1 2]
+
+        Make sure :issue:`10513` is fixed (no coercion from an abstract
+        vector space to an isomorphic quotient vector space)::
+
+            sage: V = QQ^3 / [[1,2,3]]
+            sage: V.coerce_map_from(QQ^2)
+        """
+        from sage.modules.free_module import FreeModule_ambient
+        if (isinstance(M, FreeModule_ambient)
+            and not (isinstance(M, FreeModule_ambient_field_quotient)
+                     and self._sub == M._sub)):
+            # No map between different quotients.
+            # No map from quotient to abstract module.
+            return None
+        f = super(FreeModule_ambient_field, self)._coerce_map_from_(M)
+        if f is not None:
+            return f
+        f = self._domain.coerce_map_from(M)
+        if f is not None:
+            return self.__quo_map * f
+        return None
+
+    def quotient_map(self):
+        """
+        Given this quotient space `Q = V / W`, return the natural quotient
+        map from `V` to `Q`.
+
+        EXAMPLES::
+
+            sage: M = QQ^3 / [[1,2,3]]
+            sage: M.quotient_map()
+            Vector space morphism represented by the matrix:
+            [   1    0]
+            [   0    1]
+            [-1/3 -2/3]
+            Domain:   Vector space of dimension 3 over Rational Field
+            Codomain: Vector space quotient V/W of dimension 2 over Rational Field where
+                      V: Vector space of dimension 3 over Rational Field
+                      W: Vector space of degree 3 and dimension 1 over Rational Field
+                      Basis matrix:
+                      [1 2 3]
+
+            sage: M.quotient_map()( (QQ^3)([1,2,3]) )
+            (0, 0)
+        """
+        return self.__quo_map
+
+    def lift_map(self):
+        r"""
+        Given this quotient space `Q = V / W`, return a fixed choice of
+        linear homomorphism (a section) from `Q` to `V`.
+
+        EXAMPLES::
+
+            sage: M = QQ^3 / [[1,2,3]]
+            sage: M.lift_map()
+            Vector space morphism represented by the matrix:
+            [1 0 0]
+            [0 1 0]
+            Domain:   Vector space quotient V/W of dimension 2 over Rational Field where
+                      V: Vector space of dimension 3 over Rational Field
+                      W: Vector space of degree 3 and dimension 1 over Rational Field
+                         Basis matrix:
+                         [1 2 3]
+            Codomain: Vector space of dimension 3 over Rational Field
+        """
+        return self.__lift_map
+
+    def lift(self, x):
+        r"""
+        Lift element of this quotient `V / W` to `V` by applying
+        the fixed lift homomorphism.
+
+        The lift is a fixed homomorphism.
+
+        EXAMPLES::
+
+            sage: M = QQ^3 / [[1,2,3]]
+            sage: M.lift(M.0)
+            (1, 0, 0)
+            sage: M.lift(M.1)
+            (0, 1, 0)
+            sage: M.lift(M.0 - 2*M.1)
+            (1, -2, 0)
+        """
+        return self.__lift_map(x)
+
+    def cover(self):
+        r"""
+        Given this quotient space `Q = V/W`, return `V`.
+
+        EXAMPLES::
+
+            sage: M = QQ^10 / [list(range(10)), list(range(2,12))]
+            sage: M.cover()
+            Vector space of dimension 10 over Rational Field
+        """
+        return self._domain
+
+    V = cover
+
+    def relations(self):
+        r"""
+        Given this quotient space `Q = V/W`, return `W`.
+
+        EXAMPLES::
+
+            sage: M = QQ^10 / [list(range(10)), list(range(2,12))]
+            sage: M.relations()
+            Vector space of degree 10 and dimension 2 over Rational Field
+            Basis matrix:
+            [ 1  0 -1 -2 -3 -4 -5 -6 -7 -8]
+            [ 0  1  2  3  4  5  6  7  8  9]
+        """
+        return self._sub
+
+    W = relations