blob: 2db0ceedeb2f04a0fa1bec1a24b786e2b825f47b [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Directory and File Structure</title>
<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
<link rel="home" href="../../index.html" title="Math Toolkit">
<link rel="up" href="../main_overview.html" title="Overview">
<link rel="prev" href="navigation.html" title="Navigation">
<link rel="next" href="namespaces.html" title="Namespaces">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="navigation.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../main_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>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="math_toolkit.main_overview.directories"></a><a class="link" href="directories.html" title="Directory and File Structure"> Directory and
File Structure</a>
</h3></div></div></div>
<a name="math_toolkit.main_overview.directories.boost_math"></a><h5>
<a name="id895299"></a>
<a class="link" href="directories.html#math_toolkit.main_overview.directories.boost_math">boost/math</a>
</h5>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">/concepts/</span></dt>
<dd><p>
Prototype defining the <span class="bold"><strong>essential</strong></span> features
of a RealType class (see real_concept.hpp). Most applications will
use <code class="computeroutput"><span class="keyword">double</span></code> as the RealType
(and short <code class="computeroutput"><span class="keyword">typedef</span></code> names
of distributions 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> <span class="keyword">double</span></code>,
but it is also possible to use higher precision types like <a href="http://shoup.net/ntl/doc/RR.txt" target="_top">NTL::RR</a>
that conform to the requirements specified by real_concept.
</p></dd>
<dt><span class="term">/constants/</span></dt>
<dd><p>
Templated definition of some highly accurate math constants (in constants.hpp).
</p></dd>
<dt><span class="term">/distributions/</span></dt>
<dd><p>
Distributions used in mathematics and, especially, statistics: Gaussian,
Students-t, Fisher, Binomial etc
</p></dd>
<dt><span class="term">/policies/</span></dt>
<dd><p>
Policy framework, for handling user requested behaviour modifications.
</p></dd>
<dt><span class="term">/special_functions/</span></dt>
<dd><p>
Math functions generally regarded as 'special', like beta, cbrt, erf,
gamma, lgamma, tgamma ... (Some of these are specified in C++, and
C99/TR1, and perhaps TR2).
</p></dd>
<dt><span class="term">/tools/</span></dt>
<dd><p>
Tools used by functions, like evaluating polynomials, continued fractions,
root finding, precision and limits, and by tests. Some will find application
outside this package.
</p></dd>
</dl>
</div>
<a name="math_toolkit.main_overview.directories.boost_libs"></a><h5>
<a name="id903100"></a>
<a class="link" href="directories.html#math_toolkit.main_overview.directories.boost_libs">boost/libs</a>
</h5>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">/doc/</span></dt>
<dd><p>
Documentation source files in Quickbook format processed into html
and pdf formats.
</p></dd>
<dt><span class="term">/examples/</span></dt>
<dd><p>
Examples and demos of using math functions and distributions.
</p></dd>
<dt><span class="term">/performance/</span></dt>
<dd><p>
Performance testing and tuning program.
</p></dd>
<dt><span class="term">/test/</span></dt>
<dd><p>
Test files, in various .cpp files, most using Boost.Test (some with
test data as .ipp files, usually generated using NTL RR type with ample
precision for the type, often for precisions suitable for up to 256-bit
significand real types).
</p></dd>
<dt><span class="term">/tools/</span></dt>
<dd><p>
Programs used to generate test data. Also changes to the <a href="http://shoup.net/ntl/" target="_top">NTL</a>
released package to provide a few additional (and vital) extra features.
</p></dd>
</dl>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2006 , 2007, 2008, 2009, 2010 John Maddock, Paul A. Bristow,
Hubert Holin, Xiaogang Zhang, Bruno Lalande, Johan R&#229;de, Gautam Sewani and
Thijs van den Berg<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
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>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="navigation.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../main_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>
</div>
</body>
</html>