ceph/src/boost/libs/multiprecision/README.md

   1 Boost Multiprecision Library
   2 ============================
   3
   4 >ANNOUNCEMENT: Support for C++03 is now removed from this library.  Any attempt to build with a non C++11 conforming compiler is doomed to failure.
   5
   6 |                  |  Master  |   Develop   |
   7 |------------------|----------|-------------|
   8 | Drone            |  [![Build Status](https://drone.cpp.al/api/badges/boostorg/multiprecision/status.svg?ref=refs/heads/master)](https://drone.cpp.al/boostorg/multiprecision) | [![Build Status](https://drone.cpp.al/api/badges/boostorg/multiprecision/status.svg)](https://drone.cpp.al/boostorg/multiprecision) |
   9 | Github Actions | [![Build Status](https://github.com/boostorg/multiprecision/workflows/multiprecision/badge.svg?branch=master)](https://github.com/boostorg/multiprecision/actions) | [![Build Status](https://github.com/boostorg/multiprecision/workflows/multiprecision/badge.svg?branch=develop)](https://github.com/boostorg/multiprecision/actions) |
  10
  11  The Multiprecision Library provides integer, rational, floating-point, complex and interval number types in C++ that have more range and
  12  precision than C++'s ordinary built-in types. The big number types in Multiprecision can be used with a wide selection of basic
  13  mathematical operations, elementary transcendental functions as well as the functions in Boost.Math. The Multiprecision types can
  14  also interoperate with the built-in types in C++ using clearly defined conversion rules. This allows Boost.Multiprecision to be
  15  used for all kinds of mathematical calculations involving integer, rational and floating-point types requiring extended range and precision.
  16
  17 Multiprecision consists of a generic interface to the mathematics of large numbers as well as a selection of big number back ends, with
  18 support for integer, rational and floating-point types. Boost.Multiprecision provides a selection of back ends provided off-the-rack in
  19 including interfaces to GMP, MPFR, MPIR, TomMath as well as its own collection of Boost-licensed, header-only back ends for integers,
  20 rationals, floats and complex. In addition, user-defined back ends can be created and used with the interface of Multiprecision, provided the class implementation adheres to the necessary concepts.
  21
  22 Depending upon the number type, precision may be arbitrarily large (limited only by available memory), fixed at compile time
  23 (for example 50 or 100 decimal digits), or a variable controlled at run-time by member functions. The types are expression-template-enabled
  24 for better performance than naive user-defined types.
  25
  26 The full documentation is available on [boost.org](http://www.boost.org/doc/libs/release/libs/multiprecision/index.html).
  27
  28 ## Standalone (BETA) ##
  29
  30 Defining BOOST_MP_STANDALONE allows Boost.Multiprecision to be used with the only dependency being [Boost.Config](https://github.com/boostorg/config). Our package on this page
  31 already includes a copy of Boost.Config so no other donwloads are required. Some functionality is reduced in this mode. A static_assert message will alert you if a particular feature has been disabled by standalone mode.
  32 [Boost.Math](https://github.com/boostorg/math) standalone mode is compatiable, and recommended if special functions is required.
  33
  34 ## Support, bugs and feature requests ##
  35
  36 Bugs and feature requests can be reported through the [Gitub issue tracker](https://github.com/boostorg/multiprecision/issues)
  37 (see [open issues](https://github.com/boostorg/multiprecision/issues) and
  38 [closed issues](https://github.com/boostorg/multiprecision/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aclosed)).
  39
  40 You can submit your changes through a [pull request](https://github.com/boostorg/multiprecision/pulls).
  41
  42 There is no mailing-list specific to Boost Multiprecision, although you can use the general-purpose Boost [mailing-list](http://lists.boost.org/mailman/listinfo.cgi/boost-users) using the tag [multiprecision].
  43
  44
  45 ## Development ##
  46
  47 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)):
  48
  49     git clone https://github.com/boostorg/boost
  50     cd boost
  51     git submodule update --init
  52
  53 The Boost Multiprecision Library is located in `libs/multiprecision/`.
  54
  55 ### Running tests ###
  56 First, build the B2 engine by running `bootstrap.sh` in the root of the boost directory. This will generate B2 configuration in `project-config.jam`.
  57
  58     ./bootstrap.sh
  59
  60 Now make sure you are in `libs/multiprecision/test`. You can either run all the tests listed in `Jamfile.v2` or run a single test:
  61
  62     ../../../b2                        <- run all tests
  63     ../../../b2 test_complex           <- single test
  64