Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r68366 - branches/release/libs/parameter/doc/html
From: marshall_at_[hidden]
Date: 2011-01-22 10:42:10

Author: marshall
Date: 2011-01-22 10:42:09 EST (Sat, 22 Jan 2011)
New Revision: 68366
URL: http://svn.boost.org/trac/boost/changeset/68366

Log:
Merge fix to release branch, fixes #4983
Properties modified:
   branches/release/libs/parameter/doc/html/index.html (contents, props changed)
Text files modified:
   branches/release/libs/parameter/doc/html/index.html | 123 ++++++++++++++++++++++-----------------
   1 files changed, 68 insertions(+), 55 deletions(-)

Modified: branches/release/libs/parameter/doc/html/index.html
==============================================================================
--- branches/release/libs/parameter/doc/html/index.html (original)
+++ branches/release/libs/parameter/doc/html/index.html 2011-01-22 10:42:09 EST (Sat, 22 Jan 2011)
@@ -78,14 +78,14 @@
<tbody valign="top">
<tr class="field"><th class="field-name">Authors:</th><td class="field-body">David Abrahams, Daniel Wallin</td>
</tr>
-<tr class="field"><th class="field-name">Contact:</th><td class="field-body"><a class="reference external" href="mailto:dave@boost-consulting.com">dave@boost-consulting.com</a>, <a class="reference external" href="mailto:dalwan01@student.umu.se">dalwan01@student.umu.se</a></td>
+<tr class="field"><th class="field-name">Contact:</th><td class="field-body"><a class="reference external" href="mailto:dave@boost-consulting.com">dave@boost-consulting.com</a>, <a class="reference external" href="mailto:daniel@boostpro.com">daniel@boostpro.com</a></td>
</tr>
-<tr class="field"><th class="field-name">Organization:</th><td class="field-body"><a class="reference external" href="http://www.boost-consulting.com">Boost Consulting</a></td>
+<tr class="field"><th class="field-name">organization:</th><td class="field-body"><a class="reference external" href="http://www.boostpro.com">BoostPro Computing</a></td>
</tr>
-<tr class="field"><th class="field-name">Date:</th><td class="field-body">$Date: 2005/07/18 20:34:31 $</td>
+<tr class="field"><th class="field-name">date:</th><td class="field-body">$Date: 2005/07/17 19:53:01 $</td>
</tr>
-<tr class="field"><th class="field-name">Copyright:</th><td class="field-body">Copyright David Abrahams, Daniel Wallin 2005.
-Distributed under the Boost Software License,
+<tr class="field"><th class="field-name">copyright:</th><td class="field-body">Copyright David Abrahams, Daniel Wallin
+2005-2009. Distributed under the Boost Software License,
Version 1.0. (See accompanying file LICENSE_1_0.txt
or copy at <a class="reference external" href="http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt>)</td>
</tr>
@@ -508,7 +508,7 @@
(required (graph, *) )
</pre>
Since <tt class="docutils literal">depth_first_search</tt> doesn't require any particular type
-for its <tt class="docutils literal">graph</tt> parameter, we use an asterix to indicate that
+for its <tt class="docutils literal">graph</tt> parameter, we use an asterisk to indicate that
any type is allowed. Required parameters must always precede any
optional parameters in a signature, but if there are no
required parameters, the <tt class="docutils literal">(required â€¦ )</tt> clause can be omitted
@@ -791,7 +791,7 @@
of metafunctions or of graph library details here, but we'll show
you the complete signature with maximal checking, just to give you
a feel for how it's done. Each predicate metafunction is enclosed
-in parentheses and preceded by an asterix, as follows:
+in parentheses and preceded by an asterisk, as follows:
<pre class="literal-block">
BOOST_PARAMETER_FUNCTION(
 (void), depth_first_search, graphs
@@ -1026,7 +1026,7 @@
struct callable2
{
 BOOST_PARAMETER_CONST_MEMBER_FUNCTION(
- (void), operator(), tag, (required (arg1,(int))(arg2,(int))))
+ (void), call, tag, (required (arg1,(int))(arg2,(int))))
 {
 std::cout << arg1 << ", " << arg2 << std::endl;
 }
@@ -1034,7 +1034,9 @@
</pre>

+#include <iostream>
+using namespace boost::parameter;
+''') -->

These macros don't directly allow a function's interface to be
separated from its implementation, but you can always forward
@@ -1043,7 +1045,7 @@
struct callable2
{
 BOOST_PARAMETER_CONST_MEMBER_FUNCTION(
- (void), operator(), tag, (required (arg1,(int))(arg2,(int))))
+ (void), call, tag, (required (arg1,(int))(arg2,(int))))
 {
 call_impl(arg1,arg2);
 }
@@ -1055,9 +1057,34 @@
#include <boost/parameter.hpp>

BOOST_PARAMETER_NAME(arg1)
-BOOST_PARAMETER_NAME(arg2)''') -->
+BOOST_PARAMETER_NAME(arg2)
+using namespace boost::parameter;
+''') -->
+
+<div class="section" id="static-member-functions">
+<h3>2.2.1   Static Member Functions</h3>
+To expose a static member function, simply insert the keyword
+â€œ<tt class="docutils literal">static</tt>â€ before the function name:
+<pre class="literal-block">
+BOOST_PARAMETER_NAME(arg1)
+
+struct somebody
+{
+ BOOST_PARAMETER_MEMBER_FUNCTION(
+ (void), static f, tag, (optional (arg1,(int),0)))
+ {
+ std::cout << arg1 << std::endl;
+ }
+};
+</pre>
+

</div>
+</div>
<div class="section" id="parameter-enabled-constructors">
<h2><a class="toc-backref" href="#id29">2.3   Parameter-Enabled Constructors</a></h2>
The lack of a â€œdelegating constructorâ€
@@ -1224,10 +1251,10 @@
using boost::mpl::_;

typedef parameter::parameters<
- required<tag::class_type, is_class<_> >
- , optional<tag::base_list, mpl::is_sequence<_> >
- , optional<tag::held_type>
- , optional<tag::copyable>
+ required<tag::class_type, boost::is_class<_> >
+ , parameter::optional<tag::base_list, mpl::is_sequence<_> >
+ , parameter::optional<tag::held_type>
+ , parameter::optional<tag::copyable>
> class_signature;

}}
@@ -1236,6 +1263,7 @@
#include <boost/parameter.hpp>
#include <boost/mpl/is_sequence.hpp>
#include <boost/noncopyable.hpp>
+#include <boost/type_traits/is_class.hpp>
#include <memory>

using namespace boost::parameter;
@@ -1255,11 +1283,13 @@
</div>
<div class="section" id="argument-packs-and-parameter-extraction">
<h4>2.4.1.4   Argument Packs and Parameter Extraction</h4>
-Next, within the body of <tt class="docutils literal">class_</tt> , we use the ParameterSpec's nested <tt class="docutils literal">::bind< â€¦ ></tt> template to bundle the actual arguments
-into an <a class="reference external" href="reference.html#argumentpack">ArgumentPack</a> type, and then use the library's <tt class="docutils literal">binding<
-â€¦ ></tt> metafunction to extract â€œlogical parametersâ€. Note that
-defaults are specified by supplying an optional third argument to
-<tt class="docutils literal">binding< â€¦ ></tt>:
+Next, within the body of <tt class="docutils literal">class_</tt> , we use the ParameterSpec's
+nested <tt class="docutils literal">::bind< â€¦ ></tt> template to bundle the actual arguments into an
+<a class="reference external" href="reference.html#argumentpack">ArgumentPack</a> type, and then use the library's <tt class="docutils literal">value_type< â€¦ ></tt>
+metafunction to extract â€œlogical parametersâ€. <tt class="docutils literal">value_type< â€¦ ></tt> is
+a lot like <tt class="docutils literal">binding< â€¦ ></tt>, but no reference is added to the actual
+argument type. Note that defaults are specified by passing it an
+optional third argument:
<pre class="literal-block">
namespace boost { namespace python {

@@ -1277,16 +1307,16 @@
 args;

 // Extract first logical parameter.
- typedef typename parameter::binding<
+ typedef typename parameter::value_type<
 args, tag::class_type>::type class_type;

- typedef typename parameter::binding<
+ typedef typename parameter::value_type<
 args, tag::base_list, bases<> >::type base_list;

- typedef typename parameter::binding<
+ typedef typename parameter::value_type<
 args, tag::held_type, class_type>::type held_type;

- typedef typename parameter::binding<
+ typedef typename parameter::value_type<
 args, tag::copyable, void>::type copyable;
};

@@ -1381,12 +1411,12 @@
typedef parameter::parameters<
 required<tag::class_type, is_class<_> >

- , optional<
+ , parameter::optional<
 deduced<tag::base_list>
 , is_base_and_derived<detail::bases_base,_>
 >

- , optional<
+ , parameter::optional<
 deduced<tag::held_type>
 , mpl::not_<
 mpl::or_<
@@ -1396,11 +1426,12 @@
 >
 >

- , optional<deduced<tag::copyable>, is_same<noncopyable,_> >
+ , parameter::optional<deduced<tag::copyable>, is_same<noncopyable,_> >

> class_signature;
</pre>


-Note that the <tt class="docutils literal">remove_reference< â€¦ ></tt> dance is necessary because
-<tt class="docutils literal">binding< â€¦ ></tt> will return a reference type when the argument
-is bound in the argument pack. If we don't strip the reference we
-end up returning a reference to the temporary created in the <tt class="docutils literal">2 * â€¦</tt>
-expression. A convenient shortcut would be to use the <tt class="docutils literal">value_type< â€¦ ></tt>
-metafunction:
-<pre class="literal-block">
-template <class ArgumentPack>
-typename parameter::value_type<ArgumentPack, tag::index, int>::type
-twice_index(ArgumentPack const& args)
-{
- return 2 * args[_index|42];
-}
-</pre>
-
-
+''') -->


+Note that if we had used <tt class="docutils literal">binding< â€¦ ></tt> rather than <tt class="docutils literal">value_type< â€¦
+></tt>, we would end up returning a reference to the temporary created in
+the <tt class="docutils literal">2 * â€¦</tt> expression.
</div>
<div class="section" id="lazy-default-computation">
<h3>3.2.3   Lazy Default Computation</h3>

Next message: john_at_[hidden]: "[Boost-commit] svn:boost r68367 - branches/release/boost/math/distributions/detail"
Previous message: barend.gehrels_at_[hidden]: "[Boost-commit] svn:boost r68365 - in trunk/libs/geometry/doc: . doxy/doxygen_input/groups doxy/doxygen_input/pages src src/docutils/tools/doxygen_xml2qbk"

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