Change all occurrences of "method" to "algorithm"

[rlmill]

In a discussion with David, we realized that he's been using "method" for "algorithm" in several places. This fix will follow up on #5701, and will probably depend on the patches there.

CC: @wdjoyner

Component: coding theory

Author: David Joyner, William Stein, Johan Sebastian Rosenkilde Nielsen

Reviewer: Rob Beezer, Robert Miller

Merged: sage-4.6.1.alpha3

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

[jasongrout]

comment:1

"method" is not only easier to say, but it's easier to spell, and probably is more memorable to people...

[rlmill]

comment:2

Replying to @jasongrout:

"method" is not only easier to say, but it's easier to spell, and probably is more memorable to people...

It is also not the standard arg name. If you think method is better, take it to the mailing list.

[jasongrout]

comment:3

okay, I didn't realize there was a standard. The weight of history changes the situation a bit.

[rlmill]

comment:4

Replying to @jasongrout:

okay, I didn't realize there was a standard...

Actually, neither did I. But when David and I did a search for "method=", most of what we found were places where he was using that name.

In fact, here is a complete (I think) list of the functions which use this (4.0.alpha0):

calculus/desolvers.py: eulers_method, eulers_method_2x2
coding/decoder.py: decode
coding/linear_code.py: decode, is_permutation_equivalent, permutation_automorphism_group, spectrum
finance/easter.py: easter
combinat/designs/block_design.py: ProjectiveGeometryDesign
combinat/designs/covering_design.py: __init__, method
combinat/designs/incidence_structures.py: dual_incidence_structure
groups/matrix_gps/matrix_group.py: as_permutation_group, module_composition_factors
schemes/elliptic_curves/padic_lseries.py: frobenius
matrix/matrix_double_dense.pyx: exp
matrix/matrix_modn_sparse.pyx: _rank_linbox
rings/polynomial/polynomial_compiled.pyx: __init__

[wdjoyner]

comment:5

Thanks. I'll get to these when #5701 is applied unless someone says I should just create a patch based on the patches there.

[wdjoyner]

based on 4.0.rc0 and all patches in #5701

[wdjoyner]

comment:6

Attachment: trac_6094-method-vs-algorithm.patch.gz

The current patch passes sage -testall with guava removed and all patched on #5701 applied.

[jhpalmieri]

comment:8

Fails to apply cleanly to Sage 4.0.1.

applying /home/palmieri/trac_6094-method-vs-algorithm.patch
patching file sage/coding/linear_code.py
Hunk #1 FAILED at 315
Hunk #2 FAILED at 341
Hunk #3 FAILED at 351
Hunk #5 FAILED at 1144
Hunk #6 FAILED at 1165
Hunk #11 FAILED at 1636
Hunk #12 FAILED at 1651
Hunk #13 FAILED at 1668
Hunk #15 FAILED at 1758
Hunk #22 FAILED at 2179
10 out of 23 hunks FAILED -- saving rejects to file sage/coding/linear_code.py.rej
patching file sage/combinat/designs/block_design.py
Hunk #2 FAILED at 89
1 out of 3 hunks FAILED -- saving rejects to file sage/combinat/designs/block_design.py.rej
abort: patch failed to apply

[wdjoyner]

comment:9

I don't know how to rebase. Can someone point me to a reference? I might be able to do it this weekend.

[williamstein]

Attachment: trac_6094-rebased_against_4.3.1.rc0.patch.gz

I rebased this against 4.3.1.rc0.

[rbeezer]

Reviewer: Rob Beezer

[rbeezer]

comment:11

Passes all tests. There are more instances of the use of method= in coding/code_bounds.py which will have a patch at #7971. Positive review.

[rbeezer]

Author: David Joyner, William Stein

[williamstein]

comment:13

It was pointed out by people in our status reports session that this patch violates our deprecation policy. Yuck. I.e., technically we should do

def f(algorithm='default', method=None):
    if method is not None:
        deprecation('...')
        algorithm = method

basically everywhere, then remove them all in a year. Hmmmm....

[rbeezer]

comment:14

I've sent this back to "needs work" to await deprecation warnings. With more to do, include the changes in ccoding/code_bounds.py here as part of this ticket (see #7971).

[williamstein]

comment:15

I wonder if it could be done with a decorator?

@deprecate_method
def f(..., method="foo"):
    ...

[johanrosenkilde]

comment:26

By the way, this patch contains all changes which were at one point suggested to be contained in Trac #7971. That trac can therefore be closed/invalidated.

[rlmill]

Changed reviewer from Rob Beezer to Rob Beezer, Robert Miller

[rlmill]

comment:27

If I apply #6094, #9907, #9919, and #10107 together on top of sage-4.6, all long tests pass. The code looks good.

I have also closed #7971.

[jdemeyer]

Work Issues: rebase

[jdemeyer]

comment:28

The patch needs to be rebased to sage-4.6.1.alpha0:

patching file doc/en/constructions/linear_codes.rst
patching file sage/calculus/desolvers.py
Hunk #1 succeeded at 61 (offset 3 lines).
Hunk #2 succeeded at 829 (offset 117 lines).
Hunk #3 succeeded at 854 (offset 117 lines).
Hunk #4 succeeded at 886 (offset 117 lines).
Hunk #5 succeeded at 900 (offset 117 lines).
Hunk #6 succeeded at 938 (offset 117 lines).
Hunk #7 succeeded at 994 (offset 117 lines).
patching file sage/coding/code_bounds.py
patching file sage/coding/decoder.py
patching file sage/coding/linear_code.py
Hunk #1 succeeded at 202 (offset 2 lines).
Hunk #2 succeeded at 322 (offset 2 lines).
Hunk #3 succeeded at 359 (offset 2 lines).
Hunk #4 succeeded at 369 (offset 2 lines).
Hunk #5 succeeded at 1115 (offset 2 lines).
Hunk #6 succeeded at 1143 (offset 2 lines).
Hunk #7 succeeded at 1164 (offset 2 lines).
Hunk #8 succeeded at 1174 (offset 2 lines).
Hunk #9 succeeded at 1535 (offset 2 lines).
Hunk #10 succeeded at 1556 (offset 2 lines).
Hunk #11 succeeded at 1580 (offset 2 lines).
Hunk #12 succeeded at 1716 (offset 2 lines).
Hunk #13 succeeded at 1731 (offset 2 lines).
Hunk #14 succeeded at 1745 (offset 2 lines).
Hunk #15 succeeded at 1775 (offset 2 lines).
Hunk #16 succeeded at 1814 (offset 2 lines).
Hunk #17 succeeded at 1871 (offset 2 lines).
Hunk #18 succeeded at 1891 (offset 2 lines).
Hunk #19 succeeded at 1905 (offset 2 lines).
Hunk #20 succeeded at 1937 (offset 2 lines).
Hunk #21 succeeded at 1954 (offset 2 lines).
Hunk #22 succeeded at 2289 (offset 13 lines).
Hunk #23 succeeded at 2307 (offset 13 lines).
Hunk #24 succeeded at 2326 (offset 13 lines).
Hunk #25 succeeded at 2387 (offset 13 lines).
patching file sage/combinat/designs/block_design.py
patching file sage/combinat/designs/incidence_structures.py
patching file sage/finance/easter.py
patching file sage/groups/matrix_gps/matrix_group.py
patching file sage/interfaces/ecm.py
patching file sage/matrix/matrix_double_dense.pyx
Hunk #4 FAILED at 1524.
Hunk #5 succeeded at 1544 (offset 1 line).
Hunk #6 succeeded at 1567 (offset 1 line).
1 out of 6 hunks FAILED -- saving rejects to file sage/matrix/matrix_double_dense.pyx.rej
patching file sage/matrix/matrix_modn_sparse.pyx
Hunk #2 succeeded at 778 with fuzz 2.
Hunk #3 succeeded at 791 with fuzz 2.
patching file sage/rings/polynomial/polynomial_compiled.pyx
patching file sage/schemes/elliptic_curves/padic_lseries.py
patching file sage/symbolic/expression.pyx
Hunk #2 succeeded at 6443 (offset 745 lines).
Hunk #3 succeeded at 6452 (offset 745 lines).
Hunk #4 succeeded at 6504 (offset 745 lines).
Hunk #5 succeeded at 6642 (offset 745 lines).
Hunk #6 succeeded at 6651 (offset 745 lines).
Hunk #7 succeeded at 6698 (offset 745 lines).
Hunk #8 succeeded at 6718 (offset 745 lines).
Hunk #9 succeeded at 6734 (offset 745 lines).
Hunk #10 succeeded at 6760 (offset 745 lines).
Hunk #11 succeeded at 6827 (offset 745 lines).
Hunk #12 succeeded at 6864 (offset 745 lines).

[johanrosenkilde]

Rebased for 4.6.1.alpha0. Still requires patches for #9919 and #9907 (in that order)

[johanrosenkilde]

comment:29

Attachment: trac_6094-4.6.1.alpha0.with_deprecation.patch.gz

[johanrosenkilde]

comment:30

Robert Miller already gave the green light to the old version, so the review is only for the minor change in sage.matrix.matrix_double_dense made for rebasing.

[rlmill]

Changed work issues from rebase to none

[jdemeyer]

Merged: sage-4.6.1.alpha3

[jdemeyer]

Changed author from David Joyner, William Stein, Johan S. R. Nielsen to David Joyner, William Stein, Johan Sebastian Rosenkilde Nielsen