|
Boost-Commit :
|
Author: e_r
Date: 2010-03-10 10:01:27 EST (Wed, 10 Mar 2010)
New Revision: 60418
URL: http://svn.boost.org/trac/boost/changeset/60418
Log:
m
Text files modified:
sandbox/statistics/detail/assign/libs/assign/doc/index.html | 85 +++++++++++++++++++++------------------
1 files changed, 45 insertions(+), 40 deletions(-)
Modified: sandbox/statistics/detail/assign/libs/assign/doc/index.html
==============================================================================
--- sandbox/statistics/detail/assign/libs/assign/doc/index.html (original)
+++ sandbox/statistics/detail/assign/libs/assign/doc/index.html 2010-03-10 10:01:27 EST (Wed, 10 Mar 2010)
@@ -499,29 +499,30 @@
<code>cref_list_of()</code> accepts rvalues too, as exemplified by the first three arguments of the
corresponding function call in this example.
-<p> The collection built from <code>ref_list_of()</code> and <code>cref_list_of()</code> has most of the functionality of <code>boost::array<></code>, and
-the same conversion capabilities as the collection built from <code>list_of()</code>. However, the user can design his own 'policy' and call it with the overloaded functions
-<code>ref_list_of<P>()</code> and
-<code>cref_list_of<P>()</code>, where <code>P</code> is an associated policy tag. See the reference for details
+<p> A collection built from <code>ref_list_of()</code> and <code>cref_list_of()</code> has most of the functionality of <code>boost::array<></code>, and
+the same conversion capabilities as a collection built from <code>list_of()</code>. However, the user can customize his own functionality via a policy and
+call it with the overloaded functions <code>ref_list_of<P>()</code> and <code>cref_list_of<P>()</code>, where <code>P</code> is an associated policy tag.
+See the reference for details
</p>
<p>
There are overloads which predate the above functions,
<code>ref_list_of<int>()</code> and <code>cref_list_of<int>()</code>, whose integer template parameter specifies the maximum number of arguments.
-The resulting collection builder exposes a similar interface to that above, save for the specifics of an array, and is not customizable via a policy.
+The resulting collection exposes a similar interface to that above, save for the specifics of an array, and is not customizable via a policy.
See the reference for details
</p>
<p>
-A variation on <code>ref_list_of()</code> and <code>cref_list_of()</code>, are <code>ref_rebind_list_of()</code> and <code>cref_rebind_list_of()</code>, respectively, that have rebind,
-rather than copy semantics, when the collection is used as the left hand side of an assignement. These are discouraged unless this specific feature is required. See the reference.
+A variation on <code>ref_list_of()</code> and <code>cref_list_of()</code>, are <code>ref_rebind_list_of()</code> and <code>cref_rebind_list_of()</code>, respectively,
+that have rebind, rather than copy semantics, when the collection is used as the left hand side of an assignement. These functions are less intuitive so their use is discouraged
+unless this specific feature is required. See the reference.
</p>
<h3>Functions <code>ref_csv()</code>, <code>cref_csv()</code> <a name="ref_csv"> and related functions</h3>
The functions ref_list_of(), cref_list_of(),
-their respective rebind analogs, and the overloads of these four whose policy is specified by a template parameter,
-have counterparts that are identified by suffix 'csv' (comma separated values) instead of 'list_of'. For example,
+their respective rebind analogs, and the custom policy overloads of these four, have counterparts that are identified by suffix 'csv' (comma separated values)
+instead of 'list_of'. For example,
<blockquote>
<pre>
<span class=preprocessor>#include </span><span class=special><</span><span class=identifier>boost</span><span class=special>/</span><span class=identifier>assign</span><span class=special>/</span><span class=identifier>auto_size</span><span class=special>/</span><span class=identifier>ref_csv</span><span class=special>.</span><span class=identifier>hpp</span><span class=special>></span>
@@ -788,9 +789,9 @@
into nested compile time expressions, the last of which is 'dressed' as needed with iterator and
conversion operations. This is in contrast to other parts of this library, where the argument is either
directly inserted into its destination container or stored in a runtime-fashion. The corresponding functions, however,
- such as ref_list_of() or ref_csv(),
- operate under the same principle as those in the rest of this library and are therefore also in <code>boost::assign</code>. The
- implementation is in <code>boost::assign::detail::auto_size</code>.
+ such as ref_list_of() or ref_csv(),
+ operate under the same principle as those in the rest of this library and are therefore in the same namespace, <code>boost::assign</code>.
+ The implementation is in <code>boost::assign::detail::auto_size</code>.
</p>
<h2>Reference for functions and operators <a name="ref-functions"> </h3>
@@ -1027,7 +1028,7 @@
</blockquote>
<p>
Usage for the related functions <code>ref_rebind_list_of()</code> and <code>cref_rebind_list_of()</code> are identical to those
-above, except <code>R=ref_rebind</code>.
+above, and their result type are modified by replacing <code>ref_copy</code> replaced by <code>ref_rebind</code>.
</p>
<p>
@@ -1272,7 +1273,7 @@
<blockquote>
<table cellpadding=5 border=1>
<tr><th class="head">Expression</th> <th class="head">Description</th>
- <tr><td><a href="#ref-converter"><tt>converter<></tt><a></td> <td>Public base class</td></tr>
+ <tr><td>converter<>
Public base class of generic_list<></td> </tr>
</table>
</blockquote>
@@ -1353,7 +1354,7 @@
<blockquote>
<table cellpadding=5 border=1>
<tr><th class="head">Expression</th> <th class="head">Description</th>
- <tr><td><a href="#ref-converter"><tt>converter<></tt><a></td><td> Public base class </td> </tr>
+ <tr><td>converter<> | Public base class of static_generic_list<></td> </tr>
</table>
</blockquote>
@@ -1473,31 +1474,32 @@
<tr><th class="head">Parameter</th> <th class="head">Description</th>
<tr><td><tt>T</tt></td><td> Element </td> </tr>
<tr><td><tt>N</tt></td><td> Size </td> </tr>
- <tr><td><tt>R</tt></td><td> Reference wrapper around an element </td> </tr>
+ <tr><td><tt>R</tt></td><td> A class template </td> </tr>
<tr><td><tt>D</tt></td><td> Derived </td> </tr>
</table>
</blockquote>
<p>
- <b>Requirements</b>
+ <b>Associated types</b>
</p>
- Let <tt>d1</tt> and <tt>d2</tt> instances of <tt>D</tt> and <tt>const D</tt>, respectively,
+
<blockquote>
<table cellpadding=5 border=1>
- <tr><th class="head">Expression</th> <th class="head">Result</th>
- <tr><td><tt>d1.ref_array_impl()</tt></td><td> array_interface::ref_array_& </td> </tr>
- <tr><td><tt>d2.ref_array_impl()</tt></td><td> const array_interface::ref_array_& </td> </tr>
+ <tr><th class="head">Expression</th> <th class="head">Description</th>
+ <tr><td><tt>R<T></tt></td><td> Reference wrapper </td> </tr>
+ <tr><td>converter<></td><td> Public base class of array_interface<></td> </tr>
</table>
</blockquote>
<p>
- <b>Associated types</b>
+ <b>Requirements</b>
</p>
-
+ Let <tt>d1</tt> and <tt>d2</tt> instances of <tt>D</tt> and <tt>const D</tt>, respectively,
<blockquote>
<table cellpadding=5 border=1>
- <tr><th class="head">Expression</th> <th class="head">Description</th>
- <tr><td><a href="#ref-converter"><tt>converter<></tt><a></td><td> Public base class </td> </tr>
+ <tr><th class="head">Expression</th> <th class="head">Result</th>
+ <tr><td><tt>d1.ref_array_impl()</tt></td><td> array_interface::ref_array_& </td> </tr>
+ <tr><td><tt>d2.ref_array_impl()</tt></td><td> const array_interface::ref_array_& </td> </tr>
</table>
</blockquote>
@@ -1517,7 +1519,7 @@
<tr><td><tt>E</tt></td><td> Previous collection </td> </tr>
<tr><td><tt>T</tt></td><td> Element </td> </tr>
<tr><td><tt>N</tt></td><td> Size </td> </tr>
- <tr><td><tt>R</tt></td><td> Reference wrapper around an element </td> </tr>
+ <tr><td><tt>R</tt></td><td> A class template </td> </tr>
<tr><td><tt>P</tt></td><td> Policy tag</td> </tr>
<tr><td><tt>F</tt></td><td> Use reference to link to the previous collection </td> </tr>
</table>
@@ -1530,7 +1532,8 @@
<blockquote>
<table cellpadding=5 border=1>
<tr><th class="head">Expression</th> <th class="head">Description</th>
- <tr><td><tt><code>policy<P>::apply<expr,R>::type</code></tt></td><td> Public base class </td> </tr>
+ <tr><td><tt>R<T></tt></td><td> Reference wrapper </td> </tr>
+ <tr><td><tt><code>policy<P>::apply<expr,R>::type</code></tt></td><td> Public base class of expr<> </td> </tr>
</table>
</blockquote>
@@ -1552,7 +1555,7 @@
class expr{
<span class="keyword">public:</span>
- <span class="keyword">typedef</span> Implementation defined result_type;
+ <span class="keyword">typedef</span> Implementation-defined result_type;
<span class="keyword">explicit</span> expr(<span class="keyword">const</span> E& p,T& t);
<span class="keyword">template</span><<span class="keyword">typename</span> E1,<span class="keyword">typename</span> P1,<span class="keyword">bool</span> F1>
<span class="keyword">explicit</span> expr(<span class="keyword">const</span> expr<E1,T,N,R,P1,F1>& that);
@@ -1560,23 +1563,23 @@
result_type <span class="keyword">operator</span>()(T& t)<span class="keyword">const</span>;
<span class="keyword">template</span><<span class="keyword">int</span> K,<span class="keyword">typename</span> I>
- Implementation defined
+ Implementation-defined
range(I b,I e)<span class="keyword">const</span>;
<span class="keyword">template</span><<span class="keyword">int</span> K,<span class="keyword">typename</span> Range>
- Implementation defined
+ Implementation-defined
range(Range& r)<span class="keyword">const</span>;
<span class="keyword">template</span><<span class="keyword">int</span> K,<span class="keyword">typename</span> Range>
- Implementation defined
+ Implementation-defined
range(<span class="keyword">const</span> Range& r)<span class="keyword">const</span>;
<span class="keyword">template</span><<span class="keyword">typename</span> Range>
- Implementation defined
+ Implementation-defined
range(Range& r);
<span class="keyword">template</span><<span class="keyword">typename</span> Range>
- Implementation defined
+ Implementation-defined
range(<span class="keyword">const</span> Range& r);
};
@@ -1602,7 +1605,7 @@
</p>
<p>
Naturally, this requires that the successive arguments be allocated on the stack. Consequently, this set up is
- ill-suited for the method <code>range()</code> whose argument size, must be specified explictly,
+ ill-suited for the method <code>range()</code> whose argument size must be specified explictly (unless its argument has static size),
unlike the remainder of this library. A fully auto-size framework could
be achieved, in the future, by having <code>auto_size::expr<></code> expose a member function
<code>concat()</code>, that returns a proxy object whose task is to aggregate collections,
@@ -1621,7 +1624,7 @@
<tr><th class="head">Parameter</th> <th class="head">Description</th>
<tr><td><tt>T</tt></td><td> Element </td> </tr>
<tr><td><tt>N</tt></td><td> Size </td> </tr>
- <tr><td><tt>R</tt></td><td> Reference wrapper around an element </td> </tr>
+ <tr><td><tt>R</tt></td><td> A class template</td> </tr>
<tr><td><tt>D</tt></td><td> Derived </td> </tr>
</table>
</blockquote>
@@ -1633,14 +1636,15 @@
<blockquote>
<table cellpadding=5 border=1>
<tr><th class="head">Expression</th> <th class="head">Description</th>
- <tr><td><a href="#ref-array_interface"><tt>array_interface<></tt><a></td><td> Public base class </td> </tr>
+ <tr><td><tt>R<T></tt></td><td> Reference wrapper </td> </tr>
+ <tr><td><a href="#ref-array_interface"><tt>array_interface<></tt><a></td><td> Public base class of <a href="#ref-lazy_array"><tt>lazy_array<></tt></td> </tr>
</table>
</blockquote>
<p>
<b>Requirements</b>
</p>
- Let <tt>d</tt> denote an instance of <tt>D</tt> and <tt>a</tt> an instance of <code>boost::array<T,N></code>,
+ Let <tt>d</tt> denote an instance of <tt>D</tt> and <tt>a</tt> an instance of <code>boost::array<R<T>,N></code>,
<blockquote>
<table cellpadding=5 border=1>
<tr><th class="head">Expression</th> <th class="head">Effect</th>
@@ -1667,7 +1671,7 @@
<tr><th class="head">Parameter</th> <th class="head">Description</th>
<tr><td><tt>T</tt></td><td> Element </td> </tr>
<tr><td><tt>N</tt></td><td> Size </td> </tr>
- <tr><td><tt>R</tt></td><td> Reference wrapper around an element </td> </tr>
+ <tr><td><tt>R</tt></td><td> A class template </td> </tr>
</table>
</blockquote>
@@ -1678,14 +1682,15 @@
<blockquote>
<table cellpadding=5 border=1>
<tr><th class="head">Expression</th> <th class="head">Description</th>
- <tr><td><a href="#ref-array_interface"><tt>array_interface<></tt><a></td><td> Public base class </td> </tr>
+ <tr><td><tt>R<T></tt></td><td> Reference wrapper </td> </tr>
+ <tr><td>array_interface<> | Public base class of static_array<></td> </tr>
</table>
</blockquote>
<p>
<b>Requirements</b>
</p>
- Let <tt>e</tt> denote the argument passed to the constructor, and a an instance of <code>boost::array<T,N></code>,
+ Let <tt>e</tt> denote the argument passed to the constructor, and a an instance of <code>boost::array<R<T>,N></code>,
<blockquote>
<table cellpadding=5 border=1>
<tr><th class="head">Expression</th> <th class="head">Effect</th>
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
|