update documentation; call this 0.1

This commit is contained in:
Fredrik Johansson 2012-09-14 13:06:24 +02:00
parent c2a9b8b3e8
commit 03659c0457
4 changed files with 40 additions and 8 deletions

View file

@ -40,7 +40,7 @@ MathJax.Hub.Config({
<h1>Arb documentation</h1> <h1>Arb documentation</h1>
<p><i>Last updated: 2012-09-14 12:37:05 CET</i></p> <p><i>Last updated: 2012-09-14 13:04:20 CET</i></p>
<h2>Contents</h2> <h2>Contents</h2>
@ -92,6 +92,10 @@ MathJax.Hub.Config({
<li><a href="#fmprb-poly-h--polynomials-of-real-balls--Special-functions">Special functions</a></li> <li><a href="#fmprb-poly-h--polynomials-of-real-balls--Special-functions">Special functions</a></li>
</ul></li> </ul></li>
<li> <li>
<a href="#History-">History</a>
<ul>
</ul></li>
<li>
<a href="#Credits-">Credits</a> <a href="#Credits-">Credits</a>
<ul> <ul>
</ul></li> </ul></li>
@ -585,7 +589,7 @@ The output should be something like the following:
</dd> </dd>
<dt>void fmprb_get_interval_fmpz_2exp(fmpz_t a, fmpz_t b, fmpz_t exp, const fmprb_t x)</dt> <dt>void fmprb_get_interval_fmpz_2exp(fmpz_t a, fmpz_t b, fmpz_t exp, const fmprb_t x)</dt>
<dd> <dd>
<p> Computes the exact interval represented by x, in the form of an integer interval multiplied by a power of two, i.e. $x = [a, b] * 2^{\mathrm{exp}}$.</p> <p> Computes the exact interval represented by x, in the form of an integer interval multiplied by a power of two, i.e. $x = [a, b] \times 2^{\mathrm{exp}}$.</p>
<p> The outcome is undefined if the midpoint or radius of x is non-finite, or if the difference in magnitude between the midpoint and radius is so large that representing the endpoints exactly would cause overflows.</p> <p> The outcome is undefined if the midpoint or radius of x is non-finite, or if the difference in magnitude between the midpoint and radius is so large that representing the endpoints exactly would cause overflows.</p>
</dd> </dd>
<dt>long fmprb_rel_error_bits(const fmprb_t x)</dt> <dt>long fmprb_rel_error_bits(const fmprb_t x)</dt>
@ -737,10 +741,16 @@ The output should be something like the following:
<dd> <dd>
<p> Computes $\zeta(s)$ for arbitrary $s \ge 2$ using a binary splitting implementation of Borwein's formula. The algorithm has quasilinear complexity with respect to the precision.</p> <p> Computes $\zeta(s)$ for arbitrary $s \ge 2$ using a binary splitting implementation of Borwein's formula. The algorithm has quasilinear complexity with respect to the precision.</p>
</dd> </dd>
<dt>void fmprb_zeta_ui(fmprb_t x, ulong n, long prec)</dt> <dt>void fmprb_zeta_ui(fmprb_t x, ulong s, long prec)</dt>
<dd>
<p> Computes $\zeta(s)$ for nonnegative integer $s \ne 1$, automatically choosing an appropriate algorithm.</p>
</dd>
<dt>void fmprb_zeta_ui_vec(fmprb_struct * x, ulong start, long num, long prec)</dt>
<dt>void fmprb_zeta_ui_vec_even(fmprb_struct * x, ulong start, long num, long prec)</dt> <dt>void fmprb_zeta_ui_vec_even(fmprb_struct * x, ulong start, long num, long prec)</dt>
<dt>void fmprb_zeta_ui_vec_odd(fmprb_struct * x, ulong start, long num, long prec)</dt> <dt>void fmprb_zeta_ui_vec_odd(fmprb_struct * x, ulong start, long num, long prec)</dt>
<dt>void fmprb_zeta_ui_vec(fmprb_struct * x, ulong start, long num, long prec)</dt> <dd>
<p> Computes $\zeta(s)$ at num consecutive integers (respectively num even or num odd integers) beginning with $s = \mathrm{start} \ge 2$, automatically choosing an appropriate algorithm.</p>
</dd>
</dl> </dl>
<hr /> <hr />
<h2><a name="fmprb-poly-h--polynomials-of-real-balls--">fmprb_poly.h (polynomials of real balls)</a></h2> <h2><a name="fmprb-poly-h--polynomials-of-real-balls--">fmprb_poly.h (polynomials of real balls)</a></h2>
@ -880,6 +890,14 @@ The output should be something like the following:
<p> Sets $f$ to the series expansion of $\log(\Gamma(1-x))$, truncated to length $n$.</p> <p> Sets $f$ to the series expansion of $\log(\Gamma(1-x))$, truncated to length $n$.</p>
</dd> </dd>
</dl> </dl>
<hr />
<h2><a name="History-">History</a></h2>
<ul>
<li>2012-09-14 - version 0.1</li>
<li>2012-08-05 - began simplified rewrite</li>
<li>2012-04-05 - experimental ball and polynomial code</li>
</ul>
<hr /> <hr />
<h2><a name="Credits-">Credits</a></h2> <h2><a name="Credits-">Credits</a></h2>
<p>Arb is licensed GNU General Public License version 2, or any later version.</p> <p>Arb is licensed GNU General Public License version 2, or any later version.</p>

View file

@ -171,6 +171,7 @@ docs = [
("fmpr.txt", "fmpr.h (floating-point arithmetic)", True), ("fmpr.txt", "fmpr.h (floating-point arithmetic)", True),
("fmprb.txt", "fmprb.h (real ball arithmetic)", True), ("fmprb.txt", "fmprb.h (real ball arithmetic)", True),
("fmprb_poly.txt", "fmprb_poly.h (polynomials of real balls)", True), ("fmprb_poly.txt", "fmprb_poly.h (polynomials of real balls)", True),
("history.txt", "History", False),
("credits.txt", "Credits", False), ("credits.txt", "Credits", False),
] ]

View file

@ -225,7 +225,8 @@ int fmprb_contains_zero(const fmprb_t x)
void fmprb_get_interval_fmpz_2exp(fmpz_t a, fmpz_t b, fmpz_t exp, const fmprb_t x) void fmprb_get_interval_fmpz_2exp(fmpz_t a, fmpz_t b, fmpz_t exp, const fmprb_t x)
Computes the exact interval represented by x, in the form of an integer Computes the exact interval represented by x, in the form of an integer
interval multiplied by a power of two, i.e. $x = [a, b] * 2^{\mathrm{exp}}$. interval multiplied by a power of two, i.e.
$x = [a, b] \times 2^{\mathrm{exp}}$.
The outcome is undefined if the midpoint or radius of x is non-finite, The outcome is undefined if the midpoint or radius of x is non-finite,
or if the difference in magnitude between the midpoint and radius or if the difference in magnitude between the midpoint and radius
@ -525,12 +526,18 @@ void fmprb_zeta_ui_bsplit(fmprb_t x, ulong s, long prec)
implementation of Borwein's formula. The algorithm has quasilinear implementation of Borwein's formula. The algorithm has quasilinear
complexity with respect to the precision. complexity with respect to the precision.
void fmprb_zeta_ui(fmprb_t x, ulong n, long prec) void fmprb_zeta_ui(fmprb_t x, ulong s, long prec)
Computes $\zeta(s)$ for nonnegative integer $s \ne 1$, automatically
choosing an appropriate algorithm.
void fmprb_zeta_ui_vec(fmprb_struct * x, ulong start, long num, long prec)
void fmprb_zeta_ui_vec_even(fmprb_struct * x, ulong start, long num, long prec) void fmprb_zeta_ui_vec_even(fmprb_struct * x, ulong start, long num, long prec)
void fmprb_zeta_ui_vec_odd(fmprb_struct * x, ulong start, long num, long prec) void fmprb_zeta_ui_vec_odd(fmprb_struct * x, ulong start, long num, long prec)
void fmprb_zeta_ui_vec(fmprb_struct * x, ulong start, long num, long prec) Computes $\zeta(s)$ at num consecutive integers (respectively num
even or num odd integers) beginning with $s = \mathrm{start} \ge 2$,
automatically choosing an appropriate algorithm.

6
doc/history.txt Normal file
View file

@ -0,0 +1,6 @@
<ul>
<li>2012-09-14 - version 0.1</li>
<li>2012-08-05 - began simplified rewrite</li>
<li>2012-04-05 - experimental ball and polynomial code</li>
</ul>