libs/math/doc/html/math_toolkit/directories.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Directory and File Structure</title>
   5 <link rel="stylesheet" href="../math.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../index.html" title="Math Toolkit 2.11.0">
   8 <link rel="up" href="../overview.html" title="Chapter&#160;1.&#160;Overview">
   9 <link rel="prev" href="hints.html" title="Other Hints and tips">
  10 <link rel="next" href="namespaces.html" title="Namespaces">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="hints.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../overview.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="namespaces.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
  27 <a name="math_toolkit.directories"></a><a class="link" href="directories.html" title="Directory and File Structure">Directory and File Structure</a>
  28 </h2></div></div></div>
  29 <h5>
  30 <a name="math_toolkit.directories.h0"></a>
  31       <span class="phrase"><a name="math_toolkit.directories.boost_math"></a></span><a class="link" href="directories.html#math_toolkit.directories.boost_math">boost/math</a>
  32     </h5>
  33 <div class="variablelist">
  34 <p class="title"><b></b></p>
  35 <dl class="variablelist">
  36 <dt><span class="term">/concepts/</span></dt>
  37 <dd><p>
  38             Prototype defining the <span class="bold"><strong>essential</strong></span> features
  39             of a RealType class (see real_concept.hpp). Most applications will use
  40             <code class="computeroutput"><span class="keyword">double</span></code> as the RealType (and
  41             short <code class="computeroutput"><span class="keyword">typedef</span></code> names of distributions
  42             are reserved for this type where possible), a few will use <code class="computeroutput"><span class="keyword">float</span></code> or <code class="computeroutput"><span class="keyword">long</span>
  43             <span class="keyword">double</span></code>, but it is also possible
  44             to use higher precision types like <a href="http://shoup.net/ntl/doc/RR.txt" target="_top">NTL::RR</a>,
  45             <a href="http://gmplib.org/" target="_top">GNU Multiple Precision Arithmetic Library</a>,
  46             <a href="http://www.mpfr.org/" target="_top">GNU MPFR library</a>, <a href="../../../../../libs/multiprecision/doc/html/index.html" target="_top">Boost.Multiprecision</a>
  47             like cpp_bin_float_50 that conform to the requirements specified by
  48             <code class="computeroutput"><span class="identifier">real_concept</span></code>.
  49           </p></dd>
  50 <dt><span class="term">/constants/</span></dt>
  51 <dd><p>
  52             Templated definition of some highly accurate math constants (<a href="https://github.com/boostorg/math/blob/develop/include/boost/math/constants/constants.hpp" target="_top">constants.hpp</a>).
  53           </p></dd>
  54 <dt><span class="term">/distributions/</span></dt>
  55 <dd><p>
  56             Distributions used in mathematics and, especially, statistics: Gaussian,
  57             Students-t, Fisher, Binomial etc
  58           </p></dd>
  59 <dt><span class="term">/policies/</span></dt>
  60 <dd><p>
  61             Policy framework, for handling user requested behaviour modifications.
  62           </p></dd>
  63 <dt><span class="term">/special_functions/</span></dt>
  64 <dd><p>
  65             Math functions generally regarded as 'special', like beta, cbrt, erf,
  66             gamma, lgamma, tgamma ... (Some of these are specified in C++, and C99/TR1,
  67             and perhaps TR2).
  68           </p></dd>
  69 <dt><span class="term">/tools/</span></dt>
  70 <dd><p>
  71             Tools used by functions, like evaluating polynomials, continued fractions,
  72             root finding, precision and limits, and by tests. Some will find application
  73             outside this package.
  74           </p></dd>
  75 </dl>
  76 </div>
  77 <h5>
  78 <a name="math_toolkit.directories.h1"></a>
  79       <span class="phrase"><a name="math_toolkit.directories.boost_libs"></a></span><a class="link" href="directories.html#math_toolkit.directories.boost_libs">boost/libs</a>
  80     </h5>
  81 <div class="variablelist">
  82 <p class="title"><b></b></p>
  83 <dl class="variablelist">
  84 <dt><span class="term">/doc/</span></dt>
  85 <dd><p>
  86             Documentation source files in Quickbook format processed into html and
  87             pdf formats.
  88           </p></dd>
  89 <dt><span class="term">/examples/</span></dt>
  90 <dd><p>
  91             Examples and demos of using math functions and distributions.
  92           </p></dd>
  93 <dt><span class="term">/performance/</span></dt>
  94 <dd><p>
  95             Performance testing and tuning program.
  96           </p></dd>
  97 <dt><span class="term">/test/</span></dt>
  98 <dd><p>
  99             Test files, in many .cpp files, most using Boost.Test (some with test
 100             data as .ipp files, usually generated using NTL RR type with ample precision
 101             for the type, often for precisions suitable for up to 256-bit significand
 102             real types).
 103           </p></dd>
 104 <dt><span class="term">/tools/</span></dt>
 105 <dd><p>
 106             Programs used to generate test data. Also changes to the <a href="http://shoup.net/ntl/" target="_top">NTL</a>
 107             released package to provide a few additional (and vital) extra features.
 108           </p></dd>
 109 </dl>
 110 </div>
 111 </div>
 112 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 113 <td align="left"></td>
 114 <td align="right"><div class="copyright-footer">Copyright &#169; 2006-2019 Nikhar
 115       Agrawal, Anton Bikineev, Paul A. Bristow, Marco Guazzone, Christopher Kormanyos,
 116       Hubert Holin, Bruno Lalande, John Maddock, Jeremy Murphy, Matthew Pulver, Johan
 117       R&#229;de, Gautam Sewani, Benjamin Sobotta, Nicholas Thompson, Thijs van den Berg,
 118       Daryle Walker and Xiaogang Zhang<p>
 119         Distributed under the Boost Software License, Version 1.0. (See accompanying
 120         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
 121       </p>
 122 </div></td>
 123 </tr></table>
 124 <hr>
 125 <div class="spirit-nav">
 126 <a accesskey="p" href="hints.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../overview.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="namespaces.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
 127 </div>
 128 </body>
 129 </html>