Skip to content

Commit 28c162e

Browse files
author
Release Manager
committed
gh-39043: Some documentation clean-up Consolidate the description. Previously it was scattered into 3 different places. also some minor changes (now `mwrank_lib` is the default as I read from the code) ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [x] The title is concise and informative. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. (not aware of one) - [x] I have created tests covering the changes. (no functional change) - [x] I have updated the documentation and checked the documentation preview. URL: #39043 Reported by: user202729 Reviewer(s): Travis Scrimshaw, user202729
2 parents ffb5410 + f1c6b07 commit 28c162e

File tree

4 files changed

+57
-52
lines changed

4 files changed

+57
-52
lines changed

src/sage/libs/eclib/interface.py

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -268,21 +268,28 @@ def two_descent(self, verbose=True, selmer_only=False, first_limit=20,
268268
269269
- ``selmer_only`` -- boolean (default: ``False``); ``selmer_only`` switch
270270
271-
- ``first_limit`` -- integer (default: 20); bound on `|x|+|z|` in
272-
quartic point search
273-
274-
- ``second_limit`` -- integer (default: 8); bound on
275-
`\log \max(|x|,|z|)`, i.e. logarithmic
276-
277-
- ``n_aux`` -- integer (default: -1); (only relevant for general
278-
2-descent when 2-torsion trivial) number of primes used for
279-
quartic search. ``n_aux=-1`` causes default (8) to be used.
280-
Increase for curves of higher rank.
281-
282-
- ``second_descent`` -- boolean (default: ``True``); (only relevant
283-
for curves with 2-torsion, where mwrank uses descent via
284-
2-isogeny) flag determining whether or not to do second
285-
descent. *Default strongly recommended.*
271+
- ``first_limit`` -- integer (default: 20); naive height bound on
272+
first point search on quartic homogeneous spaces (before
273+
testing local solubility; very simple search with no
274+
overheads).
275+
276+
- ``second_limit`` -- integer (default: 8); logarithmic height bound on
277+
second point search on quartic homogeneous spaces (after
278+
testing local solubility; sieve-assisted search)
279+
280+
- ``n_aux`` -- integer (default: -1); if positive, the number of
281+
auxiliary primes used in sieve-assisted search for quartics.
282+
If -1 (the default) use a default value (set in the eclib
283+
code in ``src/qrank/mrank1.cc`` in DEFAULT_NAUX: currently 8).
284+
Only relevant for curves with no 2-torsion, where full
285+
2-descent is carried out. Worth increasing for curves
286+
expected to be of rank > 6 to one or two more than the
287+
expected rank.
288+
289+
- ``second_descent`` -- boolean (default: ``True``); flag specifying
290+
whether or not a second descent will be carried out. Only relevant
291+
for curves with 2-torsion. Recommended left as the default except for
292+
experts interested in details of Selmer groups.
286293
287294
OUTPUT: nothing
288295

src/sage/libs/eclib/mwrank.pyx

Lines changed: 5 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -992,29 +992,11 @@ cdef class _two_descent:
992992
points. Useful as a faster way of getting an upper bound on
993993
the rank.
994994
995-
- ``firstlim`` -- integer (default: 20); naive height bound on
996-
first point search on quartic homogeneous spaces (before
997-
testing local solubility; very simple search with no
998-
overheads).
999-
1000-
- ``secondlim`` -- integer (default: 8); naive height bound on
1001-
second point search on quartic homogeneous spaces (after
1002-
testing local solubility; sieve-assisted search)
1003-
1004-
- ``n_aux`` -- integer (default: -1); if positive, the number of
1005-
auxiliary primes used in sieve-assisted search for quartics.
1006-
If -1 (the default) use a default value (set in the eclib
1007-
code in ``src/qrank/mrank1.cc`` in DEFAULT_NAUX: currently 8).
1008-
Only relevant for curves with no 2-torsion, where full
1009-
2-descent is carried out. Worth increasing for curves
1010-
expected to be of rank > 6 to one or two more than the
1011-
expected rank.
1012-
1013-
- ``second_descent`` -- integer (default: 1); flag specifying
1014-
whether or not a second descent will be carried out (yes if
1015-
1, the default; no if 0). Only relevant for curves with
1016-
2-torsion. Recommended left as the default except for
1017-
experts interested in details of Selmer groups.
995+
- ``firstlim``, ``secondlim``, ``n_aux``, ``second_descent`` --
996+
see ``first_limit``, ``second_limit``, ``n_aux``, ``second_descent``
997+
respectively in :meth:`~sage.libs.eclib.interface.mwrank_EllipticCurve.two_descent`
998+
(although ``second_descent`` here is ``1`` or ``0`` instead of ``True`` or ``False``
999+
respectively)
10181000
10191001
OUTPUT: none
10201002

src/sage/modules/free_module_element.pyx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4047,7 +4047,7 @@ cdef class FreeModuleElement(Vector): # abstract base class
40474047
Differentiate with respect to var by differentiating each element
40484048
with respect to var.
40494049

4050-
.. seealso:
4050+
.. SEEALSO::
40514051

40524052
:meth:`derivative`
40534053

src/sage/schemes/elliptic_curves/ell_rational_field.py

Lines changed: 29 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -808,16 +808,28 @@ def two_descent(self, verbose=True,
808808
809809
- ``selmer_only`` -- boolean (default: ``False``); selmer_only switch
810810
811-
- ``first_limit`` -- (default: 20) firstlim is bound
812-
on x+z second_limit- (default: 8) secondlim is bound on log max
813-
x,z , i.e. logarithmic
814-
815-
- ``n_aux`` -- (default: -1) n_aux only relevant for
816-
general 2-descent when 2-torsion trivial; n_aux=-1 causes default
817-
to be used (depends on method)
818-
819-
- ``second_descent`` -- (default: ``True``)
820-
second_descent only relevant for descent via 2-isogeny
811+
- ``first_limit`` -- integer (default: 20); naive height bound on
812+
first point search on quartic homogeneous spaces (before
813+
testing local solubility; very simple search with no
814+
overheads).
815+
816+
- ``second_limit`` -- integer (default: 8); logarithmic height bound on
817+
second point search on quartic homogeneous spaces (after
818+
testing local solubility; sieve-assisted search)
819+
820+
- ``n_aux`` -- integer (default: -1); if positive, the number of
821+
auxiliary primes used in sieve-assisted search for quartics.
822+
If -1 (the default) use a default value (set in the eclib
823+
code in ``src/qrank/mrank1.cc`` in DEFAULT_NAUX: currently 8).
824+
Only relevant for curves with no 2-torsion, where full
825+
2-descent is carried out. Worth increasing for curves
826+
expected to be of rank > 6 to one or two more than the
827+
expected rank.
828+
829+
- ``second_descent`` -- boolean (default: ``True``); flag specifying
830+
whether or not a second descent will be carried out. Only relevant
831+
for curves with 2-torsion. Recommended left as the default except for
832+
experts interested in details of Selmer groups.
821833
822834
OUTPUT:
823835
@@ -2256,9 +2268,9 @@ def gens(self, proof=None, **kwds):
22562268
22572269
- ``algorithm`` -- one of the following:
22582270
2259-
- ``'mwrank_shell'`` -- default; call mwrank shell command
2271+
- ``'mwrank_lib'`` -- default; call mwrank C library
22602272
2261-
- ``'mwrank_lib'`` -- call mwrank C library
2273+
- ``'mwrank_shell'`` -- call mwrank shell command
22622274
22632275
- ``'pari'`` -- use ellrank in pari
22642276
@@ -2268,7 +2280,11 @@ def gens(self, proof=None, **kwds):
22682280
- ``use_database`` -- boolean (default: ``True``); if ``True``, attempts to
22692281
find curve and gens in the (optional) database
22702282
2271-
- ``descent_second_limit`` -- (default: 12) used in 2-descent
2283+
- ``descent_second_limit`` -- (default: 12); logarithmic height bound on
2284+
second point search on quartic homogeneous spaces (after
2285+
testing local solubility; sieve-assisted search). Used in 2-descent.
2286+
See also ``second_limit``
2287+
in :meth:`~sage.libs.eclib.interface.mwrank_EllipticCurve.two_descent`
22722288
22732289
- ``sat_bound`` -- (default: 1000) bound on primes used in
22742290
saturation. If the computed bound on the index of the

0 commit comments

Comments
 (0)