functions PowerSeries.ogf() and egf() named wrong

[rwst]

The functions PowerSeries.ogf() and egf() are named wrong

The documentation states: Returns the ordinary generating function associated to self. But the function is a wrapper for the Pari function serlaplace() which actually converts to ordinary g.f. in the case of an exponential g.f.

Example: 1+x+x<sup>2+x</sup>3+x<sup>4+O(x</sup>5) is generated both by 1/(1-x)+O(x^5) or itself, but:

sage: R.<x> = PowerSeriesRing(ZZ)
sage: (1+x+x^2+x^3+x^4+O(x^5)).ogf()
1 + x + 2*x^2 + 6*x^3 + 24*x^4

which is clearly wrong given name and definition.

So, I hope you agree it's necessary if I rename ogf() to egf_to_ogf() and egf() to ogf_to_egf() and adapt the docs.

Component: combinatorics

Keywords: series ogf

Author: Ralf Stephan

Branch/Commit: 813a807

Reviewer: Nathann Cohen

Issue created by migration from https://trac.sagemath.org/ticket/15705

[rwst]

Branch: u/rws/ticket/15705

[rwst]

New commits:

4b79c25

Trac #15705: PowerSeries.ogf() and .egf(): match name and definition to behaviour

[rwst]

Commit: 4b79c25

[rwst]

comment:6

It appears that we would have to deprecate the old names first.

[sagetrac-git]

Changed commit from 4b79c25 to 85b5f9b

[sagetrac-git]

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

4f8c7be	Merge branch 'develop' into ticket/15705
bbc5196	Merge branch 'develop' into ticket/15705
85b5f9b	add back ogf() and egf() with deprecation warning; fix doctests

[rwst]

Changed author from rws to Ralf Stephan

[sagetrac-git]

Changed commit from 85b5f9b to 019861a

[sagetrac-git]

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

019861a

Merge branch 'develop' (6.2.beta4) into ticket/15705

[nathanncohen]

comment:10

Hellooooooooo !

You should probably use deprecated_function_alias.

http://www.sagemath.org/doc/developer/coding_in_python.html#deprecation

Nathann

[sagetrac-git]

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

daaf616	Merge branch 'develop' into rev/15705
4ae59be	use deprecated_function_alias() instead

[sagetrac-git]

Changed commit from 019861a to 4ae59be

[rwst]

comment:12

You're right!

[nathanncohen]

Changed branch from u/rws/ticket/15705 to public/15705

[nathanncohen]

Changed commit from 4ae59be to 813a807

[nathanncohen]

Reviewer: Nathann Cohen

[nathanncohen]

comment:13

Hmmmmm... at first I did not like the new names at all, and prefered .to_egf() and .to_ogf(), but the way you did it will make it the easiest to find for new users... Hmmmm.... !

I just added a small commit on top of yours to fix two things:

1. The ogf=... and egf=... had a wrong indentation level

2. The deprecated_function_alias function was not imported

All tests pass. If you agree with my changes you can set the ticket to positive_review.

Nathann

---

New commits:

813a807

trac #15705: reviewer's patch

[vbraun]

Changed branch from public/15705 to 813a807