mirror of
https://github.com/vale981/arb
synced 2025-03-07 02:11:38 -05:00
111 lines
3.7 KiB
ReStructuredText
111 lines
3.7 KiB
ReStructuredText
Setup
|
|
===============================================================================
|
|
|
|
Dependencies
|
|
-------------------------------------------------------------------------------
|
|
|
|
Arb has the following dependencies:
|
|
|
|
* Either MPIR (http://www.mpir.org) 2.6.0 or later, or GMP (http://www.gmplib.org) 5.1.0 or later.
|
|
If MPIR is used instead of GMP, it must be compiled with the ``--enable-gmpcompat`` option.
|
|
* MPFR (http://www.mpfr.org) 3.0.0 or later.
|
|
* FLINT (http://www.flintlib.org) Currently a source checkout of FLINT from
|
|
https://github.com/fredrik-johansson/flint2 is required
|
|
(the first release version of FLINT to be compatible with Arb
|
|
will be FLINT 2.4).
|
|
|
|
|
|
Installation as part of FLINT
|
|
-------------------------------------------------------------------------------
|
|
|
|
With a sufficiently new version of FLINT, Arb can be compiled as a FLINT
|
|
extension package.
|
|
|
|
Simply put the Arb source directory somewhere, say ``/path/to/arb``.
|
|
Then go to the FLINT source directory and build FLINT using::
|
|
|
|
./configure --extensions=/path/to/arb <other options>
|
|
make
|
|
make check (optional)
|
|
make install
|
|
|
|
This is convenient, as Arb does not need to be
|
|
configured or linked separately. Arb becomes part of the compiled FLINT
|
|
library, and the Arb header files will be installed along with the other
|
|
FLINT header files.
|
|
|
|
Standalone installation
|
|
-------------------------------------------------------------------------------
|
|
|
|
To compile, test and install Arb from source as a standalone library,
|
|
first install FLINT. Then go to the Arb source directory and run::
|
|
|
|
./configure <options>
|
|
make
|
|
make check (optional)
|
|
make install
|
|
|
|
If GMP/MPIR, MPFR or FLINT is installed in some other location than
|
|
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).
|
|
|
|
|
|
Running code
|
|
-------------------------------------------------------------------------------
|
|
|
|
Here is an example program to get started using Arb:
|
|
|
|
.. code-block:: c
|
|
|
|
#include "fmprb.h"
|
|
|
|
int main()
|
|
{
|
|
fmprb_t x;
|
|
fmprb_init(x);
|
|
fmprb_const_pi(x, 50 * 3.33);
|
|
fmprb_printd(x, 50); printf("\n");
|
|
fmprb_clear(x);
|
|
}
|
|
|
|
Compile it with::
|
|
|
|
gcc -larb test.c
|
|
|
|
or (if Arb is built as part of FLINT)::
|
|
|
|
gcc -lflint test.c
|
|
|
|
If the Arb/FLINT header and library files are not in a standard location
|
|
(``/usr/local`` on most systems), you may also have to pass options such as::
|
|
|
|
-I/path/to/arb -I/path/to/flint -L/path/to/flint -L/path/to/arb
|
|
|
|
to ``gcc``. Finally, to run the program, make sure that the linker
|
|
can find the FLINT (and Arb) libraries. If they are installed in a
|
|
nonstandard location, you can for example add this path to the
|
|
``LD_LIBRARY_PATH`` environment variable.
|
|
|
|
The output of the example program should be something like the following::
|
|
|
|
3.1415926535897932384626433832795028841971693993751 +/- 4.2764e-50
|
|
|
|
|
|
Thread safety and caches
|
|
-------------------------------------------------------------------------------
|
|
|
|
Arb should be fully threadsafe, provided that both MPFR and FLINT have
|
|
been built in threadsafe mode. Please note that thread safety is
|
|
not currently tested, and caution is therefore recommended.
|
|
|
|
Arb may cache some data (such as the value of `\pi` and
|
|
Bernoulli numbers) to speed up various computations. In threadsafe mode,
|
|
caches use thread-local storage (there is currently no way to save memory
|
|
and avoid recomputation by having several threads share the same cache).
|
|
Caches can be freed by calling the ``flint_cleanup()`` function. To avoid
|
|
memory leaks, the user should call ``flint_cleanup()`` when exiting a thread.
|
|
It is also recommended to call ``flint_cleanup()`` when exiting the main
|
|
program.
|
|
|