1Boost Math Library [](https://travis-ci.org/boostorg/math) 2================== 3 4This library is divided into several interconnected parts: 5 6### Floating Point Utilities 7 8Utility functions for dealing with floating point arithmetic, includes functions for floating point classification (fpclassify, isnan, isinf etc), sign manipulation, rounding, comparison, and computing the distance between floating point numbers. 9 10### Specific Width Floating Point Types 11 12A set of typedefs similar to those provided by <cstdint> but for floating point types. 13 14### Mathematical Constants 15 16A wide range of constants ranging from various multiples of π, fractions, Euler's constant, etc. 17 18These are of course usable from template code, or as non-templates with a simplified interface if that is more appropriate. 19 20### Statistical Distributions 21 22Provides a reasonably comprehensive set of statistical distributions, upon which higher level statistical tests can be built. 23 24The initial focus is on the central univariate distributions. Both continuous (like normal & Fisher) and discrete (like binomial & Poisson) distributions are provided. 25 26A comprehensive tutorial is provided, along with a series of worked examples illustrating how the library is used to conduct statistical tests. 27 28### Special Functions 29 30Provides a small number of high quality special functions; initially these were concentrated on functions used in statistical applications along with those in the Technical Report on C++ Library Extensions. 31 32The function families currently implemented are the gamma, beta & error functions along with the incomplete gamma and beta functions (four variants of each) and all the possible inverses of these, plus the digamma, various factorial functions, Bessel functions, elliptic integrals, hypergeometrics, sinus cardinals (along with their hyperbolic variants), inverse hyperbolic functions, Legrendre/Laguerre/Hermite/Chebyshev polynomials and various special power and logarithmic functions. 33 34All the implementations are fully generic and support the use of arbitrary "real-number" types, including Boost.Multiprecision, although they are optimised for use with types with known significand (or mantissa) sizes: typically float, double or long double. 35 36These functions also provide the basis of support for the TR1 special functions. 37 38### Root Finding and Function Minimisation 39 40A comprehensive set of root-finding algorithms over the real line, both with derivatives and derivative free. 41 42Also function minimisation via Brent's Method. 43 44### Polynomials and Rational Functions 45 46Tools for manipulating polynomials and for efficient evaluation of rationals or polynomials. 47 48### Interpolation 49 50Function interpolation via barycentric rational interpolation, compactly supported quadartic, cubic, and quintic B-splines, the Chebyshev transform, trigonometric polynomials, Makima, pchip, and cubic Hermite splines. 51 52### Numerical Integration and Differentiation 53 54A reasonably comprehensive set of routines for integration (trapezoidal, Gauss-Legendre, Gauss-Kronrod, Gauss-Chebyshev, double-exponential, and Monte-Carlo) and differentiation (Chebyshev transform, finite difference, the complex step derivative, and forward-mode automatic differentiation). 55 56The integration routines are usable for functions returning complex results - and hence can be used for computation of contour integrals. 57 58### Quaternions and Octonions 59 60Quaternion and Octonians as class templates similar to std::complex. 61 62The full documentation is available on [boost.org](http://www.boost.org/doc/libs/release/libs/math). 63 64| | Master | Develop | 65|------------------|----------|-------------| 66| Travis | [](https://travis-ci.org/boostorg/math) | [](https://travis-ci.org/boostorg/math) | 67| Appveyor | [](https://ci.appveyor.com/project/jzmaddock/math/branch/master) | [](https://ci.appveyor.com/project/jzmaddock/math/branch/develop) | 68 69 70 71## Support, bugs and feature requests ## 72 73Bugs and feature requests can be reported through the [GitHub issue tracker](https://github.com/boostorg/math/issues) 74(see [open issues](https://github.com/boostorg/math/issues) and 75[closed issues](https://github.com/boostorg/math/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aclosed)). 76 77You can submit your changes through a [pull request](https://github.com/boostorg/math/pulls). 78 79There is no mailing-list specific to Boost Math, although you can use the general-purpose Boost [mailing-list](http://lists.boost.org/mailman/listinfo.cgi/boost-users) using the tag [math]. 80 81 82## Development ## 83 84Clone the whole boost project, which includes the individual Boost projects as submodules ([see boost+git doc](https://github.com/boostorg/boost/wiki/Getting-Started)): 85 86 $ git clone https://github.com/boostorg/boost 87 $ cd boost 88 $ git submodule update --init 89 90The Boost Math Library is located in `libs/math/`. 91 92### Running tests ### 93First, make sure you are in `libs/math/test`. 94You can either run all the tests listed in `Jamfile.v2` or run a single test: 95 96 test$ ../../../b2 <- run all tests 97 test$ ../../../b2 static_assert_test <- single test 98 test$ # A more advanced syntax, demoing various options for building the tests: 99 test$ ../../../b2 -a -j2 -q --reconfigure toolset=clang cxxflags="--std=c++14 -fsanitize=address -fsanitize=undefined" linkflags="-fsanitize=undefined -fsanitize=address" 100 101### Building documentation ### 102 103Full instructions can be found [here](https://svn.boost.org/trac10/wiki/BoostDocs/GettingStarted), but to reiterate slightly: 104 105```bash 106libs/math/doc$ brew install docbook-xsl # on mac 107libs/math/doc$ touch ~/user-config.jam 108libs/math/doc$ # now edit so that: 109libs/math/doc$ cat ~/user-config.jam 110using darwin ; 111 112using xsltproc ; 113 114using boostbook 115 : /usr/local/opt/docbook-xsl/docbook-xsl 116 ; 117 118using doxygen ; 119using quickbook ; 120libs/math/doc$ ../../../b2 121``` 122
){kind=link}
){kind=link}
){kind=link}