Skip to content
This repository has been archived by the owner on Jan 30, 2023. It is now read-only.

Commit

Permalink
improve docs (seealso, links, etc)
Browse files Browse the repository at this point in the history
  • Loading branch information
dkrenn committed Aug 25, 2015
1 parent 27601ba commit e1acc40
Showing 1 changed file with 45 additions and 4 deletions.
49 changes: 45 additions & 4 deletions src/sage/rings/asymptotic/growth_group.py
Original file line number Diff line number Diff line change
Expand Up @@ -1519,7 +1519,7 @@ def _pushout_(self, other):
sage: cm.record_exceptions()
sage: cm.common_parent(GrowthGroup('x^ZZ'), GrowthGroup('y^ZZ'))
Growth Group x^ZZ * y^ZZ
sage: sage.structure.element.coercion_traceback()
sage: sage.structure.element.coercion_traceback() # not tested
"""
if isinstance(other, GenericGrowthGroup):
pass
Expand Down Expand Up @@ -1701,6 +1701,14 @@ class AbstractGrowthGroupFunctor(ConstructionFunctor):
sage: from sage.rings.asymptotic.growth_group import GrowthGroup
sage: GrowthGroup('z^QQ').construction()[0] # indirect doctest
MonomialGrowthGroup[z]
.. SEEALSO::
:mod:`sage.rings.asymptotic.asymptotic_ring`,
:class:`ExponentialGrowthGroupFunctor`,
:class:`MonomialGrowthGroupFunctor`,
:class:`sage.rings.asymptotic.asymptotic_ring.AsyptoticRingFunctor`,
:class:`sage.categories.pushout.ConstructionFunctor`.
"""

_functor_name = 'AbstractGrowthGroup'
Expand Down Expand Up @@ -2278,18 +2286,27 @@ def gens_monomial(self):

def construction(self):
r"""
Return the construction of this growth group.
OUTPUT:
A pair whose first entry is a
:class:`monomial construction functor <MonomialGrowthGroupFunctor>`
and its second entry the base.
EXAMPLES::
sage: from sage.rings.asymptotic.growth_group import GrowthGroup
sage: GrowthGroup('x^ZZ').construction()
(MonomialGrowthGroup[x], Integer Ring)
"""
"""
return MonomialGrowthGroupFunctor(self._var_), self.base()


class MonomialGrowthGroupFunctor(AbstractGrowthGroupFunctor):
r"""
A construction functor for :class:`monomial growth groups <MonomialGrowthGroup>`.
A :class:`construction functor <sage.categories.pushout.ConstructionFunctor>`
for :class:`monomial growth groups <MonomialGrowthGroup>`.
INPUT:
Expand All @@ -2302,6 +2319,14 @@ class MonomialGrowthGroupFunctor(AbstractGrowthGroupFunctor):
sage: GrowthGroup('z^QQ').construction()[0]
MonomialGrowthGroup[z]
.. SEEALSO::
:mod:`sage.rings.asymptotic.asymptotic_ring`,
:class:`AbstractGrowthGroupFunctor`,
:class:`ExponentialGrowthGroupFunctor`,
:class:`sage.rings.asymptotic.asymptotic_ring.AsyptoticRingFunctor`,
:class:`sage.categories.pushout.ConstructionFunctor`.
TESTS::
sage: from sage.rings.asymptotic.growth_group import GrowthGroup, MonomialGrowthGroupFunctor
Expand Down Expand Up @@ -2745,6 +2770,14 @@ def gens(self):

def construction(self):
r"""
Return the construction of this growth group.
OUTPUT:
A pair whose first entry is an
:class:`exponential construction functor <ExponentialGrowthGroupFunctor>`
and its second entry the base.
EXAMPLES::
sage: from sage.rings.asymptotic.growth_group import GrowthGroup
Expand All @@ -2756,7 +2789,7 @@ def construction(self):

class ExponentialGrowthGroupFunctor(AbstractGrowthGroupFunctor):
r"""
A construction functor for
A :class:`construction functor <sage.categories.pushout.ConstructionFunctor>`
:class:`exponential growth groups <ExponentialGrowthGroup>`.
INPUT:
Expand All @@ -2770,6 +2803,14 @@ class ExponentialGrowthGroupFunctor(AbstractGrowthGroupFunctor):
sage: GrowthGroup('QQ^z').construction()[0]
ExponentialGrowthGroup[z]
.. SEEALSO::
:mod:`sage.rings.asymptotic.asymptotic_ring`,
:class:`AbstractGrowthGroupFunctor`,
:class:`MonomialGrowthGroupFunctor`,
:class:`sage.rings.asymptotic.asymptotic_ring.AsyptoticRingFunctor`,
:class:`sage.categories.pushout.ConstructionFunctor`.
TESTS::
sage: from sage.rings.asymptotic.growth_group import GrowthGroup, ExponentialGrowthGroupFunctor
Expand Down

0 comments on commit e1acc40

Please sign in to comment.