Add support for B-terms in Asymptotic Ring

[gh-thhagelmayer]

Add support for B-terms in Asymptotic Ring.

[gh-thhagelmayer]

I have implemented the initial functions for the usage of B-terms in AsymptoticRing.

I have three doctest errors:

File "src/sage/rings/asymptotic/asymptotic_ring.py", line 4691, in sage.rings.asymptotic.asymptotic_ring.AsymptoticRing.B
Failed example:
    A.B(2*x^3, {x: 5})
Exception raised:
    Traceback (most recent call last):
      File "/home/thhagelmayer/sagemath-trac-mirror/local/lib/python3.8/site-packages/sage/doctest/forker.py", line 718, in _run
        self.compile_and_execute(example, compiler, test.globs)
      File "/home/thhagelmayer/sagemath-trac-mirror/local/lib/python3.8/site-packages/sage/doctest/forker.py", line 1137, in compile_and_execute
        exec(compiled, globs)
      File "<doctest sage.rings.asymptotic.asymptotic_ring.AsymptoticRing.B[1]>", line 1, in <module>
        A.B(Integer(2)*x**Integer(3), {x: Integer(5)})
      File "/home/thhagelmayer/sagemath-trac-mirror/local/lib/python3.8/site-packages/sage/rings/asymptotic/asymptotic_ring.py", line 4694, in B
        return self.B(valid_from)
      File "/home/thhagelmayer/sagemath-trac-mirror/local/lib/python3.8/site-packages/sage/rings/asymptotic/asymptotic_ring.py", line 3400, in B
        return sum(self.parent().create_summand('B', growth=element, valid_from=valid_from)
      File "/home/thhagelmayer/sagemath-trac-mirror/local/lib/python3.8/site-packages/sage/rings/asymptotic/asymptotic_ring.py", line 3400, in <genexpr>
        return sum(self.parent().create_summand('B', growth=element, valid_from=valid_from)
      File "/home/thhagelmayer/sagemath-trac-mirror/local/lib/python3.8/site-packages/sage/rings/asymptotic/asymptotic_ring.py", line 4612, in create_summand
        return self(TM(data, **kwds), simplify=False, convert=False)
      File "sage/structure/parent.pyx", line 900, in sage.structure.parent.Parent.__call__ (build/cythonized/sage/structure/parent.c:9365)
        return mor._call_with_args(x, args, kwds)
      File "sage/structure/coerce_maps.pyx", line 180, in sage.structure.coerce_maps.DefaultConvertMap_unique._call_with_args (build/cythonized/sage/structure/coerce_maps.c:5153)
        raise
      File "sage/structure/coerce_maps.pyx", line 170, in sage.structure.coerce_maps.DefaultConvertMap_unique._call_with_args (build/cythonized/sage/structure/coerce_maps.c:4943)
        return C._element_constructor(x, **kwds)
      File "/home/thhagelmayer/sagemath-trac-mirror/local/lib/python3.8/site-packages/sage/rings/asymptotic/term_monoid.py", line 1829, in _element_constructor_
        return self._create_element_(data.growth, data.coefficient)
    TypeError: _create_element_() missing 1 required positional argument: 'valid_from'

The other two are the same from src/sage/rings/asymptotic/asymptotic_ring.py", line 3379 and src/sage/rings/asymptotic/asymptotic_ring.py", line 3381.

---

Last 10 new commits:

​8e5e0e4	Trac #31933. Item 65. Modify examples with explanation of valid_from to test the examples.
​76d9bcc	Trac #31933. Fix docbuild issue
​7e758a3	Trac #31933 review: unify spelling B-term
​786bd48	Trac #31933 review: simplfy doctests by using factory
​760a9df	Trac #31933 review: minor changes to docstrings etc
​0afd7bf	Trac #31933 Fix doctests after merge
​33452c3	Trac #31933. Item 67. Fix WARNING-Block and Various formatting.
​bf9ff54	Trac #31933. Avoid trailing comma in latex repr.
​5a3c5b1	Trac #31933. Item 65. Fix Examples for valid_from with explanation.
​5c5079d	Trac #32278. Added initial support for B-terms. Doctests are failing for now

[dkrenn]

Replying to gh-thhagelmayer:

I have implemented the initial functions for the usage of B-terms in AsymptoticRing.

I have three doctest errors:

File "src/sage/rings/asymptotic/asymptotic_ring.py", line 4691, in sage.rings.asymptotic.asymptotic_ring.AsymptoticRing.B
Failed example:
    A.B(2*x^3, {x: 5})
Exception raised:
    Traceback (most recent call last):
    ...
    TypeError: _create_element_() missing 1 required positional argument: 'valid_from'

The other two are the same from src/sage/rings/asymptotic/asymptotic_ring.py", line 3379 and src/sage/rings/asymptotic/asymptotic_ring.py", line 3381.

My guess, it seems like they could go away by #32229. (But anyways, it would need to be A.B(2*x^3, valid_from={x: 5}).

[git]

Branch pushed to git repo; I updated commit sha1. Last 10 new commits:

​d076a0d	Trac #31933. Item 83: remove unused import
​343ddd8	Trac #31933. Item 84: correct spelling
​ff4747b	Trac #31933. Item 86: make f-string an fr-string
​f62e7ed	Trac #31933. Item 87: use the same description for MonomialGrowthElement._find_minimum_ as in GenericGrowthElement
​832c80f	Trac #31933. Item 88: remove 'the' in the acknowledgements to have consistency
​2e46c20	Trac #31933. Item 85: BTerm.__init__: Replace >= by \ge in all TeX formatted code
​309d1e1	Merge branch 't/31933/initial_support_for_bterms' into t/32229/bterms_conversion
​9e5b3fb	Trac #32229: fix doctests
​766067f	Merge branch 't/32229/bterms_conversion' into t/32278/add_support_for_b_terms_in_asymptotic_ring
​1e201ea	Trac #32278: fix doctests

[gh-thhagelmayer]

I merged #32229 into this ticket. Afterwards I could fix the doctests which were failing.

---

Last 10 new commits:

​d076a0d	Trac #31933. Item 83: remove unused import
​343ddd8	Trac #31933. Item 84: correct spelling
​ff4747b	Trac #31933. Item 86: make f-string an fr-string
​f62e7ed	Trac #31933. Item 87: use the same description for MonomialGrowthElement._find_minimum_ as in GenericGrowthElement
​832c80f	Trac #31933. Item 88: remove 'the' in the acknowledgements to have consistency
​2e46c20	Trac #31933. Item 85: BTerm.__init__: Replace >= by \ge in all TeX formatted code
​309d1e1	Merge branch 't/31933/initial_support_for_bterms' into t/32229/bterms_conversion
​9e5b3fb	Trac #32229: fix doctests
​766067f	Merge branch 't/32229/bterms_conversion' into t/32278/add_support_for_b_terms_in_asymptotic_ring
​1e201ea	Trac #32278: fix doctests

[git]

Branch pushed to git repo; I updated commit sha1. New commits:

​4798c10	Trac #32278. moved valid_from logic from asymptotic_ring to term_monoid. corrected a doctest.
​ca748e2	Trac #32278: Fix doctests in misc.py
​6d9ea89	Trac #32278. moved logic from asymptoic_ring.py to term_monoid.py. fixed non working tests.

[gh-thhagelmayer]

I moved the logic from asymptotic_ring to term_monoid and fixed the doctests.

[behackl]

This looks pretty functional already. Here are some remarks:

1. AsymptoticExpansion.B: The tests in the docstring use AsymptoticRing.B (which is fine in principle, but the corresponding lines should be marked with # indirect doctest then) -- either do this, or alternatively rewrite the tests to use AsymptoticExpansion.B.

2. AsymptoticExpansion.B, AsymptoticRing.B, BTerm: The docstring, in particular: the description of valid_from, should mention the "short syntax" where passing a number instead of a dictionary uses the number as the lower bound for all variables occurring in the term.

3. AsymptoticExpansion.B - Is there a particular reason that valid_from is just a positional argument, and not a keyword argument with default value 0 (like for AsymptoticRing.B?)

4. NotImplementedBZeroError: Maybe add a straightforward test like

   sage: AR.<n> = AsymptoticRing('n^QQ', QQ)
   sage: AR(0).B(42)
   Traceback (most recent call last):
   ...
   NotImplementedBZero: got B(0)
   The error term B(0) means 0 for sufficiently large n.
   

[git]

Branch pushed to git repo; I updated commit sha1. New commits:

​586ef6f	Trac #32278. Item 4: add test for NotImplementedBZero Error
​351d659	Trac #32278. Item 1: add comment for indirect doctest
​28c3984	Trac #32278. Items 2 and 3: added information of the short syntax to the docstring. AsymptoticExpansion.B make valid_from a keyword argument with default value 0

[gh-thhagelmayer]

Replying to behackl:

Thank you for the comments.

3. AsymptoticExpansion.B - Is there a particular reason that valid_from is just a positional argument, and not a keyword argument with default value 0 (like for AsymptoticRing.B?)

I thought it is not important to make the valid_from a keyword argument in AsymptoticExpansion.B, since it is already a keyword argument in AsymptoticRing.B. I changed it now, because I think it is more correct to have it this way.

[behackl]

since it is already a keyword argument in AsymptoticRing.B

I see. I think it makes sense to make sure the type of arguments are consistent across the methods.

5. sage: (2*x).B({x: 20}) # indirect doctest -- this is actually not indirect, there you do use AsymptoticExpansion.B.

6. "If you pass only a number as valid_from": I suggest to rephrase this as "If a number is passed to valid_from, ...".

7. (2., continued): The docstring of BTerm should also be changed accordingly.

[git]

Branch pushed to git repo; I updated commit sha1. New commits:

​1df00da	Trac #32278. Items 6 and 7: correct docstring
​52b734d	Trac #32278. Item 5: remove "# indirect doctest"

[gh-thhagelmayer]

5. sage: (2*x).B({x: 20}) # indirect doctest -- this is actually not indirect, there you do use AsymptoticExpansion.B.

6. "If you pass only a number as valid_from": I suggest to rephrase this as "If a number is passed to valid_from, ...".

7. (2., continued): The docstring of BTerm should also be changed accordingly.

I have addressed these items.

[behackl]

I've added one small commit to resolve a wording problem in the docstring, please cross-check.

Otherwise, this looks good to me now, thank you.

---

New commits:

​a57a275

Trac #32278: fix singular/plural problem in docstrings

[git]

Branch pushed to git repo; I updated commit sha1 and set ticket back to needs_review. Last 10 new commits:

​2f9c6b6	Trac #32214: unify dash in monoid repr
​f7c1823	Merge branch 't/32214/term-monoids-unify-repr' into t/32215/refactor-element-construction-term-monoids
​ba8efe6	Merge branch 'u/gh-thhagelmayer/refactor-element-construction-term-monoids' of git://trac.sagemath.org/sage into t/32215/refactor-element-construction-term-monoids
​51e035f	Trac #32215: fix doctests (due to merge of #32214)
​d763d66	Trac #32215: full coverage of _element_constructor_
​540d088	Merge commit 'c11b2f4' into t/32215/refactor-element-construction-term-monoids
​62cae10	Trac #32215: fix doctest after merge
​a84a2f2	Merge branch 'u/dkrenn/refactor-element-construction-term-monoids' of trac.sagemath.org:sage into t/32229/bterms_conversion
​84ad7a3	Trac #32229: take absolute value of coefficient of BTerm
​2474870	Merge branch 'u/behackl/bterms_conversion' of trac.sagemath.org:sage into t/32278/add_support_for_b_terms_in_asymptotic_ring

[behackl]

Merged latest version of dependencies.

[cheuberg]

Replying to behackl:

4. NotImplementedBZeroError: Maybe add a straightforward test like

   sage: AR.<n> = AsymptoticRing('n^QQ', QQ)
   sage: AR(0).B(42)
   Traceback (most recent call last):
   ...
   NotImplementedBZero: got B(0)
   The error term B(0) means 0 for sufficiently large n.
   

Minor remark concerning this error message: "sufficiently large n" could be replaced by |n| >= 42, because we actually know what "sufficiently large" means.

[behackl]

I'm still not sure what causes the patchbot failure. Would it make sense to move this to the latest beta?

[cheuberg]

Replying to behackl:

I'm still not sure what causes the patchbot failure. Would it make sense to move this to the latest beta?

A merge conflict has to be resolved, so moving to the latest beta is probably a good idea.