mirror of
https://github.com/boostorg/math.git
synced 2026-01-19 04:22:09 +00:00
Handle issue 1255 and update docs
This commit is contained in:
ckormanyos
28
README.md
28
README.md
@@ -3,11 +3,12 @@ Boost Math Library
|
||||
|
||||
>ANNOUNCEMENT: This library requires a compliant C++14 compiler.
|
||||
|
||||
|
||||
| | Master | Develop |
|
||||
|------------------|----------|-------------|
|
||||
| Drone | [](https://drone.cpp.al/boostorg/math) | [](https://drone.cpp.al/boostorg/math) |
|
||||
| Github Actions | [](https://github.com/boostorg/math/actions) | [](https://github.com/boostorg/math/actions) |
|
||||
| Codecov | [](https://codecov.io/gh/boostorg/math/branch/master) | [](https://codecov.io/gh/boostorg/math/branch/develop) |
|
||||
| Drone | [](https://drone.cpp.al/boostorg/math) | [](https://drone.cpp.al/boostorg/math) |
|
||||
| Github Actions | [](https://github.com/boostorg/math/actions?query=branch%3Amaster) | [](https://github.com/boostorg/math/actions?query=branch%3Adevelop) |
|
||||
| Codecov | [](https://codecov.io/gh/boostorg/math/branch/master) | [](https://codecov.io/gh/boostorg/math/branch/develop) |
|
||||
|
||||
|
||||
The Math library provides numerous advanced mathematical functions
|
||||
@@ -26,11 +27,11 @@ Utility functions for dealing with floating point arithmetic, includes functions
|
||||
|
||||
### Specific Width Floating Point Types
|
||||
|
||||
A set of typedefs similar to those provided by `<cstdint>` but for floating point types.
|
||||
A set of `typedef`s similar to those provided by C++20's `<stdfloat>` but in `namespace boost`.
|
||||
|
||||
### Mathematical Constants
|
||||
|
||||
A wide range of constants ranging from various multiples of π, fractions, Euler's constant, etc.
|
||||
A wide range of constants ranging from fractions to various multiples of $\pi$, Euler's constant, etc.
|
||||
|
||||
These are of course usable from template code, or as non-templates with a simplified interface if that is more appropriate.
|
||||
|
||||
@@ -100,12 +101,12 @@ 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.
|
||||
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. Standalone mode is not designed to
|
||||
be used with the rest of boost, and may result in compiler errors.
|
||||
|
||||
## Supported Compilers ##
|
||||
## Supported Compilers
|
||||
|
||||
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.
|
||||
@@ -114,7 +115,7 @@ Currently a compiler that is fully compliant with C++14 is required to use Boost
|
||||
* clang++ 5 or later
|
||||
* Visual Studio 2015 (14.0) or later
|
||||
|
||||
## Support, bugs and feature requests ##
|
||||
## Support, bugs and feature requests
|
||||
|
||||
Bugs and feature requests can be reported through the [GitHub issue tracker](https://github.com/boostorg/math/issues)
|
||||
(see [open issues](https://github.com/boostorg/math/issues) and
|
||||
@@ -125,7 +126,7 @@ You can submit your changes through a [pull request](https://github.com/boostorg
|
||||
There 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].
|
||||
|
||||
|
||||
## Development ##
|
||||
## Development
|
||||
|
||||
Clone the whole boost project, which includes the individual Boost projects as submodules ([see boost+git doc](https://github.com/boostorg/boost/wiki/Getting-Started)):
|
||||
|
||||
@@ -135,7 +136,8 @@ Clone the whole boost project, which includes the individual Boost projects as s
|
||||
|
||||
The Boost Math Library is located in `libs/math/`.
|
||||
|
||||
### Running tests ###
|
||||
### Running tests
|
||||
|
||||
First, make sure you are in `libs/math/test`.
|
||||
You can either run all the tests listed in `Jamfile.v2` or run a single test:
|
||||
|
||||
@@ -144,7 +146,8 @@ You can either run all the tests listed in `Jamfile.v2` or run a single test:
|
||||
test$ # A more advanced syntax, demoing various options for building the tests:
|
||||
test$ ../../../b2 -a -j2 -q --reconfigure toolset=clang cxxflags="--std=c++14 -fsanitize=address -fsanitize=undefined" linkflags="-fsanitize=undefined -fsanitize=address"
|
||||
|
||||
### Continuous Integration ###
|
||||
### Continuous Integration
|
||||
|
||||
The default action for a PR or commit to a PR is for CI to run the full complement of tests. The following can be appended to the end of a commit message to modify behavior:
|
||||
|
||||
* [ci skip] to skip all tests
|
||||
@@ -153,7 +156,8 @@ The default action for a PR or commit to a PR is for CI to run the full compleme
|
||||
* [windows] to test MSVC-14.0, MSVC-14.2, MSVC-14.3, CYGWIN, and mingw on the latest version of Windows.
|
||||
* [standalone] to run standalone mode compile tests
|
||||
|
||||
### Building documentation ###
|
||||
|
||||
### Building documentation
|
||||
|
||||
Full instructions can be found [here](https://svn.boost.org/trac10/wiki/BoostDocs/GettingStarted), but to reiterate slightly:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user