hiro/arb
1
0
Fork 0
mirror of https://github.com/vale981/arb synced 2025-03-06 09:51:39 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

small doc edits

Browse source
This commit is contained in:
Fredrik Johansson 2013-05-25 02:27:50 +02:00
parent ba329a6a49
commit cef789ad60
2 changed files with 17 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
doc/source/overview.rst
View file

@ -19,26 +19,29 @@ At the moment, Arb contains:
integer/floating-point and mixed-precision algorithms). integer/floating-point and mixed-precision algorithms).
* A module (fmprb) for real ball arithmetic, where a ball is * 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, * Functions for fast high-precision computation of some mathematical constants,
based on ball arithmetic. based on ball arithmetic.
* A module (fmprb_poly) for polynomials or power series over the real numbers, * Modules (fmprb_poly, fmpcb_poly) for polynomials or power series over the
implemented using balls as coefficients, with fast polynomial multiplication. real and complex numbers, implemented using balls as coefficients,
with fast polynomial multiplication.
* A rudimentary module (fmprb_mat) for matrices over the real numbers, * Modules (fmprb_mat, fmpcb_mat) for matrices over the real and complex
implemented using balls as coefficients. numbers, implemented using balls as coefficients.
Planned features include: transcendental functions and more extensive Planned features include more transcendental functions and more extensive
polynomial and matrix functionality, as well as support for complex numbers. polynomial and matrix functionality, as well as further optimizations.
Arb uses `MPIR <http://mpir.org>`_ and `FLINT <http://flintlib.org/>`_ Arb uses `GMP <http://mpir.org>`_ / `MPIR <http://mpir.org>`_ and
`FLINT <http://flintlib.org/>`_
for the underlying integer arithmetic and other functions. for the underlying integer arithmetic and other functions.
The code conventions borrow from FLINT, and the project might get The code conventions borrow from FLINT, and the project might get
merged back into FLINT when the code stabilizes in the future. merged back into FLINT when the code stabilizes in the future.
Arb also uses `MPFR <http://mpfr.org/>`_, mainly for testing purposes Arb also uses `MPFR <http://mpfr.org/>`_ for testing purposes
and fallback code. and for evaluation of some functions.
The current version of Arb implements most of its floating-point arithmetic 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 naively using high-level FLINT types. The speed at low precision is far from

8
doc/source/setup.rst
View file

@ -8,7 +8,7 @@ Arb has the following dependencies:
* FLINT (http://www.flintlib.org) * FLINT (http://www.flintlib.org)
If MPIR is used instead of GMP, it must be compiled with 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 Currently a source checkout of FLINT from
https://github.com/fredrik-johansson/flint2 is required. https://github.com/fredrik-johansson/flint2 is required.
@ -21,9 +21,9 @@ To compile, test and install Arb from source, do::
make install make install
If GMP/MPIR, MPFR or FLINT is installed in some other location than If GMP/MPIR, MPFR or FLINT is installed in some other location than
the default path /usr/local, pass the the default path ``/usr/local``, pass
flag :code:`--with-gmp=... --with-mpfr=... or --with-flint=...` with ``--with-gmp=...``, ``--with-mpfr=...`` or ``--with-flint=...`` with
the correct path to configure (type :code:`./configure --help` to show the correct path to configure (type ``./configure --help`` to show
more options). more options).
Here is a simple sample program to get started using Arb: Here is a simple sample program to get started using Arb: