Skip to content

Commit 59bf21e

Browse files
author
Release Manager
committed
gh-37661: some cross-references btw doc of RR, RBF, ... (mainly intended to make RBF and CBF, which are the most powerful implementations for most purposes, more discoverable) URL: #37661 Reported by: Marc Mezzarobba Reviewer(s):
2 parents 2fd0452 + 210c5d8 commit 59bf21e

File tree

6 files changed

+53
-2
lines changed

6 files changed

+53
-2
lines changed

src/sage/rings/complex_arb.pyx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -336,6 +336,13 @@ class ComplexBallField(UniqueRepresentation, sage.rings.abc.ComplexBallField):
336336
337337
sage: loads(dumps(ComplexBallField(60))) is ComplexBallField(60)
338338
True
339+
340+
.. SEEALSO::
341+
342+
- :mod:`sage.rings.complex_arb`
343+
- :mod:`sage.rings.complex_mpfr`
344+
- :mod:`sage.rings.complex_mpfi`
345+
- :mod:`sage.rings.real_arb`
339346
"""
340347
Element = ComplexBall
341348

src/sage/rings/complex_interval_field.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,12 @@ class ComplexIntervalField_class(sage.rings.abc.ComplexIntervalField):
171171
172172
sage: CIF.is_finite()
173173
False
174+
175+
.. SEEALSO::
176+
177+
- :mod:`sage.rings.real_mpfi`
178+
- :class:`sage.rings.complex_arb.ComplexBallField` (alternative
179+
implementation of complex intervals, with more features)
174180
"""
175181
Element = complex_interval.ComplexIntervalFieldElement
176182

src/sage/rings/complex_mpfr.pyx

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,12 @@ def ComplexField(prec=53, names=None):
176176
sage: i = ComplexField(200).gen()
177177
sage: i^2
178178
-1.0000000000000000000000000000000000000000000000000000000000
179+
180+
.. SEEALSO::
181+
182+
- :class:`~sage.rings.complex_mpfr.ComplexField_class`
183+
- :class:`~sage.rings.real_arb.ComplexBallField` (complex numbers with
184+
rigorous error bounds)
179185
"""
180186
global cache
181187
if prec in cache:
@@ -261,6 +267,13 @@ class ComplexField_class(sage.rings.abc.ComplexField):
261267
False
262268
sage: CC == 1.1
263269
False
270+
271+
.. SEEALSO::
272+
273+
- :func:`~sage.rings.complex_mpfr.ComplexField` (constructor)
274+
- :class:`~sage.rings.real_arb.ComplexBallField` (complex numbers with
275+
rigorous error bounds)
276+
- :mod:`~sage.rings.real_mpfr`
264277
"""
265278
def __init__(self, prec=53):
266279
"""

src/sage/rings/real_arb.pyx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -368,6 +368,14 @@ class RealBallField(UniqueRepresentation, sage.rings.abc.RealBallField):
368368
369369
sage: loads(dumps(RealBallField(60))) is RealBallField(60)
370370
True
371+
372+
.. SEEALSO::
373+
374+
- :mod:`sage.rings.real_arb`
375+
- :mod:`sage.rings.real_mpfr`
376+
- :mod:`sage.rings.real_mpfi` (real intervals represented by their
377+
endpoints)
378+
- :mod:`sage.rings.complex_arb`
371379
"""
372380
Element = RealBall
373381

src/sage/rings/real_mpfi.pyx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -511,6 +511,13 @@ cdef class RealIntervalField_class(sage.rings.abc.RealIntervalField):
511511
512512
sage: RealIntervalField(10).is_finite()
513513
False
514+
515+
.. SEEALSO::
516+
517+
- :mod:`sage.rings.real_mpfi`
518+
- :mod:`sage.rings.complex_interval_field`
519+
- :class:`sage.rings.real_arb.RealBallField` (alternative
520+
implementation of real intervals, with more features)
514521
"""
515522
Element = RealIntervalFieldElement
516523

src/sage/rings/real_mpfr.pyx

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -427,6 +427,12 @@ cpdef RealField(mpfr_prec_t prec=53, int sci_not=0, rnd=MPFR_RNDN):
427427
computations with double-precision machine floating-point
428428
numbers (double type in C), except the default exponent range
429429
is much wider and subnormal numbers are not implemented.'
430+
431+
.. SEEALSO::
432+
433+
- :mod:`sage.rings.real_mpfr`
434+
- :class:`sage.rings.real_arb.RealBallField` (real numbers with rigorous
435+
error bounds)
430436
"""
431437
# We allow specifying the rounding mode as string or integer.
432438
# But we pass an integer to __init__
@@ -457,8 +463,12 @@ cdef class RealField_class(sage.rings.abc.RealField):
457463
numbers. This is due to the rounding errors inherent to finite
458464
precision calculations.
459465
460-
See the documentation for the module :mod:`sage.rings.real_mpfr` for more
461-
details.
466+
.. SEEALSO::
467+
468+
- :mod:`sage.rings.real_mpfr`
469+
- :class:`sage.rings.real_arb.RealBallField` (real numbers with rigorous
470+
error bounds)
471+
- :mod:`sage.rings.complex_mpfr`
462472
"""
463473
def __init__(self, mpfr_prec_t prec=53, int sci_not=0, long rnd=MPFR_RNDN):
464474
"""

0 commit comments

Comments
 (0)