Skip to content

Commit cf365e5

Browse files
author
Release Manager
committed
gh-37663: sage/rings/{complex,real}*: Untitlecase titles, add refs to libraries <!-- ^ Please provide a concise and informative title. --> <!-- ^ Don't put issue numbers in the title, do this in the PR description below. --> <!-- ^ For example, instead of "Fixes #12345" use "Introduce new method to calculate 1 + 2". --> <!-- v Describe your changes below in detail. --> <!-- v Why is this change required? What problem does it solve? --> <!-- v If this PR resolves an open issue, please link to it here. For example, "Fixes #12345". --> This cleans up the table of contents https://deploy-preview-37663-- sagemath.netlify.app/html/en/reference/rings_numerical/ ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [x] The title is concise and informative. - [ ] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation accordingly. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - #12345: short description why this is a dependency --> <!-- - #34567: ... --> - Depends on #37406 (merged here to resolve merge conflict) URL: #37663 Reported by: Matthias Köppe Reviewer(s): Marc Mezzarobba
2 parents 59bf21e + a47b98b commit cf365e5

File tree

9 files changed

+31
-28
lines changed

9 files changed

+31
-28
lines changed

src/doc/en/reference/rings_numerical/index.rst

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,16 @@ Fixed and Arbitrary Precision Numerical Fields
44
Floating-Point Arithmetic
55
-------------------------
66

7-
Sage supports arbitrary precision real (RealField) and complex fields
8-
(ComplexField). Sage also provides two optimized fixed precision fields for
9-
numerical computation, the real double (RealDoubleField) and complex double
10-
fields (ComplexDoubleField).
7+
Sage supports arbitrary precision real (:class:`RealField`) and complex fields
8+
(:class:`ComplexField`). Sage also provides two optimized fixed precision fields for
9+
numerical computation, the real double (:class:`RealDoubleField`) and complex double
10+
fields (:class:`ComplexDoubleField`).
1111

1212
Real and complex double elements are optimized implementations that use the
13-
GNU Scientific Library for arithmetic and some special functions. Arbitrary
14-
precision real and complex numbers are implemented using the MPFR library,
15-
which builds on GMP. In many cases the PARI C-library is used to compute
13+
:ref:`GNU Scientific Library <spkg_gsl>` for arithmetic and some special functions.
14+
Arbitrary precision real and complex numbers are implemented using the
15+
:ref:`MPFR <spkg_mpfr>` library, which builds on :ref:`GMP <spkg_gmp>`.
16+
In many cases, the :ref:`PARI <spkg_pari>` C-library is used to compute
1617
special functions when implementations aren't otherwise available.
1718

1819
.. toctree::
@@ -27,9 +28,9 @@ special functions when implementations aren't otherwise available.
2728
Interval Arithmetic
2829
-------------------
2930

30-
Sage implements real and complex interval arithmetic using MPFI
31-
(RealIntervalField, ComplexIntervalField) and FLINT (RealBallField,
32-
ComplexBallField).
31+
Sage implements real and complex interval arithmetic using
32+
:ref:`MPFI <spkg_mpfi>` (:class:`RealIntervalField`, :class:`ComplexIntervalField`)
33+
and :ref:`FLINT <spkg_flint>` (:class:`RealBallField`, :class:`ComplexBallField`).
3334

3435
.. toctree::
3536
:maxdepth: 1

src/sage/rings/complex_double.pyx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# distutils: extra_compile_args = -D_XPG6
22
# distutils: libraries = m
33
r"""
4-
Double Precision Complex Numbers
4+
Double precision floating point complex numbers
55
66
Sage supports arithmetic using double-precision complex numbers. A
77
double-precision complex number is a complex number ``x + I*y`` with
88
`x`, `y` 64-bit (8 byte) floating point numbers (double precision).
99
1010
The field :class:`ComplexDoubleField` implements the field
1111
of all double-precision complex numbers. You can refer to this
12-
field by the shorthand CDF. Elements of this field are of type
12+
field by the shorthand ``CDF``. Elements of this field are of type
1313
:class:`ComplexDoubleElement`. If `x` and `y` are coercible to
1414
doubles, you can create a complex double element using
1515
``ComplexDoubleElement(x,y)``. You can coerce more
@@ -39,11 +39,12 @@ EXAMPLES::
3939
True
4040
4141
The underlying arithmetic of complex numbers is implemented using
42-
functions and macros in GSL (the GNU Scientific Library), and
42+
functions and macros in :ref:`GSL <spkg_gsl>` (the GNU Scientific Library), and
4343
should be very fast. Also, all standard complex trig functions,
4444
log, exponents, etc., are implemented using GSL, and are also
4545
robust and fast. Several other special functions, e.g. eta, gamma,
46-
incomplete gamma, etc., are implemented using the PARI C library.
46+
incomplete gamma, etc., are implemented using the :ref:`PARI <spkg_pari>`
47+
C library.
4748
4849
AUTHORS:
4950

src/sage/rings/complex_interval.pyx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
Arbitrary Precision Complex Intervals
2+
Arbitrary precision complex intervals
33
44
This is a simple complex interval package, using intervals which are
55
axis-aligned rectangles in the complex plane. It has very few special

src/sage/rings/complex_interval_field.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
r"""
2-
Field of Arbitrary Precision Complex Intervals
2+
Arbitrary precision complex intervals (parent class)
33
44
AUTHORS:
55

src/sage/rings/complex_mpc.pyx

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
"""
2-
Arbitrary Precision Complex Numbers using GNU MPC
2+
Arbitrary precision floating point complex numbers using GNU MPC
33
4-
This is a binding for the MPC arbitrary-precision floating point library.
5-
It is adaptated from ``real_mpfr.pyx`` and ``complex_mpfr.pyx``.
4+
This is a binding for the arbitrary-precision floating point library
5+
:ref:`GNU MPC <spkg_mpc>`.
66
7-
We define a class :class:`MPComplexField`, where each instance of
8-
``MPComplexField`` specifies a field of floating-point complex numbers with
7+
We define a class :class:`MPComplexField`, each instance of which
8+
specifies a field of floating-point complex numbers with
99
a specified precision shared by the real and imaginary part and a rounding
1010
mode stating the rounding mode directions specific to real and imaginary
1111
parts.
@@ -17,7 +17,8 @@ documentation for the :mod:`sage.rings.real_mpfr`.
1717
1818
AUTHORS:
1919
20-
- Philippe Theveny (2008-10-13): initial version.
20+
- Philippe Theveny (2008-10-13): initial version, adapted from
21+
:mod:`sage.rings.real_mpfr` and :mod:`sage.rings.complex_mpfr`.
2122
2223
- Alex Ghitza (2008-11): cache, generators, random element, and many doctests.
2324

src/sage/rings/complex_mpfr.pyx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
Arbitrary Precision Floating Point Complex Numbers
2+
Arbitrary precision floating point complex numbers using GNU MPFR
33
44
AUTHORS:
55

src/sage/rings/real_double.pyx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
r"""
2-
Double Precision Real Numbers
2+
Double precision floating point real numbers
33
44
EXAMPLES:
55

src/sage/rings/real_mpfi.pyx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
r"""
2-
Arbitrary Precision Real Intervals
2+
Arbitrary precision real intervals using MPFI
33
44
AUTHORS:
55
@@ -16,8 +16,8 @@ AUTHORS:
1616
1717
- Travis Scrimshaw (2012-11-02): Added doctests for full coverage
1818
19-
This is a straightforward binding to the MPFI library; it may be
20-
useful to refer to its documentation for more details.
19+
This is a straightforward binding to the :ref:`MPFI library <spkg_mpfi>`;
20+
it may be useful to refer to its documentation for more details.
2121
2222
An interval is represented as a pair of floating-point numbers `a`
2323
and `b` (where `a \leq b`) and is printed as a standard floating-point

src/sage/rings/real_mpfr.pyx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
r"""
2-
Arbitrary Precision Real Numbers
2+
Arbitrary precision floating point real numbers using GNU MPFR
33
44
AUTHORS:
55

0 commit comments

Comments
 (0)