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

Commit

Permalink
#8348: Document that find_root only works in fixed (double) precision
Browse files Browse the repository at this point in the history
  • Loading branch information
Paul Zimmermann authored and mezzarobba committed Jan 29, 2014
1 parent 1bd3319 commit 98bdbcc
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
3 changes: 2 additions & 1 deletion src/sage/numerical/optimize.py
Expand Up @@ -21,7 +21,8 @@ def find_root(f, a, b, xtol=10e-13, rtol=4.5e-16, maxiter=100, full_output=False
"""
Numerically find a root of ``f`` on the closed interval `[a,b]`
(or `[b,a]`) if possible, where ``f`` is a function in the one variable.
Note: this function only works in fixed (machine) precision, it is not
possible to get arbitrary precision approximations with it.
INPUT:
Expand Down
6 changes: 4 additions & 2 deletions src/sage/symbolic/expression.pyx
Expand Up @@ -9187,6 +9187,8 @@ cdef class Expression(CommutativeRingElement):
"""
Numerically find a root of self on the closed interval [a,b] (or
[b,a]) if possible, where self is a function in the one variable.
Note: this function only works in fixed (machine) precision, it is not
possible to get arbitrary precision approximations with it.
INPUT:
Expand All @@ -9195,12 +9197,12 @@ cdef class Expression(CommutativeRingElement):
- ``var`` - optional variable
- ``xtol, rtol`` - the routine converges when a root
is known to lie within xtol of the value return. Should be = 0. The
is known to lie within xtol of the value return. Should be >= 0. The
routine modifies this to take into account the relative precision
of doubles.
- ``maxiter`` - integer; if convergence is not
achieved in maxiter iterations, an error is raised. Must be = 0.
achieved in maxiter iterations, an error is raised. Must be >= 0.
- ``full_output`` - bool (default: False), if True,
also return object that contains information about convergence.
Expand Down

0 comments on commit 98bdbcc

Please sign in to comment.