Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r66745 - trunk/libs/math/doc/sf_and_dist/html/math_toolkit/main_overview
From: pbristow_at_[hidden]
Date: 2010-11-25 05:03:13

Author: pbristow
Date: 2010-11-25 05:03:09 EST (Thu, 25 Nov 2010)
New Revision: 66745
URL: http://svn.boost.org/trac/boost/changeset/66745

Log:
New file.
Added:
trunk/libs/math/doc/sf_and_dist/html/math_toolkit/main_overview/config_macros.html (contents, props changed)

Added: trunk/libs/math/doc/sf_and_dist/html/math_toolkit/main_overview/config_macros.html
==============================================================================
--- (empty file)
+++ trunk/libs/math/doc/sf_and_dist/html/math_toolkit/main_overview/config_macros.html 2010-11-25 05:03:09 EST (Thu, 25 Nov 2010)
@@ -0,0 +1,414 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Configuration Macros</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="compilers_overview.html" title="Compilers">
+<link rel="next" href="pol_overview.html" title="Policies">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="compilers_overview.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="pol_overview.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.config_macros"></a><a class="link" href="config_macros.html" title="Configuration Macros">Configuration
+ Macros</a>
+</h3></div></div></div>
+
+ Almost all configuration details are set up automatically by <code class="computeroutput"><boost\math\tools\config.hpp></code>.
+ 
+
+ In normal use, only policy configuration macros are likely to be used. See
+ <a class="link" href="../policy/pol_ref.html" title="Policy Reference">policy reference</a>.
+ 
+
+ For reference, information on Boost.Math macros used internally are described
+ briefly below.
+ 
+<div class="table">
+<a name="math_toolkit.main_overview.config_macros.boost_math_macros"></a>Table 11. Boost.Math Macros
+<div class="table-contents"><table class="table" summary="Boost.Math Macros">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ MACRO
+ 
+ </th>
+<th>
+ 
+ Notes
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">BOOST_MATH_NO_REAL_CONCEPT_TESTS</code>
+ 
+ </td>
+<td>
+ 
+ Do not try to use real concept tests (hardware or software does
+ not support real_concept type).
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">BOOST_MATH_NO_LONG_DOUBLE_MATH_FUNCTIONS</code>
+ 
+ </td>
+<td>
+ 
+ Do not produce or use long double functions: this macro gets set
+ when the platform's long double or standard library long double
+ support is absent or buggy.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">BOOST_MATH_CONTROL_FP</code>
+ 
+ </td>
+<td>
+ 
+ Controls FP hardware exceptions - our tests don't support hardware
+ exceptions on MSVC. May get set to something like: <code class="computeroutput"> _control87(MCW_EM,MCW_EM)</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">BOOST_MATH_NO_DEDUCED_FUNCTION_POINTERS</code>
+ 
+ </td>
+<td>
+ 
+ This macro is used by our test cases, it is set when an assignment
+ of a function template to a function pointer requires explicit
+ template arguments to be provided on the function name.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">BOOST_MATH_USE_C99</code>
+ 
+ </td>
+<td>
+ 
+ Use C99 math functions.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">BOOST_NO_NATIVE_LONG_DOUBLE_FP_CLASSIFY</code>
+ 
+ </td>
+<td>
+ 
+ define if no native (or buggy) <code class="computeroutput">fpclassify(long
+ double)</code>
+ even though the other C99 functions are present.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">BOOST_MATH_EXPLICIT_TEMPLATE_TYPE</code>
+ 
+ </td>
+<td>
+ 
+ Workaround helper macro for broken compilers - composed from other
+ Boost.Config macros, do not edit.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">BOOST_MATH_EXPLICIT_TEMPLATE_NON_TYPE</code>
+ 
+ </td>
+<td>
+ 
+ Workaround helper macro for broken compilers - composed from other
+ Boost.Config macros, do not edit.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">BOOST_MATH_APPEND_EXPLICIT_TEMPLATE_TYPE_SPEC</code>
+ 
+ </td>
+<td>
+ 
+ Workaround helper macro for broken compilers - composed from other
+ Boost.Config macros, do not edit.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">BOOST_MATH_APPEND_EXPLICIT_TEMPLATE_NON_TYPE_SPEC</code>
+ 
+ </td>
+<td>
+ 
+ Workaround helper macro for broken compilers - composed from other
+ Boost.Config macros, do not edit.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">BOOST_MATH_SMALL_CONSTANT(x)</code>
+ 
+ </td>
+<td>
+ 
+ Helper macro used in our test cases to set underflowing constants
+ set to zero if this would cause compiler issues.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">BOOST_MATH_BUGGY_LARGE_FLOAT_CONSTANTS</code>
+ 
+ </td>
+<td>
+ 
+ Set if constants too large for a float, will cause "bad"
+ values to be stored in the data, rather than infinity or a suitably
+ large value.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">BOOST_MATH_STD_USING</code>
+ 
+ </td>
+<td>
+ 
+ Provides <code class="computeroutput">using</code> statements
+ for many std:: (abs to sqrt) and boost::math (rounds, modf) functions.
+ This allows these functions to be called unqualified so that if
+ <a href="http://en.wikipedia.org/wiki/Argument-dependent_name_lookup" target="_top">argument-dependent
+ Argument Dependent Lookup</a> fails to find a suitable overload,
+ then the std:: versions will also be considered.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">BOOST_FPU_EXCEPTION_GUARD</code>
+ 
+ </td>
+<td>
+ 
+ Used at the entrypoint to each special function to reset all FPU
+ exception flags prior to internal calculations, and then merge
+ the old and new exception flags on function exit. Used as a workaround
+ on platforms or hardware that behave strangely if any FPU exception
+ flags are set when calling standard library functions.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">BOOST_MATH_INSTRUMENT</code>
+ 
+ </td>
+<td>
+ 
+ Define to output diagnostics for math functions. This is rather
+ 'global' to Boost.Math and so coarse-grained that it will probably
+ produce copious output! (Especially because full precision values
+ are output). Designed primarily for internal use and development.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">BOOST_MATH_INSTRUMENT_CODE(x)</code>
+ 
+ </td>
+<td>
+ 
+ Output selected named variable, for example <code class="computeroutput">BOOST_MATH_INSTRUMENT_CODE("guess = "
+ << guess)</code>; Used by <code class="computeroutput">BOOST_MATH_INSTRUMENT</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">BOOST_MATH_INSTRUMENT_VARIABLE(name)</code>
+ 
+ </td>
+<td>
+ 
+ Output selected variable, for example <code class="computeroutput">BOOST_MATH_INSTRUMENT_VARIABLE(result);</code> Used by <code class="computeroutput">BOOST_MATH_INSTRUMENT</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">BOOST_MATH_INSTRUMENT_FPU</code>
+ 
+ </td>
+<td>
+ 
+ Output the state of the FPU's control flags.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+ <div class="table">
+<a name="math_toolkit.main_overview.config_macros.boost_math_tuning"></a>Table 12. Boost.Math Tuning
+<div class="table-contents"><table class="table" summary="Boost.Math Tuning">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Macros for Tuning performance options for specific compilers
+ 
+ </th>
+<th>
+ 
+ Notes
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">BOOST_MATH_POLY_METHOD</code>
+ 
+ </td>
+<td>
+ 
+ See the <a class="link" href="../perf/tuning.html" title="Performance Tuning Macros">performance tuning
+ section</a>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">BOOST_MATH_RATIONAL_METHOD</code>
+ 
+ </td>
+<td>
+ 
+ See the <a class="link" href="../perf/tuning.html" title="Performance Tuning Macros">performance tuning
+ section</a>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">BOOST_MATH_MAX_POLY_ORDER</code>
+ 
+ </td>
+<td>
+ 
+ See the <a class="link" href="../perf/tuning.html" title="Performance Tuning Macros">performance tuning
+ section</a>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">BOOST_MATH_INT_TABLE_TYPE</code>
+ 
+ </td>
+<td>
+ 
+ See the <a class="link" href="../perf/tuning.html" title="Performance Tuning Macros">performance tuning
+ section</a>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">BOOST_MATH_INT_VALUE_SUFFIX</code>
+ 
+ </td>
+<td>
+ 
+ Helper macro for appending the correct suffix to integer constants
+ which may actually be stored as reals depending on the value of
+ BOOST_MATH_INT_TABLE_TYPE.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+</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 © 2006 , 2007, 2008, 2009, 2010 John Maddock, Paul A. Bristow,
+ Hubert Holin, Xiaogang Zhang, Bruno Lalande, Johan Råde, Gautam Sewani and
+ Thijs van den Berg
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="compilers_overview.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="pol_overview.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Date view	Thread view	Subject view	Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk