passagemath-categories 10.6.32__cp314-cp314t-musllinux_1_2_aarch64.whl

sage/categories/examples/magmas.py

@@ -0,0 +1,162 @@
+# sage_setup: distribution = sagemath-categories
+r"""
+Examples of magmas
+"""
+# ****************************************************************************
+#       Copyright (C) 2020 Markus Wageringel <markus.wageringel+gh@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.misc.cachefunc import cached_method
+from sage.structure.parent import Parent
+from sage.structure.unique_representation import UniqueRepresentation
+from sage.structure.element_wrapper import ElementWrapper
+from sage.categories.magmas import Magmas
+from sage.sets.family import Family
+
+
+class FreeMagma(UniqueRepresentation, Parent):
+    r"""
+    An example of magma.
+
+    The purpose of this class is to provide a minimal template for
+    implementing a magma.
+
+    EXAMPLES::
+
+        sage: M = Magmas().example(); M
+        An example of a magma: the free magma generated by ('a', 'b', 'c', 'd')
+
+    This is the free magma generated by::
+
+        sage: M.magma_generators()
+        Family ('a', 'b', 'c', 'd')
+        sage: a, b, c, d = M.magma_generators()
+
+    and with a non-associative product given by::
+
+        sage: a * (b * c) * (d * a * b)
+        '((a*(b*c))*((d*a)*b))'
+        sage: a * (b * c) == (a * b) * c
+        False
+
+    TESTS::
+
+        sage: TestSuite(M).run()
+    """
+    def __init__(self, alphabet=('a', 'b', 'c', 'd')):
+        r"""
+        The free magma.
+
+        INPUT:
+
+        - ``alphabet`` -- tuple of strings; the generators of the magma
+
+        EXAMPLES::
+
+            sage: from sage.categories.examples.magmas import FreeMagma
+            sage: F = FreeMagma(('a', 'b', 'c')); F
+            An example of a magma: the free magma generated by ('a', 'b', 'c')
+
+        TESTS::
+
+            sage: F == loads(dumps(F))
+            True
+        """
+        if any('(' in x or ')' in x or '*' in x for x in alphabet):
+            raise ValueError("alphabet must not contain characters "
+                             "'(', ')' or '*'")
+        if not alphabet:
+            raise NotImplementedError("free magma must have at least one generator")
+
+        self.alphabet = alphabet
+
+        Parent.__init__(self, category=Magmas().FinitelyGenerated().Infinite())
+
+    def _repr_(self):
+        r"""
+        EXAMPLES::
+
+            sage: from sage.categories.examples.magmas import FreeMagma
+            sage: FreeMagma(('a', 'b', 'c'))._repr_()
+            "An example of a magma: the free magma generated by ('a', 'b', 'c')"
+        """
+        return ("An example of a magma: the free magma generated by %s"
+                % (self.alphabet,))
+
+    def product(self, x, y):
+        r"""
+        Return the product of ``x`` and ``y`` in the magma, as per
+        :meth:`Magmas.ParentMethods.product`.
+
+        EXAMPLES::
+
+            sage: F = Magmas().example()
+            sage: F('a') * F.an_element()
+            '(a*(((a*b)*c)*d))'
+        """
+        assert x in self
+        assert y in self
+        return self("(%s*%s)" % (x.value, y.value))
+
+    @cached_method
+    def magma_generators(self):
+        r"""
+        Return the generators of the magma.
+
+        EXAMPLES::
+
+            sage: F = Magmas().example()
+            sage: F.magma_generators()
+            Family ('a', 'b', 'c', 'd')
+        """
+        return Family([self(i) for i in self.alphabet])
+
+    def an_element(self):
+        r"""
+        Return an element of the magma.
+
+        EXAMPLES::
+
+            sage: F = Magmas().example()
+            sage: F.an_element()
+            '(((a*b)*c)*d)'
+        """
+        gens = self.magma_generators()
+        x = gens.first()
+        for y in gens.iterator_range(1):
+            x *= y
+        return x
+
+    def _element_constructor_(self, x):
+        r"""
+        Construct an element of this magma from the data ``x``.
+
+        INPUT:
+
+        - ``x`` -- string
+
+        EXAMPLES::
+
+            sage: F = Magmas().example(); F
+            An example of a magma: the free magma generated by ('a', 'b', 'c', 'd')
+            sage: F._element_constructor_('a')
+            'a'
+            sage: F._element_constructor_('(a*(b*c))')
+            '(a*(b*c))'
+        """
+        return self.element_class(self, x)
+
+    class Element(ElementWrapper):
+        r"""
+        The class for elements of the free magma.
+        """
+        wrapped_class = str
+
+
+Example = FreeMagma

sage/categories/examples/manifolds.py

@@ -0,0 +1,94 @@
+# sage_setup: distribution = sagemath-categories
+"""
+Examples of manifolds
+"""
+# ****************************************************************************
+#  Copyright (C) 2015 Travis Scrimshaw <tscrim at ucdavis.edu>
+#
+#  Distributed under the terms of the GNU General Public License (GPL)
+#                  https://www.gnu.org/licenses/
+# *****************************************************************************
+from sage.structure.parent import Parent
+from sage.structure.unique_representation import UniqueRepresentation
+from sage.structure.element_wrapper import ElementWrapper
+from sage.categories.manifolds import Manifolds
+
+
+class Plane(UniqueRepresentation, Parent):
+    r"""
+    An example of a manifold: the `n`-dimensional plane.
+
+    This class illustrates a minimal implementation of a manifold.
+
+    EXAMPLES::
+
+        sage: from sage.categories.manifolds import Manifolds
+        sage: M = Manifolds(QQ).example(); M
+        An example of a Rational Field manifold: the 3-dimensional plane
+
+        sage: M.category()
+        Category of manifolds over Rational Field
+
+    We conclude by running systematic tests on this manifold::
+
+        sage: TestSuite(M).run()
+    """
+
+    def __init__(self, n=3, base_ring=None):
+        r"""
+        EXAMPLES::
+
+            sage: from sage.categories.manifolds import Manifolds
+            sage: M = Manifolds(QQ).example(6); M
+            An example of a Rational Field manifold: the 6-dimensional plane
+
+        TESTS::
+
+            sage: TestSuite(M).run()
+        """
+        self._n = n
+        Parent.__init__(self, base=base_ring, category=Manifolds(base_ring))
+
+    def _repr_(self):
+        r"""
+        TESTS::
+
+            sage: from sage.categories.manifolds import Manifolds
+            sage: Manifolds(QQ).example()
+            An example of a Rational Field manifold: the 3-dimensional plane
+        """
+        return "An example of a {} manifold: the {}-dimensional plane".format(
+                self.base_ring(), self._n)
+
+    def dimension(self):
+        """
+        Return the dimension of ``self``.
+
+        EXAMPLES::
+
+            sage: from sage.categories.manifolds import Manifolds
+            sage: M = Manifolds(QQ).example()
+            sage: M.dimension()
+            3
+        """
+        return self._n
+
+    def an_element(self):
+        r"""
+        Return an element of the manifold, as per
+        :meth:`Sets.ParentMethods.an_element`.
+
+        EXAMPLES::
+
+            sage: from sage.categories.manifolds import Manifolds
+            sage: M = Manifolds(QQ).example()
+            sage: M.an_element()
+            (0, 0, 0)
+        """
+        zero = self.base_ring().zero()
+        return self(tuple([zero]*self._n))
+
+    Element = ElementWrapper
+
+
+Example = Plane

sage/categories/examples/monoids.py

@@ -0,0 +1,144 @@
+# sage_setup: distribution = sagemath-categories
+r"""
+Examples of monoids
+"""
+#*****************************************************************************
+#  Copyright (C) 2008-2009 Nicolas M. Thiery <nthiery at users.sf.net>
+#
+#  Distributed under the terms of the GNU General Public License (GPL)
+#                  http://www.gnu.org/licenses/
+#******************************************************************************
+
+from sage.misc.cachefunc import cached_method
+from sage.structure.parent import Parent
+from sage.structure.element_wrapper import ElementWrapper
+from sage.categories.monoids import Monoids
+from .semigroups import FreeSemigroup
+from sage.sets.family import Family
+
+
+class FreeMonoid(FreeSemigroup):
+    r"""
+    An example of a monoid: the free monoid.
+
+    This class illustrates a minimal implementation of a monoid. For a
+    full featured implementation of free monoids, see :func:`FreeMonoid`.
+
+    EXAMPLES::
+
+        sage: S = Monoids().example(); S
+        An example of a monoid: the free monoid generated by ('a', 'b', 'c', 'd')
+
+        sage: S.category()
+        Category of monoids
+
+    This is the free semigroup generated by::
+
+        sage: S.semigroup_generators()
+        Family ('a', 'b', 'c', 'd')
+
+    with product rule given by concatenation of words::
+
+        sage: S('dab') * S('acb')
+        'dabacb'
+
+    and unit given by the empty word::
+
+        sage: S.one()
+        ''
+
+    We conclude by running systematic tests on this monoid::
+
+        sage: TestSuite(S).run(verbose = True)
+        running ._test_an_element() . . . pass
+        running ._test_associativity() . . . pass
+        running ._test_cardinality() . . . pass
+        running ._test_category() . . . pass
+        running ._test_construction() . . . pass
+        running ._test_elements() . . .
+          Running the test suite of self.an_element()
+          running ._test_category() . . . pass
+          running ._test_eq() . . . pass
+          running ._test_new() . . . pass
+          running ._test_not_implemented_methods() . . . pass
+          running ._test_pickling() . . . pass
+          pass
+        running ._test_elements_eq_reflexive() . . . pass
+        running ._test_elements_eq_symmetric() . . . pass
+        running ._test_elements_eq_transitive() . . . pass
+        running ._test_elements_neq() . . . pass
+        running ._test_eq() . . . pass
+        running ._test_new() . . . pass
+        running ._test_not_implemented_methods() . . . pass
+        running ._test_one() . . . pass
+        running ._test_pickling() . . . pass
+        running ._test_prod() . . . pass
+        running ._test_some_elements() . . . pass
+    """
+
+    def __init__(self, alphabet=('a','b','c','d')):
+        r"""
+        The free monoid.
+
+        INPUT:
+
+        - ``alphabet`` -- tuple of strings; the generators of the monoid
+
+        EXAMPLES::
+
+            sage: M = Monoids().example(alphabet=('a','b','c')); M
+            An example of a monoid: the free monoid generated by ('a', 'b', 'c')
+
+        TESTS::
+
+            sage: TestSuite(M).run()
+        """
+        self.alphabet = alphabet
+        Parent.__init__(self, category=Monoids())
+
+    def _repr_(self):
+        r"""
+        TESTS::
+
+            sage: M = Monoids().example(alphabet=('a','b','c'))
+            sage: M._repr_()
+            "An example of a monoid: the free monoid generated by ('a', 'b', 'c')"
+        """
+        return "An example of a monoid: the free monoid generated by %s" % (self.alphabet,)
+
+    @cached_method
+    def one(self):
+        r"""
+        Return the one of the monoid, as per :meth:`Monoids.ParentMethods.one`.
+
+        EXAMPLES::
+
+            sage: M = Monoids().example(); M
+            An example of a monoid: the free monoid generated by ('a', 'b', 'c', 'd')
+            sage: M.one()
+            ''
+        """
+        return self("")
+
+    @cached_method
+    def monoid_generators(self):
+        r"""
+        Return the generators of this monoid.
+
+        EXAMPLES::
+
+            sage: M = Monoids().example(); M
+            An example of a monoid: the free monoid generated by ('a', 'b', 'c', 'd')
+            sage: M.monoid_generators()
+            Finite family {'a': 'a', 'b': 'b', 'c': 'c', 'd': 'd'}
+            sage: a,b,c,d = M.monoid_generators()
+            sage: a*d*c*b
+            'adcb'
+        """
+        return Family(self.alphabet, self)
+
+    class Element (ElementWrapper):
+        wrapped_class = str
+
+
+Example = FreeMonoid

sage/categories/examples/posets.py

@@ -0,0 +1,178 @@
+# sage_setup: distribution = sagemath-categories
+"""
+Examples of posets
+"""
+#*****************************************************************************
+#  Copyright (C) 2011 Nicolas M. Thiery <nthiery at users.sf.net>
+#
+#  Distributed under the terms of the GNU General Public License (GPL)
+#                  http://www.gnu.org/licenses/
+#******************************************************************************
+
+from sage.structure.parent import Parent
+from sage.structure.unique_representation import UniqueRepresentation
+from sage.categories.posets import Posets
+from sage.structure.element_wrapper import ElementWrapper
+from sage.sets.set import Set, Set_object_enumerated
+from sage.sets.positive_integers import PositiveIntegers
+
+
+class FiniteSetsOrderedByInclusion(UniqueRepresentation, Parent):
+    r"""
+    An example of a poset: finite sets ordered by inclusion.
+
+    This class provides a minimal implementation of a poset
+
+    EXAMPLES::
+
+        sage: P = Posets().example(); P
+        An example of a poset: sets ordered by inclusion
+
+    We conclude by running systematic tests on this poset::
+
+        sage: TestSuite(P).run(verbose = True)
+        running ._test_an_element() . . . pass
+        running ._test_cardinality() . . . pass
+        running ._test_category() . . . pass
+        running ._test_construction() . . . pass
+        running ._test_elements() . . .
+          Running the test suite of self.an_element()
+          running ._test_category() . . . pass
+          running ._test_eq() . . . pass
+          running ._test_new() . . . pass
+          running ._test_not_implemented_methods() . . . pass
+          running ._test_pickling() . . . pass
+          pass
+        running ._test_elements_eq_reflexive() . . . pass
+        running ._test_elements_eq_symmetric() . . . pass
+        running ._test_elements_eq_transitive() . . . pass
+        running ._test_elements_neq() . . . pass
+        running ._test_eq() . . . pass
+        running ._test_new() . . . pass
+        running ._test_not_implemented_methods() . . . pass
+        running ._test_pickling() . . . pass
+        running ._test_some_elements() . . . pass
+    """
+
+    def __init__(self):
+        r"""
+        EXAMPLES::
+
+            sage: P = Posets().example(); P
+            An example of a poset: sets ordered by inclusion
+            sage: P.category()
+            Category of posets
+            sage: type(P)
+            <class 'sage.categories.examples.posets.FiniteSetsOrderedByInclusion_with_category'>
+            sage: TestSuite(P).run()
+        """
+        Parent.__init__(self, category=Posets())
+
+    def _repr_(self):
+        r"""
+        TESTS::
+
+            sage: S = Posets().example()
+            sage: S._repr_()
+            'An example of a poset: sets ordered by inclusion'
+        """
+        return "An example of a poset: sets ordered by inclusion"
+
+    def le(self, x, y):
+        r"""
+        Return whether `x` is a subset of `y`.
+
+        EXAMPLES::
+
+            sage: P = Posets().example()
+            sage: P.le( P(Set([1,3])), P(Set([1,2,3])) )
+            True
+            sage: P.le( P(Set([1,3])), P(Set([1,3])) )
+            True
+            sage: P.le( P(Set([1,2])), P(Set([1,3])) )
+            False
+        """
+        return x.value.issubset(y.value)
+
+    def an_element(self):
+        r"""
+        Return an element of this poset.
+
+        EXAMPLES::
+
+            sage: B = Posets().example()
+            sage: B.an_element()
+            {1, 4, 6}
+        """
+        return self(Set([1,4,6]))
+
+    class Element(ElementWrapper):
+
+        wrapped_class = Set_object_enumerated
+
+
+class PositiveIntegersOrderedByDivisibilityFacade(UniqueRepresentation, Parent):
+    r"""
+    An example of a facade poset: the positive integers ordered by divisibility.
+
+    This class provides a minimal implementation of a facade poset
+
+    EXAMPLES::
+
+        sage: P = Posets().example("facade"); P
+        An example of a facade poset: the positive integers ordered by divisibility
+
+        sage: P(5)
+        5
+        sage: P(0)
+        Traceback (most recent call last):
+        ...
+        ValueError: Can't coerce `0` in any parent `An example of a facade poset: the positive integers ordered by divisibility` is a facade for
+
+        sage: 3 in P
+        True
+        sage: 0 in P
+        False
+    """
+
+    element_class = type(Set([]))
+
+    def __init__(self):
+        r"""
+        EXAMPLES::
+
+            sage: P = Posets().example("facade"); P
+            An example of a facade poset: the positive integers ordered by divisibility
+            sage: P.category()
+            Category of facade posets
+            sage: type(P)
+            <class 'sage.categories.examples.posets.PositiveIntegersOrderedByDivisibilityFacade_with_category'>
+            sage: TestSuite(P).run()
+        """
+        Parent.__init__(self, facade=(PositiveIntegers(),), category=Posets())
+
+    def _repr_(self):
+        r"""
+        TESTS::
+
+            sage: S = Posets().example("facade")
+            sage: S._repr_()
+            'An example of a facade poset: the positive integers ordered by divisibility'
+        """
+        return "An example of a facade poset: the positive integers ordered by divisibility"
+
+    def le(self, x, y):
+        r"""
+        Return whether `x` is divisible by `y`.
+
+        EXAMPLES::
+
+            sage: P = Posets().example("facade")
+            sage: P.le(3, 6)
+            True
+            sage: P.le(3, 3)
+            True
+            sage: P.le(3, 7)
+            False
+        """
+        return x.divides(y)