Skip to content

Commit

Permalink
Merge pull request #1082 from boostorg/update_docs
Browse files Browse the repository at this point in the history
Update docs with minor corrections
  • Loading branch information
ckormanyos authored Feb 10, 2024
2 parents b421431 + 9caac5b commit 91f3a22
Showing 1 changed file with 48 additions and 22 deletions.
70 changes: 48 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,24 @@
Boost Math Library
[![Build Status](https://drone.cpp.al/api/badges/boostorg/math/status.svg)](https://drone.cpp.al/boostorg/math)[![Build Status](https://github.com/boostorg/math/workflows/CI/badge.svg?branch=develop)](https://github.com/boostorg/math/actions)
==================
Boost Math Library
============================

>ANNOUNCEMENT: This library now requires a compliant C++14 compiler.
>ANNOUNCEMENT: This library requires a compliant C++14 compiler.
This library is divided into several interconnected parts:
| | Master | Develop |
|------------------|----------|-------------|
| Drone | [![Build Status](https://drone.cpp.al/api/badges/boostorg/math/status.svg?ref=refs/heads/master)](https://drone.cpp.al/boostorg/math) | [![Build Status](https://drone.cpp.al/api/badges/boostorg/math/status.svg)](https://drone.cpp.al/boostorg/math) |
| Github Actions | [![Build Status](https://github.com/boostorg/math/workflows/CI/badge.svg?branch=master)](https://github.com/boostorg/math/actions) | [![Build Status](https://github.com/boostorg/math/workflows/CI/badge.svg?branch=develop)](https://github.com/boostorg/math/actions) |
| Codecov | [![codecov](https://codecov.io/gh/boostorg/math/branch/master/graph/badge.svg)](https://codecov.io/gh/boostorg/math/branch/master) | [![codecov](https://codecov.io/gh/boostorg/math/branch/develop/graph/badge.svg)](https://codecov.io/gh/boostorg/math/branch/develop) |


The Math library provides numerous advanced mathematical functions
implemented in modern C++. The library strives to deliver the utmost
in numerical and syntactical correctness while still
maintaining high-performance.

All code is header-only, facilitating easy client setup
and use throughout the entire diverse collection of functions.

The library is divided into several interconnected parts:

### Floating Point Utilities

Expand All @@ -30,13 +44,25 @@ A comprehensive tutorial is provided, along with a series of worked examples ill

### Special Functions

Provides 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.
Provides a wide range 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.

The 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.
The function families currently implemented are the gamma, beta and 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.

All 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.
All the implementations are fully generic and support the use of arbitrary "real-number" types,
including those in [Boost.Multiprecision](https://github.com/boostorg/multiprecision).
Most functions are, however, optimized for use with types with known significand (or mantissa) sizes:
typically built-in `float`, `double` or `long double`.

These functions also provide the basis of support for the TR1 special functions.
These functions also provide the basis of support for the TR1 special functions,
many of which became standardized in [C++17](https://en.cppreference.com/w/cpp/numeric/special_functions).

### Root Finding

Expand All @@ -52,11 +78,17 @@ Tools for manipulating polynomials and for efficient evaluation of rationals or

### Interpolation

Function interpolation via barycentric rational interpolation, compactly supported quadratic, cubic, and quintic B-splines, the Chebyshev transform, trigonometric polynomials, Makima, pchip, cubic Hermite splines, and bilinear interpolation.
Function interpolation via barycentric rational interpolation,
compactly supported quadratic, cubic, and quintic B-splines,
the Chebyshev transform, trigonometric polynomials, Makima,
pchip, cubic Hermite splines, and bilinear interpolation.

### Numerical Integration and Differentiation

A 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).
A 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).

The integration routines are usable for functions returning complex results - and hence can be used for computation of contour integrals.

Expand All @@ -68,25 +100,19 @@ The full documentation is available on [boost.org](http://www.boost.org/doc/libs

### Standalone Mode

Defining BOOST_MATH_STANDALONE allows Boost.Math to be used without any Boost dependencies. Some functionality is reduced in this mode. A static_assert message will alert you if a particular feature has been disabled by standalone mode.
Defining BOOST_MATH_STANDALONE allows Boost.Math to be used without any Boost dependencies.
Some functionality is reduced in this mode. A static_assert message will alert you
if a particular feature has been disabled by standalone mode.

## Supported Compilers ##

The following compilers are tested with the CI system, and are known to work. Starting with Boost 1.76 (April 2021 Release) a compiler that is fully compliant with C++11 is required to use Boost.Math.
The following compilers are tested with the CI system, and are known to work.
Currently a compiler that is fully compliant with C++14 is required to use Boost.Math.

* g++ 5 or later
* clang++ 5 or later
* Visual Studio 2015 (14.0) or later

## Build Status ##

| | Master | Develop |
|------------------|----------|-------------|
| Github Actions | [![Build Status](https://github.com/boostorg/math/workflows/CI/badge.svg?branch=master)](https://github.com/boostorg/math/actions) | [![Build Status](https://github.com/boostorg/math/workflows/CI/badge.svg?branch=develop)](https://github.com/boostorg/math/actions) |
|Drone | [![Build Status](https://drone.cpp.al/api/badges/boostorg/math/status.svg?ref=refs/heads/master)](https://drone.cpp.al/boostorg/math) | [![Build Status](https://drone.cpp.al/api/badges/boostorg/math/status.svg)](https://drone.cpp.al/boostorg/math) |



## Support, bugs and feature requests ##

Bugs and feature requests can be reported through the [GitHub issue tracker](https://github.com/boostorg/math/issues)
Expand Down

0 comments on commit 91f3a22

Please sign in to comment.