diff --git a/doc/source/overview.rst b/doc/source/overview.rst index 31d4a66a..bbf183e8 100644 --- a/doc/source/overview.rst +++ b/doc/source/overview.rst @@ -19,26 +19,29 @@ At the moment, Arb contains: integer/floating-point and mixed-precision algorithms). * A module (fmprb) for real ball arithmetic, where a ball is - implemented as a pair of fmpr numbers. + implemented as a pair of fmpr numbers, and a corresponding module (fmpcb) for + complex numbers in rectangular form. * Functions for fast high-precision computation of some mathematical constants, based on ball arithmetic. -* A module (fmprb_poly) for polynomials or power series over the real numbers, - implemented using balls as coefficients, with fast polynomial multiplication. +* Modules (fmprb_poly, fmpcb_poly) for polynomials or power series over the + real and complex numbers, implemented using balls as coefficients, + with fast polynomial multiplication. -* A rudimentary module (fmprb_mat) for matrices over the real numbers, - implemented using balls as coefficients. +* Modules (fmprb_mat, fmpcb_mat) for matrices over the real and complex + numbers, implemented using balls as coefficients. -Planned features include: transcendental functions and more extensive -polynomial and matrix functionality, as well as support for complex numbers. +Planned features include more transcendental functions and more extensive +polynomial and matrix functionality, as well as further optimizations. -Arb uses `MPIR `_ and `FLINT `_ +Arb uses `GMP `_ / `MPIR `_ and +`FLINT `_ for the underlying integer arithmetic and other functions. The code conventions borrow from FLINT, and the project might get merged back into FLINT when the code stabilizes in the future. -Arb also uses `MPFR `_, mainly for testing purposes -and fallback code. +Arb also uses `MPFR `_ for testing purposes +and for evaluation of some functions. The current version of Arb implements most of its floating-point arithmetic naively using high-level FLINT types. The speed at low precision is far from diff --git a/doc/source/setup.rst b/doc/source/setup.rst index 818cd961..9c2380a3 100644 --- a/doc/source/setup.rst +++ b/doc/source/setup.rst @@ -8,7 +8,7 @@ Arb has the following dependencies: * FLINT (http://www.flintlib.org) If MPIR is used instead of GMP, it must be compiled with -the :code:`--enable-gmpcompat` option. +the ``--enable-gmpcompat`` option. Currently a source checkout of FLINT from https://github.com/fredrik-johansson/flint2 is required. @@ -21,9 +21,9 @@ To compile, test and install Arb from source, do:: make install If GMP/MPIR, MPFR or FLINT is installed in some other location than -the default path /usr/local, pass the -flag :code:`--with-gmp=... --with-mpfr=... or --with-flint=...` with -the correct path to configure (type :code:`./configure --help` to show +the default path ``/usr/local``, pass +``--with-gmp=...``, ``--with-mpfr=...`` or ``--with-flint=...`` with +the correct path to configure (type ``./configure --help`` to show more options). Here is a simple sample program to get started using Arb: