deprecate substitution via __call__ w/ unnamed arguments

[sagetrac-cwitty]

As discussed on sage-devel here: http://groups.google.com/group/sage-devel/browse_thread/thread/b1a03f8fc8ae8fcd/553773d7ba600ae7#553773d7ba600ae7

I added deprecation warnings to the four affected __call__ functions (two for symbolic values, one for equations, one for matrices), and fixed almost all the warnings in all the doctests other than the doctests specifically for those __call__ methods.

There's one set of warnings that I didn't figure out how to fix (in piecewise.py), so I just added the warning to the expected output for now.

CC: @jasongrout

Component: calculus

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

[sagetrac-mabshoff]

comment:1

Two trivial doctest failures:

sage -t -long devel/sage/doc/en/constructions/calculus.rst # 1 doctests failed
sage -t -long devel/sage/doc/fr/tutorial/tour_algebra.rst # 1 doctests failed

Cheers,

Michael

[sagetrac-cwitty]

comment:3

Attachment: deprecate-symbolic-unnamed-call.patch.gz

Oops, forgot to doctest the documentation. I've replaced my original patch with a new one that also fixes these two doctest failures.

[jasongrout]

comment:4

This is an (email) reminder to myself to review this to get it in.

[jasongrout]

comment:5

This ticket probably also affects #5093.

[burcin]

comment:6

Thanks for working on this Carl.

I only read the patch, didn't test it yet. Explicitly having to use .function() in two places bothers me:

• for each component of Piecewise
• in the call to generate_plot_points

Perhaps we should modify these to handle non function arguments more gracefully after this change.

I understand that this might require a new syntax to construct Piecewise objects. One option is to add a new parameter, which includes an ordered list of variables. E.g.,

    sage: Piecewise([[(0,1),x^2],[(1,2),5-x^2]] ,[x])

or

    sage: f = Piecewise([[(-1,1),1/2+x-x^3 + y]],[x,y])

Comments?

[jasongrout]

comment:7

The above comment for Piecewise would probably also apply to symbolic matrices and vectors, right? (well, at least, as soon as symbolic vectors are callable, anyway). I think that Burcin's proposal is okay, but doesn't extend very well to matrices and vectors, since I'd hate to mess up the standard matrix/vector constructors. I'm don't know a better way to extend this to matrices and vectors, though. Maybe we ought to just deprecate calling a symbolic matrix without keyword arguments, and just implement the callable symbolic vector with the same restrictions.

[sagetrac-cwitty]

comment:8

The patch already does deprecate calling a symbolic matrix without keyword arguments.

[jasongrout]

comment:9

Yes. I thought Burcin's comment was about a syntax to avoid the .function() call. That's what I was commenting on.

[sagetrac-cwitty]

comment:10

After discussions on IRC and sage-devel (http://groups.google.com/group/sage-devel/browse_thread/thread/97cdf80edb089481/73e8e6659c09e1d9#73e8e6659c09e1d9) we've decided on a much more extensive deprecation scheme. So it's not worth reviewing the current patch. (I should have a new patch within a few days.)

[sagetrac-cwitty]

comment:11

Attachment: trac5413-deprecate-symbolic-unnamed-call.patch.gz

I've posted a patch that implements the more extensive deprecation described here: http://groups.google.com/group/sage-devel/browse_thread/thread/97cdf80edb089481#

The patch now depends on #5093.

Apply only the second patch.

[jasongrout]

comment:12

This is really odd:

[19:53] <jason> sage: g(x)=sin
[19:53] <jason> sage: g(3)
[19:53] <jason> sin(3)
[19:53] <jason> sage: g(x)=sin+x
[19:53] <jason> sage: g(3)
[19:53] <jason> sin + 3
[19:54] <jason> but
[19:54] <jason> sage: g(x)=sin+cos; g(3)
[19:54] <jason> sin + cos

[burcin]

comment:13

Jason, I get the same behavior without Carl's patch on Sage-3.4. I suggest moving that to a separate ticket. We could also argue if that is valid syntax there.

I give a positive review to this. It would be good to get this in an alpha and let more people play with it. Thanks again Carl.

Cheers,
Burcin

[burcin]

comment:14

comment:12 is now #5607.

[jasongrout]

comment:15

I agree that we should get this into the alpha so it gets wider exposure. (providing doctests pass) positive review from me too.

[sagetrac-mabshoff]

comment:16

There is one tiny doctest issue left - at least in my merge tree :)

sage -t -long "devel/sage/doc/en/constructions/calculus.rst"
**********************************************************************
File "/scratch/mabshoff/sage-3.4.1.alpha0/devel/sage/doc/en/constructions/calculus.rst", line 222:
    sage: f.integral()
Expected:
    Piecewise defined function with 2 parts, [[(0, 1), x^3/3], [(1, 2), (15*x - x^3)/3 - 13/3]]
Got:
    Piecewise defined function with 2 parts, [[(0, 1), x |--> x^3/3], [(1, 2), x |--> (15*x - x^3)/3 - 13/3]]
**********************************************************************
1 items had failures:
   1 of   9 in __main__.example_8
***Test Failed*** 1 failures.
For whitespace errors, see the file /scratch/mabshoff/sage-3.4.1.alpha0/tmp/.doctest_calculus.py
	 [4.3 s]
exit code: 1024

I am fixing this with a reviewer patch.

Cheers,

Michael

[sagetrac-mabshoff]

Attachment: trac_5413-reviewer.patch.gz

[sagetrac-mabshoff]

comment:17

Merged trac5413-deprecate-symbolic-unnamed-call.patch and trac_5413-reviewer.patch in Sage 3.4.1.alpha0.

Cheers,

Michael