edit docs

This commit is contained in:
Fredrik Johansson 2017-06-25 11:31:16 +02:00
parent 7b62f23ed0
commit f62ce540cf
2 changed files with 33 additions and 4 deletions

View file

@ -11,7 +11,7 @@ requiring use of Arb real or complex numbers.
Some methods output real or complex numbers while others
use real and complex numbers internally to produce an exact result.
This module also contains some useful helper functions not specifically
related to real and complex numbers that are useful elsewhere in Arb.
related to real and complex numbers.
Note that methods that combine Arb *polynomials* and FLINT polynomials
are found in the respective Arb polynomial modules, such as
@ -74,8 +74,8 @@ Polynomial roots
the root in the lower plane).
The input polynomial *must* be squarefree. For a general polynomial,
do a squarefree factorization (which also gives the correct multiplicities
of the roots)::
compute the squarefree part `f / \gcd(f,f')` or do a full squarefree
factorization to obtain the multiplicities of the roots::
fmpz_poly_factor_t fac;
fmpz_poly_factor_init(fac);
@ -100,6 +100,10 @@ Polynomial roots
currently competitive with state-of-the-art isolation
methods for finding real roots alone.
The following *flags* are supported:
* *ARB_FMPZ_POLY_ROOTS_VERBOSE*
Special polynomials
-------------------------------------------------------------------------------

View file

@ -67,7 +67,32 @@ the default path ``/usr/local``, pass
the correct path to configure (type ``./configure --help`` to show
more options).
After the installation, you may have to run ``ldconfig``.
After the installation, you may have to run ``ldconfig``
to make sure that the system's dynamic linker finds the library.
On a multicore system, ``make`` can be run with the ``-j`` flag to build
in parallel. For example, use ``make -j4`` on a quad-core machine.
Running tests
-------------------------------------------------------------------------------
After running ``make``, it is recommended to also run ``make check``
to verify that all unit tests pass.
By default, the unit tests run a large number of iterations to improve
the chances of detecting subtle problems.
The whole test suite might take around 20 minutes on a single core
(``make -jN check`` if you have more cores to spare).
If you are in a hurry, you can adjust the number of test iterations via
the ``ARB_TEST_MULTIPLIER`` environment variable. For example, the following
will only run 10% of the default iterations::
export ARB_TEST_MULTIPLIER=0.1
make check
It is also possible to run the unit tests for a single module, for instance::
make check MOD=arb_poly
Installation as part of FLINT (deprecated)
-------------------------------------------------------------------------------