Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r74696 - in sandbox/local/libs/local/doc: html html/boost/local/function html/boost_local qbk
From: lorcaminiti_at_[hidden]
Date: 2011-10-04 11:05:58

Author: lcaminiti
Date: 2011-10-04 11:05:57 EDT (Tue, 04 Oct 2011)
New Revision: 74696
URL: http://svn.boost.org/trac/boost/changeset/74696

Log:
Upd docs.
Text files modified:
   sandbox/local/libs/local/doc/html/BOOST_IDENTITY_TYPE.html | 2 +-
   sandbox/local/libs/local/doc/html/BOOST_IDENTITY_VALUE.html | 2 +-
   sandbox/local/libs/local/doc/html/BOOST_LOCAL_TYPEOF.html | 2 +-
   sandbox/local/libs/local/doc/html/boost/local/function/overload.html | 22 +++++++++++-----------
   sandbox/local/libs/local/doc/html/boost_local/Alternatives.html | 16 ++++++++++------
   sandbox/local/libs/local/doc/html/index.html | 2 +-
   sandbox/local/libs/local/doc/qbk/alternatives.qbk | 6 ++++--
   7 files changed, 29 insertions(+), 23 deletions(-)

Modified: sandbox/local/libs/local/doc/html/BOOST_IDENTITY_TYPE.html
==============================================================================
--- sandbox/local/libs/local/doc/html/BOOST_IDENTITY_TYPE.html (original)
+++ sandbox/local/libs/local/doc/html/BOOST_IDENTITY_TYPE.html 2011-10-04 11:05:57 EDT (Tue, 04 Oct 2011)
@@ -33,7 +33,7 @@

BOOST_IDENTITY_TYPE(parenthesized_type)</pre></div>
<div class="refsect1">
-<a name="id926850"></a><h2>Description</h2>
+<a name="id926852"></a><h2>Description</h2>
This macro expands to an expression that can be passed as a single macro parameter even if it contains commas and that evaluates to the specified type at compile-time (see the <a class="link" href="boost_local/Advanced_Topics.html" title="Advanced Topics"> Advanced Topics</a> section).
For example <code class="computeroutput">BOOST_IDENTITY_TYPE((std::map<int, double>))</code> can be passed as a single macro parameter when instead <code class="computeroutput">std::map<int, double></code> cannot (because <code class="computeroutput">std::map<int, double></code> contains a comma not wrapped by round parenthesis so it will be interpreted as two separate macro parameters by the preprocessor).
On some compilers (like GCC), using this macro on abstract types (classes with one or more pure virtual functions) generate a compile-time error. This can be worked around by manipulating the type adding and removing a reference to it:

Modified: sandbox/local/libs/local/doc/html/BOOST_IDENTITY_VALUE.html
==============================================================================
--- sandbox/local/libs/local/doc/html/BOOST_IDENTITY_VALUE.html (original)
+++ sandbox/local/libs/local/doc/html/BOOST_IDENTITY_VALUE.html 2011-10-04 11:05:57 EDT (Tue, 04 Oct 2011)
@@ -33,7 +33,7 @@

BOOST_IDENTITY_VALUE(parenthesized_value)</pre></div>
<div class="refsect1">
-<a name="id927164"></a><h2>Description</h2>
+<a name="id927167"></a><h2>Description</h2>
This macro expands to an expression that can be passed as a single macro parameter even if it contains commas and that evaluates to the specified value at run-time (see the <a class="link" href="boost_local/Advanced_Topics.html" title="Advanced Topics"> Advanced Topics</a> section).
For example <code class="computeroutput">BOOST_IDENTITY_VALUE((key_sizeof<int, double>::value))</code> can be passed as a single macro parameter when instead <code class="computeroutput">key_sizeof<int, double>::value</code> cannot (because <code class="computeroutput">key_sizeof<int, double>::value</code> contains a comma not wrapped by round parenthesis so it will be interpreted as two separate macro parameters by the preprocessor).
Parameters:

Modified: sandbox/local/libs/local/doc/html/BOOST_LOCAL_TYPEOF.html
==============================================================================
--- sandbox/local/libs/local/doc/html/BOOST_LOCAL_TYPEOF.html (original)
+++ sandbox/local/libs/local/doc/html/BOOST_LOCAL_TYPEOF.html 2011-10-04 11:05:57 EDT (Tue, 04 Oct 2011)
@@ -33,7 +33,7 @@

BOOST_LOCAL_TYPEOF(bound_variable_name)</pre></div>
<div class="refsect1">
-<a name="id926528"></a><h2>Description</h2>
+<a name="id926531"></a><h2>Description</h2>
The type is fully qualified in that it contains the extra constant and reference qualifiers when they are specified for binding by constant and by reference. For example, if a variable named <code class="computeroutput">t</code> of type <code class="computeroutput">T</code> is: 
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">Bound by value using <code class="computeroutput">bind t</code> then <code class="computeroutput">BOOST_LOCAL_TYPEOF(t)</code> is <code class="computeroutput">T</code>. </li>

Modified: sandbox/local/libs/local/doc/html/boost/local/function/overload.html
==============================================================================
--- sandbox/local/libs/local/doc/html/boost/local/function/overload.html (original)
+++ sandbox/local/libs/local/doc/html/boost/local/function/overload.html 2011-10-04 11:05:57 EDT (Tue, 04 Oct 2011)
@@ -35,37 +35,37 @@
class <a class="link" href="overload.html" title="Class template overload">overload</a> {
public:
 // <a class="link" href="overload.html#boost.local.function.overloadconstruct-copy-destruct">construct/copy/destruct</a>
- <a class="link" href="overload.html#id436005-bb">overload</a>(const boost::function< F0 > &, const boost::function< F1 > &, ...);
+ <a class="link" href="overload.html#id435998-bb">overload</a>(const boost::function< F0 > &, const boost::function< F1 > &, ...);

- // <a class="link" href="overload.html#id435926-bb">public member functions</a>
- result_type< F0 > <a class="link" href="overload.html#id435930-bb">operator()</a>(arg0_type< F0 >, arg1_type< F0 >, ...) const;
- result_type< F1 > <a class="link" href="overload.html#id435967-bb">operator()</a>(arg0_type< F1 >, arg1_type< F1 >, ...) const;
+ // <a class="link" href="overload.html#id435919-bb">public member functions</a>
+ result_type< F0 > <a class="link" href="overload.html#id435923-bb">operator()</a>(arg0_type< F0 >, arg1_type< F0 >, ...) const;
+ result_type< F1 > <a class="link" href="overload.html#id435960-bb">operator()</a>(arg0_type< F1 >, arg1_type< F1 >, ...) const;
};</pre></div>
<div class="refsect1">
-<a name="id925825"></a><h2>Description</h2>
+<a name="id925827"></a><h2>Description</h2>
This functor aggregates together calls to functions of all the specified function types <code class="computeroutput">F0</code>, <code class="computeroutput">F1</code>, etc. Each function type must be specified following the Boost.Function preferred syntax: 
<pre class="programlisting"> ResultType (ArgumentType0, ArgumgnetType1, ...)
</pre>
The maximum number of overloaded function types is specified by the <code class="computeroutput"><a class="link" href="../../../BOOST_LOCAL_CONFIG_OVERLOAD_MAX.html" title="Macro BOOST_LOCAL_CONFIG_OVERLOAD_MAX">BOOST_LOCAL_CONFIG_OVERLOAD_MAX</a></code> configuration macro. The maximum number of function parameters for each of the specified function type is specified by the <code class="computeroutput"><a class="link" href="../../../BOOST_LOCAL_CONFIG_OVERLOAD_MAX.html" title="Macro BOOST_LOCAL_CONFIG_OVERLOAD_MAX">BOOST_LOCAL_CONFIG_OVERLOAD_MAX</a></code> configuration macro.
See: <a class="link" href="../../../boost_local/Advanced_Topics.html" title="Advanced Topics"> Advanced Topics</a> section, <code class="computeroutput"><a class="link" href="../../../BOOST_LOCAL_CONFIG_OVERLOAD_MAX.html" title="Macro BOOST_LOCAL_CONFIG_OVERLOAD_MAX">BOOST_LOCAL_CONFIG_OVERLOAD_MAX</a></code>, <code class="computeroutput"><a class="link" href="../../../BOOST_LOCAL_CONFIG_OVERLOAD_MAX.html" title="Macro BOOST_LOCAL_CONFIG_OVERLOAD_MAX">BOOST_LOCAL_CONFIG_OVERLOAD_MAX</a></code>, Boost.Function. 
<div class="refsect2">
-<a name="id925968"></a><h3>
+<a name="id925970"></a><h3>
<a name="boost.local.function.overloadconstruct-copy-destruct"></a><code class="computeroutput">overload</code>
 public
 construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
-<pre class="literallayout"><a name="id436005-bb"></a>overload(const boost::function< F0 > &, const boost::function< F1 > &, ...);</pre>Construct the overloading functor. Any functor that can be converted to a <code class="computeroutput">boost::function</code> funcotr can be specified (local functions, functio
n pointers, other functors, etc). 
+<pre class="literallayout"><a name="id435998-bb"></a>overload(const boost::function< F0 > &, const boost::function< F1 > &, ...);</pre>Construct the overloading functor. Any functor that can be converted to a <code class="computeroutput">boost::function</code> funcotr can be specified (local functions, functio
n pointers, other functors, etc). 
</li></ol></div>
</div>
<div class="refsect2">
-<a name="id926144"></a><h3>
-<a name="id435926-bb"></a><code class="computeroutput">overload</code> public member functions</h3>
+<a name="id926146"></a><h3>
+<a name="id435919-bb"></a><code class="computeroutput">overload</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
-<pre class="literallayout">result_type< F0 > <a name="id435930-bb"></a>operator()(arg0_type< F0 >, arg1_type< F0 >, ...) const;</pre>Call operator matching the signature of the function type specified as first. This will in turn invoke the call operator of the first functor that was passed to the constructor. 
+<pre class="literallayout">result_type< F0 > <a name="id435923-bb"></a>operator()(arg0_type< F0 >, arg1_type< F0 >, ...) const;</pre>Call operator matching the signature of the function type specified as first. This will in turn invoke the call operator of the first functor that was passed to the constructor. 
</li>
<li class="listitem">
-<pre class="literallayout">result_type< F1 > <a name="id435967-bb"></a>operator()(arg0_type< F1 >, arg1_type< F1 >, ...) const;</pre>Call operator matching the signature of the function type specified as second. This will in turn invoke the call operator of the second functor that was passed to the constructor. 
+<pre class="literallayout">result_type< F1 > <a name="id435960-bb"></a>operator()(arg0_type< F1 >, arg1_type< F1 >, ...) const;</pre>Call operator matching the signature of the function type specified as second. This will in turn invoke the call operator of the second functor that was passed to the constructor. 
</li>
</ol></div>
</div>

Modified: sandbox/local/libs/local/doc/html/boost_local/Alternatives.html
==============================================================================
--- sandbox/local/libs/local/doc/html/boost_local/Alternatives.html (original)
+++ sandbox/local/libs/local/doc/html/boost_local/Alternatives.html 2011-10-04 11:05:57 EDT (Tue, 04 Oct 2011)
@@ -28,6 +28,8 @@
</h2></div></div></div>
<div class="toc"><dl>
<dt>Local Functions</dt>
+<dt><a href="Alternatives.html#boost_local.Alternatives.local_function_benchmarking">Local
+ Function Benchmarking</a></dt>
<dt>Local Blocks</dt>
<dt>Local Exits</dt>
</dl></div>
@@ -905,13 +907,15 @@
</pre>

 
-<a name="boost_local.Alternatives.local_functions.profiling"></a><h6>
-<a name="boost_local.Alternatives.local_functions.profiling-heading"></a>
- <a class="link" href="Alternatives.html#boost_local.Alternatives.local_functions.profiling">Profiling</a>
- </h6>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_local.Alternatives.local_function_benchmarking"></a><a class="link" href="Alternatives.html#boost_local.Alternatives.local_function_benchmarking" title="Local Function Benchmarking">Local
+ Function Benchmarking</a>
+</h3></div></div></div>

- The following tables compare run-time, binary size, and compile-time for
- the different alternatives presented for local functions.
+ The following tables compare run-times, compile-times, and binary sizes for
+ the different alternatives presented so far for local functions.
 

 Overall, this library has compile-times and generates binary sizes similar

Modified: sandbox/local/libs/local/doc/html/index.html
==============================================================================
--- sandbox/local/libs/local/doc/html/index.html (original)
+++ sandbox/local/libs/local/doc/html/index.html 2011-10-04 11:05:57 EDT (Tue, 04 Oct 2011)
@@ -432,7 +432,7 @@
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left">Last revised: October 04, 2011 at 14:48:00 GMT</td>
+<td align="left">Last revised: October 04, 2011 at 15:04:05 GMT</td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>

Modified: sandbox/local/libs/local/doc/qbk/alternatives.qbk
==============================================================================
--- sandbox/local/libs/local/doc/qbk/alternatives.qbk (original)
+++ sandbox/local/libs/local/doc/qbk/alternatives.qbk 2011-10-04 11:05:57 EDT (Tue, 04 Oct 2011)
@@ -144,9 +144,11 @@

[add_using_boost_phoenix_cpp]

-[h5 Profiling]
+[endsect]
+
+[section Local Function Benchmarking]

-The following tables compare run-time, binary size, and compile-time for the different alternatives presented for local functions.
+The following tables compare run-times, compile-times, and binary sizes for the different alternatives presented so far for local functions.

Overall, this library has compile-times and generates binary sizes similar to the ones of the other approaches.
This library run-times on __CPP03__ compliant compilers (see "__Boost_Local__ Compliant" below) were measured to be larger than other approaches when compiler optimization is enabled (using `bjam release ...`).

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