Skip to content
This repository has been archived by the owner on Jan 30, 2023. It is now read-only.

Commit

Permalink
RealBall: clarify doc of upper(), lower(), endpoints()
Browse files Browse the repository at this point in the history
  • Loading branch information
mezzarobba committed Nov 10, 2015
1 parent d289538 commit fe1b071
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions src/sage/rings/real_arb.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -1550,7 +1550,13 @@ cdef class RealBall(RingElement):

def upper(self, rnd=None):
"""
Return the right endpoint of this ball, viewed as an interval.
Return the right endpoint of this ball, rounded upwards.
INPUT:
- ``rnd`` (string) -- rounding mode for the parent of the result (does
not affect its value!), see
:meth:`sage.rings.real_mpfi.RealIntervalFieldElement.upper`
EXAMPLES::
Expand All @@ -1569,7 +1575,13 @@ cdef class RealBall(RingElement):

def lower(self, rnd=None):
"""
Return the right endpoint of this ball, viewed as an interval.
Return the right endpoint of this ball, rounded downwards.
INPUT:
- ``rnd`` (string) -- rounding mode for the parent of the result (does
not affect its value!), see
:meth:`sage.rings.real_mpfi.RealIntervalFieldElement.lower`
EXAMPLES::
Expand All @@ -1586,7 +1598,13 @@ cdef class RealBall(RingElement):

def endpoints(self, rnd=None):
"""
Return the endpoints of this ball, viewed as an interval.
Return the endpoints of this ball, rounded outwards.
INPUT:
- ``rnd`` (string) -- rounding mode for the parent of the resulting
floating-point numbers (does not affect their values!), see
:meth:`sage.rings.real_mpfi.RealIntervalFieldElement.upper`
EXAMPLES::
Expand Down

0 comments on commit fe1b071

Please sign in to comment.