arb/doc/source/index.rst

222 lines
5.9 KiB
ReStructuredText
Raw Normal View History

Arb - a C library for arbitrary-precision interval arithmetic
=============================================================
2012-10-11 13:09:44 +02:00
2015-01-28 14:54:30 +01:00
.. only:: latex
2012-10-11 13:09:44 +02:00
2015-01-28 14:54:30 +01:00
Introduction
::::::::::::
2012-10-11 13:09:44 +02:00
Welcome to Arb's documentation!
Arb is a C library for arbitrary-precision interval arithmetic,
using a midpoint-radius representation ("ball arithmetic").
It supports real and complex numbers, polynomials, power series,
matrices, and evaluation of many transcendental functions.
All operations are done with automatic, rigorous error bounds.
The code is thread-safe, portable, and extensively tested.
2015-01-28 14:54:30 +01:00
2016-04-26 17:48:35 +02:00
Arb is free software distributed under the
GNU Lesser General Public License (LGPL), version 2.1 or later
(see :ref:`license`).
2016-04-26 17:48:35 +02:00
2015-01-28 14:54:30 +01:00
The git repository is https://github.com/fredrik-johansson/arb/
Arb is developed by `Fredrik Johansson <http://fredrikj.net/>`_
(fredrik.johansson@gmail.com), with help from many
contributors (see :ref:`credits`).
Questions and discussion about Arb are welcome on the
`flint-devel <https://groups.google.com/d/forum/flint-devel>`_ mailing list.
There is also an `issue tracker <https://github.com/fredrik-johansson/arb/issues>`_
for bug reports and feature requests.
Development progress is sometimes covered on
`Fredrik's blog <http://fredrikj.net/blog/>`_.
This documentation is available in HTML format at http://arblib.org and in
PDF format at http://arblib.org/arb.pdf.
The version of the documentation you are currently reading was updated
|today| and describes Arb |version|.
Documentation for :ref:`specific release versions <history>`
is also available in PDF format.
2015-01-28 14:54:30 +01:00
.. only:: html
.. image:: _static/arbtext.png
Welcome to Arb's documentation!
Arb is a C library for arbitrary-precision interval arithmetic,
using a midpoint-radius representation ("ball arithmetic").
It supports real and complex numbers, polynomials, power series,
matrices, and evaluation of many transcendental functions.
All operations are done with automatic, rigorous error bounds.
The code is thread-safe, portable, and extensively tested.
2015-01-28 14:54:30 +01:00
2016-04-26 17:48:35 +02:00
Arb is free software distributed under the
GNU Lesser General Public License (LGPL), version 2.1 or later
(see :ref:`license`).
2016-04-26 17:48:35 +02:00
2015-01-28 14:54:30 +01:00
The git repository is https://github.com/fredrik-johansson/arb/
Arb is developed by `Fredrik Johansson <http://fredrikj.net/>`_
(fredrik.johansson@gmail.com), with help from many
contributors (see :ref:`credits`).
Questions and discussion about Arb are welcome on the
`flint-devel <https://groups.google.com/d/forum/flint-devel>`_ mailing list.
There is also an `issue tracker <https://github.com/fredrik-johansson/arb/issues>`_
for bug reports and feature requests.
Development progress is sometimes covered on
`Fredrik's blog <http://fredrikj.net/blog/>`_.
This documentation is available in HTML format at http://arblib.org and in
PDF format at http://arblib.org/arb.pdf.
The version of the documentation you are currently reading was updated
|today| and describes Arb |version|.
Documentation for :ref:`specific release versions <history>`
is also available in PDF format.
2012-10-11 13:09:44 +02:00
General information
::::::::::::::::::::
.. toctree::
2016-02-24 16:33:45 +01:00
:maxdepth: 2
2012-10-11 13:09:44 +02:00
overview.rst
setup.rst
using.rst
2013-08-06 14:10:45 +02:00
issues.rst
2013-09-19 17:28:23 +01:00
examples.rst
2016-02-24 16:33:45 +01:00
Floating-point numbers
2014-06-19 16:58:52 +02:00
::::::::::::::::::::::::::::::::::::
2016-02-24 19:15:02 +01:00
The radius and midpoint of a ball are represented using two specialized
floating-point types.
2014-06-19 16:58:52 +02:00
.. toctree::
2016-02-24 16:33:45 +01:00
:maxdepth: 2
2014-06-19 16:58:52 +02:00
mag.rst
arf.rst
2016-02-24 16:33:45 +01:00
Real and complex numbers
::::::::::::::::::::::::::::::::::::
2016-02-24 19:15:02 +01:00
Real numbers (*arb_t*) are represented as midpoint-radius intervals,
also known as balls. Complex numbers (*acb_t*) are represented in rectangular
form, with balls for the real and imaginary parts.
2016-02-24 16:33:45 +01:00
.. toctree::
:maxdepth: 2
2014-06-19 16:58:52 +02:00
arb.rst
acb.rst
2016-02-24 16:33:45 +01:00
Polynomials and power series
::::::::::::::::::::::::::::::::::::
2016-02-24 19:15:02 +01:00
These modules implement dense univariate polynomials with real and complex
coefficients. Truncated power series are supported via methods acting
on polynomials, without introducing a separate power series type.
2016-02-24 16:33:45 +01:00
.. toctree::
:maxdepth: 2
arb_poly.rst
2014-06-19 16:58:52 +02:00
acb_poly.rst
arb_fmpz_poly.rst
2016-02-24 16:33:45 +01:00
2017-10-31 16:55:49 +01:00
Transforms
::::::::::::::::::::::::::::::::::::
.. toctree::
:maxdepth: 2
acb_dft.rst
2016-02-24 16:33:45 +01:00
Matrices
::::::::::::::::::::::::::::::::::::
2016-02-24 19:15:02 +01:00
These modules implement dense matrices with real and complex coefficients.
Rudimentary linear algebra is supported.
2016-02-24 16:33:45 +01:00
.. toctree::
:maxdepth: 2
arb_mat.rst
2014-06-19 16:58:52 +02:00
acb_mat.rst
2016-02-24 16:33:45 +01:00
Higher mathematical functions
::::::::::::::::::::::::::::::::::::
2016-02-24 19:15:02 +01:00
These modules implement mathematical functions with complexity
that goes beyond the basics covered directly in the *arb* and *acb*
modules.
2016-02-24 16:33:45 +01:00
.. toctree::
:maxdepth: 2
2014-11-15 17:46:04 +01:00
acb_hypgeom.rst
2016-07-06 20:34:26 +02:00
arb_hypgeom.rst
acb_elliptic.rst
2014-11-15 17:46:04 +01:00
acb_modular.rst
2016-10-06 14:45:58 +02:00
dirichlet.rst
acb_dirichlet.rst
bernoulli.rst
hypgeom.rst
partitions.rst
2014-07-07 05:37:28 +02:00
2016-02-24 16:33:45 +01:00
Calculus
::::::::::::::::::::::::::::::::::::
2014-06-19 16:58:52 +02:00
2016-02-24 19:15:02 +01:00
Using ball arithmetic, it is possible to do rigorous root-finding and
integration (among other operations)
with generic functions. This code should be considered experimental.
2014-06-19 16:58:52 +02:00
.. toctree::
2016-02-24 16:33:45 +01:00
:maxdepth: 2
2014-06-19 16:58:52 +02:00
2016-02-24 16:33:45 +01:00
arb_calc.rst
acb_calc.rst
2012-10-11 13:09:44 +02:00
2016-02-24 18:18:30 +01:00
Extra utility modules
::::::::::::::::::::::::::::::::::::
2016-02-24 19:15:02 +01:00
Mainly for internal use.
2016-02-24 18:18:30 +01:00
.. toctree::
:maxdepth: 1
fmpz_extras.rst
2016-03-02 11:35:49 +01:00
bool_mat.rst
2016-09-07 14:09:05 +02:00
dlog.rst
2012-10-11 13:09:44 +02:00
fmpr.rst
2014-05-08 14:48:36 +02:00
2016-02-24 16:33:45 +01:00
Supplementary algorithm notes
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
2016-02-24 19:15:02 +01:00
Here, we give extra proofs, error bounds, and formulas that would be too
lengthy to reproduce in the documentation for each module.
2016-02-24 16:33:45 +01:00
.. toctree::
2016-02-24 18:18:30 +01:00
:maxdepth: 1
2016-02-24 16:33:45 +01:00
2016-03-02 11:35:49 +01:00
formulas.rst
2016-02-24 16:33:45 +01:00
constants.rst
gamma.rst
hurwitz.rst
2016-02-24 16:33:45 +01:00
polylogarithms.rst
hypergeometric.rst
2016-02-27 07:50:35 +01:00
agm.rst
2016-02-24 16:33:45 +01:00
2016-02-28 03:38:55 +01:00
History, credits and references
:::::::::::::::::::::::::::::::::
2012-10-11 13:09:44 +02:00
.. toctree::
:maxdepth: 2
2012-10-11 13:09:44 +02:00
credits.rst
2016-02-28 03:38:55 +01:00
.. toctree::
:maxdepth: 1
history.rst