mirror of
https://github.com/boostorg/parameter.git
synced 2026-01-24 18:12:31 +00:00
4f776ec9cb
Also move BOOST_PARAMETER_TEMPLATE_KEYWORD macro definition to <boost/parameter/template_keyword.hpp>, but #include this new header file in <boost/parameter/name.hpp> for backward compatibility.
4136 lines
166 KiB
HTML
4136 lines
166 KiB
HTML
<?xml version="1.0" encoding="utf-8" ?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<meta name="generator"
|
|
content="Docutils 0.7: http://docutils.sourceforge.net/" />
|
|
<title>The Boost Parameter Library Reference Documentation</title>
|
|
<meta name="authors" content="David Abrahams Daniel Wallin" />
|
|
<meta name="organization" content="BoostPro Computing" />
|
|
<meta name="date" content="2005-07-17" />
|
|
<meta name="copyright" content=
|
|
"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 http://www.boost.org/LICENSE_1_0.txt)"
|
|
/>
|
|
<link rel="stylesheet" href="rst.css" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div class="document"
|
|
id="the-boost-parameter-library-reference-documentation">
|
|
<h1 class="title">The Boost Parameter Library Reference Documentation</h1>
|
|
<table class="docinfo" frame="void" rules="none">
|
|
<col class="docinfo-name" />
|
|
<col class="docinfo-content" />
|
|
<tbody valign="top">
|
|
<tr>
|
|
<th class="docinfo-name">Authors:</th>
|
|
<td>David Abrahams<br />Daniel Wallin</td>
|
|
</tr>
|
|
<tr>
|
|
<th class="docinfo-name">Contact:</th>
|
|
<td><a class="first reference external"
|
|
href="mailto:dave@boost-consulting.com">dave@boost-consulting.com</a>,
|
|
<a class="last reference external" href="mailto:daniel@boostpro.com"
|
|
>daniel@boostpro.com</a></td>
|
|
</tr>
|
|
<tr><th class="docinfo-name">Organization:</th>
|
|
<td><a class="first last reference external"
|
|
href="http://www.boostpro.com">BoostPro Computing</a></td></tr>
|
|
<tr><th class="docinfo-name">Date:</th>
|
|
<td>2005-07-17</td></tr>
|
|
<tr><th class="docinfo-name">Copyright:</th>
|
|
<td>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</a>)</td></tr>
|
|
</tbody>
|
|
</table>
|
|
<p><a class="reference external" href="../../../../index.htm"><img alt="Boost"
|
|
src="../../../../boost.png" /></a></p>
|
|
<hr class="docutils" />
|
|
<div class="contents topic" id="contents">
|
|
<p class="topic-title first">Contents</p>
|
|
<ul class="auto-toc simple">
|
|
<li><a class="reference internal" href="#preliminaries" id="id30"
|
|
>1 Preliminaries</a>
|
|
<ul class="auto-toc">
|
|
<li><a class="reference internal" href="#namespaces" id="id31"
|
|
>1.1 Namespaces</a></li>
|
|
<li><a class="reference internal" href="#exceptions" id="id32"
|
|
>1.2 Exceptions</a></li>
|
|
<li><a class="reference internal" href="#thread-safety" id="id33"
|
|
>1.3 Thread Safety</a></li>
|
|
<li><a class="reference internal" href="#typography" id="id34"
|
|
>1.4 Typography</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a class="reference internal" href="#terminology" id="id35"
|
|
>2 Terminology</a></li>
|
|
<li><a class="reference internal" href="#concepts" id="id36"
|
|
>3 Concepts</a>
|
|
<ul class="auto-toc">
|
|
<li><a class="reference internal" href="#argumentpack" id="id37"
|
|
>3.1 <span class="concept">ArgumentPack</span></a></li>
|
|
<li><a class="reference internal" href="#id5" id="id38"
|
|
>3.2 <span class="concept">ParameterSpec</span></a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a class="reference internal" href="#class-templates" id="id39"
|
|
>4 Class Templates</a><ul class="auto-toc">
|
|
<li><a class="reference internal" href="#id7" id="id40"
|
|
>4.1 <tt class="docutils literal">keyword</tt></a></li>
|
|
<li><a class="reference internal" href="#template-keyword" id="id41"
|
|
>4.2 <tt class="docutils literal"
|
|
>template_keyword</tt></a></li>
|
|
<li><a class="reference internal" href="#parameters" id="id42"
|
|
>4.3 <tt class="docutils literal">parameters</tt></a></li>
|
|
<li><a class="reference internal" href="#optional-required" id="id43"
|
|
>4.4 <tt class="docutils literal">optional</tt>,
|
|
<tt class="docutils literal">required</tt></a></li>
|
|
<li><a class="reference internal" href="#deduced" id="id44"
|
|
>4.5 <tt class="docutils literal">deduced</tt></a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a class="reference internal" href="#metafunctions" id="id45"
|
|
>5 Metafunctions</a><ul class="auto-toc">
|
|
<li><a class="reference internal" href="#binding" id="id46"
|
|
>5.1 <tt class="docutils literal">binding</tt></a></li>
|
|
<li><a class="reference internal" href="#lazy-binding" id="id47"
|
|
>5.2 <tt class="docutils literal">lazy_binding</tt></a></li>
|
|
<li><a class="reference internal" href="#value-type" id="id48"
|
|
>5.3 <tt class="docutils literal">value_type</tt></a></li>
|
|
<li><a class="reference internal" href="#value-type" id="id49"
|
|
>5.4 <tt class="docutils literal"
|
|
>is_argument_pack</tt></a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a class="reference internal" href="#code-generation-macros" id="id50"
|
|
>6 Code Generation Macros</a><ul class="auto-toc">
|
|
<li><a class="reference internal"
|
|
href="#boost-parameter-function-result-name-tag-namespace-arguments"
|
|
id="id51">6.1 <tt class="docutils literal"
|
|
>BOOST_PARAMETER_FUNCTION(result, name, tag_namespace,
|
|
arguments)</tt></a></li>
|
|
<li><a class="reference internal"
|
|
href="#boost-parameter-member-function-result-name-tag-namespace-arguments"
|
|
id="id52">6.2 <tt class="docutils literal"
|
|
>BOOST_PARAMETER_MEMBER_FUNCTION(result, name, tag_namespace,
|
|
arguments)</tt></a></li>
|
|
<li><a class="reference internal"
|
|
href="#boost-parameter-c-mem-function-result-name-tag-namespace-arguments"
|
|
id="id53">6.3 <tt class="docutils literal"
|
|
>BOOST_PARAMETER_CONST_MEMBER_FUNCTION(result, name, tag_namespace,
|
|
arguments)</tt></a></li>
|
|
<li><a class="reference internal"
|
|
href="#boost-parameter-function-call-op-result-tag-namespace-arguments"
|
|
id="id54">6.4 <tt class="docutils literal"
|
|
>BOOST_PARAMETER_FUNCTION_CALL_OPERATOR(result, tag_namespace,
|
|
arguments)</tt></a></li>
|
|
<li><a class="reference internal"
|
|
href="#boost-parameter-const-function-call-op-result-tag-namespace-arguments"
|
|
id="id55">6.5 <tt class="docutils literal"
|
|
>BOOST_PARAMETER_CONST_FUNCTION_CALL_OPERATOR(result, tag_namespace,
|
|
arguments)</tt></a></li>
|
|
<li><a class="reference internal"
|
|
href="#boost-parameter-constructor-cls-impl-tag-namespace-arguments"
|
|
id="id56">6.6 <tt class="docutils literal"
|
|
>BOOST_PARAMETER_CONSTRUCTOR(cls, impl, tag_namespace,
|
|
arguments)</tt></a></li>
|
|
<li><a class="reference internal"
|
|
href="#boost-parameter-basic-function-result-name-tag-namespace-arguments"
|
|
id="id57">6.7 <tt class="docutils literal"
|
|
>BOOST_PARAMETER_BASIC_FUNCTION(result, name, tag_namespace,
|
|
arguments)</tt></a></li>
|
|
<li><a class="reference internal"
|
|
href="#boost-parameter-basic-member-function-result-name-tag-ns-arguments"
|
|
id="id58">6.8 <tt class="docutils literal"
|
|
>BOOST_PARAMETER_BASIC_MEMBER_FUNCTION(result, name, tag_namespace,
|
|
arguments)</tt></a></li>
|
|
<li><a class="reference internal"
|
|
href="#boost-parameter-basic-c-mem-function-result-name-tag-ns-arguments"
|
|
id="id59">6.9 <tt class="docutils literal"
|
|
>BOOST_PARAMETER_BASIC_CONST_MEMBER_FUNCTION(result, name, tag_namespace,
|
|
arguments)</tt></a></li>
|
|
<li><a class="reference internal" href="#boost-parameter-name-name"
|
|
id="id60">6.10 <tt class="docutils literal"
|
|
>BOOST_PARAMETER_NAME(name)</tt></a></li>
|
|
<li><a class="reference internal" href="#boost-parameter-nested-keyword-t-n-a"
|
|
id="id61">6.11 <tt class="docutils literal"
|
|
>BOOST_PARAMETER_NESTED_KEYWORD(tag_namespace, name, alias)</tt></a></li>
|
|
<li><a class="reference internal"
|
|
href="#boost-parameter-template-keyword-name"
|
|
id="id62">6.12 <tt class="docutils literal"
|
|
>BOOST_PARAMETER_TEMPLATE_KEYWORD(name)</tt></a></li>
|
|
<li><a class="reference internal" href="#boost-parameter-fun-r-n-l-h-p"
|
|
id="id63">6.13 <tt class="docutils literal"
|
|
>BOOST_PARAMETER_FUN(r,n,l,h,p)</tt></a></li>
|
|
<li><a class="reference internal" href="#boost-parameter-keyword-n-k"
|
|
id="id64">6.14 <tt class="docutils literal"
|
|
>BOOST_PARAMETER_KEYWORD(n,k)</tt></a></li>
|
|
<li><a class="reference internal" href="#boost-parameter-match-p-a-x"
|
|
id="id65">6.15 <tt class="docutils literal"
|
|
>BOOST_PARAMETER_MATCH(p,a,x)</tt></a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a class="reference internal" href="#configuration-macros"
|
|
id="id66">7 Configuration Macros</a>
|
|
<ul class="auto-toc">
|
|
<li><a class="reference internal"
|
|
href="#boost-parameter-has-perfect-forwarding"
|
|
id="id67">7.1 <tt class="docutils literal"
|
|
>BOOST_PARAMETER_HAS_PERFECT_FORWARDING</tt></a></li>
|
|
<li><a class="reference internal"
|
|
href="#boost-parameter-disable-perfect-forwarding"
|
|
id="id68">7.2 <tt class="docutils literal"
|
|
>BOOST_PARAMETER_DISABLE_PERFECT_FORWARDING</tt></a></li>
|
|
<li><a class="reference internal"
|
|
href="#boost-parameter-variadic-mpl-sequence"
|
|
id="id69">7.3 <tt class="docutils literal"
|
|
>BOOST_PARAMETER_VARIADIC_MPL_SEQUENCE</tt></a></li>
|
|
<li><a class="reference internal" href="#boost-parameter-has-arity"
|
|
id="id70">7.4 <tt class="docutils literal"
|
|
>BOOST_PARAMETER_MAX_ARITY</tt></a></li>
|
|
<li><a class="reference internal"
|
|
href="#boost-parameter-exponential-overload-threshold-arity"
|
|
id="id71">7.5 <tt class="docutils literal"
|
|
>BOOST_PARAMETER_EXPONENTIAL_OVERLOAD_THRESHOLD_ARITY</tt></a></li>
|
|
<li><a class="reference internal" href="#outside-of-this-library"
|
|
id="id72">7.6 ...Outside Of This Library</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a class="reference internal" href="#tutorial"
|
|
id="id73">8 Tutorial</a></li>
|
|
</ul>
|
|
</div>
|
|
<hr class="docutils" />
|
|
<div class="section" id="preliminaries">
|
|
<h1><a class="toc-backref"
|
|
href="#id30">1 Preliminaries</a></h1>
|
|
<p>This section covers some basic information you'll need to know in order to
|
|
understand this reference</p>
|
|
<div class="section" id="namespaces">
|
|
<h2><a class="toc-backref"
|
|
href="#id31">1.1 Namespaces</a></h2>
|
|
<p>In this document, all unqualified identifiers should be assumed to be
|
|
defined in namespace
|
|
<tt class="docutils literal"><span class="pre">boost::parameter</span></tt>
|
|
unless otherwise specified.</p>
|
|
</div>
|
|
<div class="section" id="exceptions">
|
|
<h2><a class="toc-backref"
|
|
href="#id32">1.2 Exceptions</a></h2>
|
|
<p>No operation described in this document throws an exception unless
|
|
otherwise specified.</p>
|
|
</div>
|
|
<div class="section" id="thread-safety">
|
|
<h2><a class="toc-backref"
|
|
href="#id33">1.3 Thread Safety</a></h2>
|
|
<p>All components of this library can be used safely from multiple
|
|
threads without synchronization.<a class="footnote-reference" href="#thread"
|
|
id="id2"><sup>1</sup></a></p>
|
|
</div>
|
|
<div class="section" id="typography">
|
|
<h2><a class="toc-backref"
|
|
href="#id34">1.4 Typography</a></h2>
|
|
<p>Names written in <span class="concept">sans serif type</span> represent
|
|
<a class="reference external"
|
|
href="http://www.boost.org/more/generic_programming.html#concept"
|
|
>concepts</a>.</p>
|
|
<p>In code blocks, <em>italic type</em> represents unspecified text that
|
|
satisfies the requirements given in the detailed description that follows the
|
|
code block.</p>
|
|
<p>In a specification of the tokens generated by a macro, <strong>bold
|
|
type</strong> is used to highlight the position of the expanded macro
|
|
argument in the result.</p>
|
|
<p>The special character β represents the value of
|
|
<a class="reference internal" href="#boost-parameter-max-arity"><tt
|
|
class="docutils literal">BOOST_PARAMETER_MAX_ARITY</tt></a>.</p>
|
|
</div>
|
|
</div>
|
|
<hr class="docutils" />
|
|
<div class="section" id="terminology">
|
|
<h1><a class="toc-backref"
|
|
href="#id35">2 Terminology</a></h1>
|
|
<dl class="docutils" id="kw">
|
|
<dt>keyword</dt>
|
|
<dd>The name of a function parameter.</dd>
|
|
</dl>
|
|
<span class="target" id="keyword-tag-type"></span><dl class="docutils">
|
|
<dt>keyword tag type</dt>
|
|
<dd>A type used to uniquely identify a function parameter. Typically its name
|
|
will be the same as that of the parameter.</dd>
|
|
</dl>
|
|
<span class="target" id="positional"></span><dl class="docutils">
|
|
<dt>positional argument</dt>
|
|
<dd>An argument passed with no explicit keyword. Its parameter is determined
|
|
in the usual C++ way: by position with respect to a parameter list.</dd>
|
|
</dl>
|
|
<span class="target" id="tag-type"></span><dl class="docutils">
|
|
<dt>tag type</dt>
|
|
<dd>Shorthand for “<a class="reference internal"
|
|
href="#keyword-tag-type">keyword tag type</a>.”</dd>
|
|
</dl>
|
|
<span class="target" id="keyword-object"></span><dl class="docutils">
|
|
<dt>keyword object</dt>
|
|
<dd>An instance of <a class="reference internal" href="#keyword"><tt
|
|
class="docutils literal">keyword</tt></a>
|
|
<tt class="docutils literal"><T></tt> for some
|
|
<a class="reference internal" href="#tag-type">tag type</a>
|
|
<tt class="docutils literal">T</tt>.</dd>
|
|
</dl>
|
|
<span class="target" id="tagged-reference"></span><dl class="docutils">
|
|
<dt>tagged reference</dt>
|
|
<dd><p class="first">An object whose type is associated with a
|
|
<a class="reference internal" href="#keyword-tag-type">keyword tag type</a>
|
|
(the object's <em>keyword</em>), and that holds a reference (to the object's
|
|
<em>value</em>).</p>
|
|
<p class="last">As a shorthand, a “tagged reference to
|
|
<tt class="docutils literal">x</tt>” means a tagged reference whose
|
|
<em>value</em> is <tt class="docutils literal">x</tt>.</p>
|
|
</dd>
|
|
</dl>
|
|
<span class="target" id="tagged-default"></span><dl class="docutils">
|
|
<dt>tagged default</dt>
|
|
<dd>A <a class="reference internal" href="#tagged-reference">tagged
|
|
reference</a> whose <em>value</em> represents the value of a default
|
|
argument.</dd>
|
|
</dl>
|
|
<span class="target" id="tagged-lazy-default"></span><dl class="docutils">
|
|
<dt>tagged lazy default</dt>
|
|
<dd>A <a class="reference internal" href="#tagged-reference">tagged
|
|
reference</a> whose <em>value</em>, when invoked with no arguments, computes
|
|
a default argument value.</dd>
|
|
</dl>
|
|
<span class="target" id="intended-argument-type"></span><dl class="docutils">
|
|
<dt>intended argument type</dt>
|
|
<dd>The <em>intended argument type</em> of a single-element
|
|
<a class="reference internal" href="#argumentpack"><span class="concept"
|
|
>ArgumentPack</span></a> is the type of its element's <em>value</em>. The
|
|
intended argument type of any other type <tt class="docutils literal">X</tt>
|
|
is <tt class="docutils literal">X</tt> itself.</dd>
|
|
</dl>
|
|
<div class="note">
|
|
<p class="first admonition-title">Note</p>
|
|
<p class="last">In this reference, we will use concept names (and other names)
|
|
to describe both types and objects, depending on context. So for example, “an
|
|
<a class="reference internal" href="#argumentpack"><span class="concept"
|
|
>ArgumentPack</span></a>” can refer to a type that models
|
|
<a class="reference internal" href="#argumentpack"><span class="concept"
|
|
>ArgumentPack</span></a> <em>or</em> an object of such a type.</p>
|
|
</div>
|
|
</div>
|
|
<hr class="docutils" />
|
|
<div class="section" id="concepts">
|
|
<h1><a class="toc-backref" href="#id36">3 Concepts</a></h1>
|
|
<p>This section describes the generic type concepts used by the Parameter
|
|
library.</p>
|
|
<div class="section" id="argumentpack">
|
|
<h2><a class="toc-backref" href="#id37">3.1 <span
|
|
class="concept">ArgumentPack</span></a></h2>
|
|
<p>An <span class="concept">ArgumentPack</span> is a collection of
|
|
<a class="reference internal" href="#tagged-reference">tagged reference</a>s
|
|
to the actual arguments passed to a function. Every <span class="concept"
|
|
>ArgumentPack</span> is also a valid <a class="reference external"
|
|
href="../../../mpl/doc/refmanual/forward-sequence.html"><span class="concept"
|
|
>MPL Forward Sequence</span></a> and <a class="reference external"
|
|
href="../../../mpl/doc/refmanual/associative-sequence.html"><span
|
|
class="concept">MPL Associative Sequence</span></a> consisting of the <a
|
|
class="reference internal" href="#keyword-tag-type">keyword tag type</a>s in
|
|
its <a class="reference internal" href="#tagged-reference">tagged
|
|
reference</a>s.</p>
|
|
<div class="section" id="requirements">
|
|
<h3>Requirements</h3>
|
|
<p>In the table below,</p>
|
|
<ul class="simple">
|
|
<li><tt class="docutils literal">A</tt> is a model of
|
|
<span class="concept">ArgumentPack</span></li>
|
|
<li><tt class="docutils literal">x</tt> is an instance of
|
|
<tt class="docutils literal">A</tt></li>
|
|
<li><tt class="docutils literal">u</tt> is a
|
|
<a class="reference internal" href="#keyword-object">keyword object</a> of
|
|
type <tt class="docutils literal">K</tt></li>
|
|
<li><tt class="docutils literal">v</tt> is a
|
|
<a class="reference internal" href="#tagged-default">tagged default</a> with
|
|
<a class="reference internal" href="#tag-type">tag type</a>
|
|
<tt class="docutils literal">L</tt> and <em>value</em> of type
|
|
<tt class="docutils literal">D</tt></li>
|
|
<li><tt class="docutils literal">w</tt> is a
|
|
<a class="reference internal" href="#tagged-lazy-default">tagged lazy
|
|
default</a> with <a class="reference internal" href="#tag-type">tag type</a>
|
|
<tt class="docutils literal">M</tt> and <em>value</em> of type
|
|
<tt class="docutils literal">E const</tt></li>
|
|
<li><tt class="docutils literal">z</tt> is an <span class="concept"
|
|
>ArgumentPack</span> containing a single element (as created by <a
|
|
class="reference internal" href="#keyword"><tt class="docutils literal"
|
|
>keyword</tt></a><tt class="docutils literal"><span class="pre"
|
|
><…>::operator=</span></tt>)</li>
|
|
</ul>
|
|
<p>Any exceptions are thrown from the invocation of
|
|
<tt class="docutils literal">w</tt>'s <em>value</em>
|
|
will be propagated to the caller.</p>
|
|
<table border="1" class="docutils">
|
|
<caption><span class="concept">ArgumentPack</span> requirements</caption>
|
|
<colgroup>
|
|
<col width="11%" />
|
|
<col width="31%" />
|
|
<col width="19%" />
|
|
<col width="40%" />
|
|
</colgroup>
|
|
<thead valign="bottom">
|
|
<tr>
|
|
<th class="head">Expression</th>
|
|
<th class="head">Type</th>
|
|
<th class="head">Requirements</th>
|
|
<th class="head">Semantics/Notes</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody valign="top">
|
|
<tr>
|
|
<td><tt class="docutils literal">x[u]</tt></td>
|
|
<td><tt class="docutils literal"><span
|
|
class="pre">binding<A,K>::type</span></tt></td>
|
|
<td><tt class="docutils literal">x</tt> contains an element <em>b</em> whose
|
|
<a class="reference internal" href="#kw">keyword</a> is
|
|
<tt class="docutils literal">K</tt></td>
|
|
<td>Returns <em>b</em>'s <em>value</em> (by reference).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><tt class="docutils literal">x[u]</tt></td>
|
|
<td><tt class="docutils literal"><span
|
|
class="pre">binding<A,L,D>::type</span></tt></td>
|
|
<td><em>none</em></td>
|
|
<td>If <tt class="docutils literal">x</tt> contains an element <em>b</em>
|
|
whose <a class="reference internal" href="#kw">keyword</a> is the same as
|
|
<tt class="docutils literal">u</tt>'s, returns <em>b</em>'s <em>value</em> (by
|
|
reference). Otherwise, returns <tt class="docutils literal">u</tt>'s
|
|
<em>value</em>.</td>
|
|
</tr>
|
|
<tr><td><tt class="docutils literal">x[w]</tt></td>
|
|
<td><tt class="docutils literal"><span
|
|
class="pre">lazy_binding<A,M,E>::type</span></tt></td>
|
|
<td><em>none</em></td>
|
|
<td>If <tt class="docutils literal">x</tt> contains an element <em>b</em>
|
|
whose <a class="reference internal" href="#kw">keyword</a> is the same as
|
|
<tt class="docutils literal">w</tt>'s, returns <em>b</em>'s <em>value</em> (by
|
|
reference). Otherwise, invokes <tt class="docutils literal">w</tt>'s
|
|
<em>value</em> and returns the result.</td>
|
|
</tr>
|
|
<tr><td><tt class="docutils literal">x, z</tt></td>
|
|
<td>Model of <span class="concept">ArgumentPack</span></td>
|
|
<td><em>none</em></td>
|
|
<td>Returns an <a class="reference internal" href="#argumentpack"><span
|
|
class="concept">ArgumentPack</span></a> containing all the elements of both
|
|
<tt class="docutils literal">x</tt> and
|
|
<tt class="docutils literal">z</tt>.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="id5">
|
|
<span id="parameterspec"></span><h2><a class="toc-backref" href="#id38"
|
|
>3.2 <span class="concept">ParameterSpec</span></a></h2>
|
|
<p>A <span class="concept">ParameterSpec</span> describes the type
|
|
requirements for arguments corresponding to a given
|
|
<a class="reference internal" href="#kw">keyword</a> and indicates whether the
|
|
argument is optional or required. The table below details the allowed forms
|
|
and describes their condition for satisfaction by an actual argument type. In
|
|
each row,</p>
|
|
<ul class="simple" id="conditions">
|
|
<li><tt class="docutils literal">K</tt> is the <span class="concept"
|
|
>ParameterSpec</span>'s <a class="reference internal" href="#keyword-tag-type"
|
|
>keyword tag type</a></li>
|
|
<li><tt class="docutils literal">A</tt> is an <a class="reference internal"
|
|
href="#intended-argument-type">intended argument type</a> associated with
|
|
<tt class="docutils literal">K</tt>, if any</li>
|
|
<li><tt class="docutils literal">P</tt> is a model of
|
|
<a class="reference internal" href="#argumentpack"><span
|
|
class="concept">ArgumentPack</span></a> that contains
|
|
<tt class="docutils literal">A</tt></li>
|
|
<li><tt class="docutils literal">F</tt> is an <a class="reference external"
|
|
href="../../../mpl/doc/refmanual/metafunction-class.html">MPL Binary
|
|
Metafunction Class</a></li>
|
|
</ul>
|
|
<table border="1" class="docutils">
|
|
<caption><span class="concept">ParameterSpec</span> allowed forms and
|
|
conditions of satisfaction</caption>
|
|
<colgroup>
|
|
<col width="32%" />
|
|
<col width="21%" />
|
|
<col width="47%" />
|
|
</colgroup>
|
|
<thead valign="bottom">
|
|
<tr>
|
|
<th class="head">Type</th>
|
|
<th class="head"><tt class="docutils literal">A</tt> required</th>
|
|
<th class="head">Condition <tt class="docutils literal">A</tt> must
|
|
satisfy</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody valign="top">
|
|
<tr>
|
|
<td><tt class="docutils literal">K</tt></td>
|
|
<td>no</td>
|
|
<td><em>n/a</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="reference internal" href="#optional"><tt
|
|
class="docutils literal">optional</tt></a><tt
|
|
class="docutils literal"><K,F></tt></td>
|
|
<td>no</td>
|
|
<td><tt class="docutils literal"><span
|
|
class="pre">mpl::apply2<F,A,P>::type::value</span></tt>
|
|
is <tt class="docutils literal">true</tt>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="reference internal" href="#required"><tt
|
|
class="docutils literal">required</tt></a><tt
|
|
class="docutils literal"><K,F></tt></td>
|
|
<td>yes</td>
|
|
<td><tt class="docutils literal"><span
|
|
class="pre">mpl::apply2<F,A,P>::type::value</span></tt>
|
|
is <tt class="docutils literal">true</tt>.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>The information in a <span class="concept">ParameterSpec</span> is used to
|
|
<a class="reference external"
|
|
href="index.html#controlling-overload-resolution">limit</a> the arguments that
|
|
will be matched by <a class="reference external"
|
|
href="index.html#forwarding-functions">forwarding functions</a>.</p>
|
|
</div>
|
|
</div>
|
|
<hr class="docutils" />
|
|
<div class="section" id="class-templates">
|
|
<h1><a class="toc-backref" href="#id39">4 Class
|
|
Templates</a></h1>
|
|
<div class="section" id="id7">
|
|
<span id="keyword"></span><h2><a class="toc-backref" href="#id40"
|
|
>4.1 <tt class="docutils literal">keyword</tt></a></h2>
|
|
<p>The type of every <a class="reference internal" href="#keyword-object"
|
|
>keyword object</a> is a specialization of <tt class="docutils literal"
|
|
>keyword</tt>.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Defined in:</th><td class="field-body"><a
|
|
class="reference external" href="../../../../boost/parameter/keyword.hpp"
|
|
>boost/parameter/keyword.hpp</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>If</strong> <a class="reference internal"
|
|
href="#boost-parameter-has-perfect-forwarding"><tt class="docutils literal"
|
|
>BOOST_PARAMETER_HAS_PERFECT_FORWARDING</tt></a> is
|
|
<tt class="docutils literal">#defined</tt>, <strong>then</strong>:</p>
|
|
<pre class="literal-block">
|
|
template <typename Tag>
|
|
struct keyword
|
|
{
|
|
typedef Tag tag;
|
|
|
|
template <typename T>
|
|
typename boost::<a class="reference external"
|
|
href="../../../core/doc/html/core/enable_if.html"><tt
|
|
class="docutils literal">enable_if</tt></a><
|
|
typename boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/eval-if.html"><tt
|
|
class="docutils literal">eval_if</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_scalar.html"><tt
|
|
class="docutils literal">is_scalar</tt></a><T>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">true_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/eval-if.html"><tt
|
|
class="docutils literal">eval_if</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_same.html"><tt
|
|
class="docutils literal">is_same</tt></a><
|
|
typename Tag::qualifier
|
|
, boost::parameter::in_reference
|
|
>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">true_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/if.html"><tt
|
|
class="docutils literal">if_</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_same.html"><tt
|
|
class="docutils literal">is_same</tt></a><
|
|
typename Tag::qualifier
|
|
, boost::parameter::forward_reference
|
|
>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">true_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">false_</tt></a>
|
|
>
|
|
>
|
|
>::type
|
|
, <a class="reference internal" href="#argumentpack"><span
|
|
class="concept">ArgumentPack</span></a>
|
|
>::type constexpr
|
|
<a class="reference internal"
|
|
href="#operator">operator=</a>(T const& value) const;
|
|
|
|
template <typename T>
|
|
typename boost::<a class="reference external"
|
|
href="../../../core/doc/html/core/enable_if.html"><tt
|
|
class="docutils literal">enable_if</tt></a><
|
|
typename boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/eval-if.html"><tt
|
|
class="docutils literal">eval_if</tt></a><
|
|
typename boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/eval-if.html"><tt
|
|
class="docutils literal">eval_if</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_same.html"><tt
|
|
class="docutils literal">is_same</tt></a><
|
|
typename Tag::qualifier
|
|
, boost::parameter::out_reference
|
|
>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">true_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/if.html"><tt
|
|
class="docutils literal">if_</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_same.html"><tt
|
|
class="docutils literal">is_same</tt></a><
|
|
typename Tag::qualifier
|
|
, boost::parameter::forward_reference
|
|
>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">true_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">false_</tt></a>
|
|
>
|
|
>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/if.html"><tt
|
|
class="docutils literal">if_</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_const.html"><tt
|
|
class="docutils literal">is_const</tt></a><T>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">false_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">true_</tt></a>
|
|
>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">false_</tt></a>
|
|
>::type
|
|
, <a class="reference internal" href="#argumentpack"><span
|
|
class="concept">ArgumentPack</span></a>
|
|
>::type constexpr
|
|
<a class="reference internal"
|
|
href="#operator">operator=</a>(T& value) const;
|
|
|
|
template <typename T>
|
|
typename boost::<a class="reference external"
|
|
href="../../../core/doc/html/core/enable_if.html"><tt
|
|
class="docutils literal">enable_if</tt></a><
|
|
typename boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/eval-if.html"><tt
|
|
class="docutils literal">eval_if</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_scalar.html"><tt
|
|
class="docutils literal">is_scalar</tt></a><T>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">false_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/eval-if.html"><tt
|
|
class="docutils literal">eval_if</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_same.html"><tt
|
|
class="docutils literal">is_same</tt></a><
|
|
typename Tag::qualifier
|
|
, boost::parameter::in_reference
|
|
>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">true_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/if.html"><tt
|
|
class="docutils literal">if_</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_same.html"><tt
|
|
class="docutils literal">is_same</tt></a><
|
|
typename Tag::qualifier
|
|
, boost::parameter::forward_reference
|
|
>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">true_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">false_</tt></a>
|
|
>
|
|
>
|
|
>::type
|
|
, <a class="reference internal" href="#argumentpack"><span
|
|
class="concept">ArgumentPack</span></a>
|
|
>::type constexpr
|
|
<a class="reference internal"
|
|
href="#operator">operator=</a>(T const&& value) const;
|
|
|
|
template <typename T>
|
|
typename boost::<a class="reference external"
|
|
href="../../../core/doc/html/core/enable_if.html"><tt
|
|
class="docutils literal">enable_if</tt></a><
|
|
typename boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/eval-if.html"><tt
|
|
class="docutils literal">eval_if</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_scalar.html"><tt
|
|
class="docutils literal">is_scalar</tt></a><T>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">false_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/eval-if.html"><tt
|
|
class="docutils literal">eval_if</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_same.html"><tt
|
|
class="docutils literal">is_same</tt></a><
|
|
typename Tag::qualifier
|
|
, boost::parameter::consume_reference
|
|
>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">true_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/if.html"><tt
|
|
class="docutils literal">if_</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_same.html"><tt
|
|
class="docutils literal">is_same</tt></a><
|
|
typename Tag::qualifier
|
|
, boost::parameter::forward_reference
|
|
>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">true_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">false_</tt></a>
|
|
>
|
|
>
|
|
>::type
|
|
, <a class="reference internal" href="#argumentpack"><span
|
|
class="concept">ArgumentPack</span></a>
|
|
>::type constexpr
|
|
<a class="reference internal"
|
|
href="#operator">operator=</a>(T&& value) const;
|
|
|
|
template <typename T>
|
|
typename boost::<a class="reference external"
|
|
href="../../../core/doc/html/core/enable_if.html"><tt
|
|
class="docutils literal">enable_if</tt></a><
|
|
typename boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/eval-if.html"><tt
|
|
class="docutils literal">eval_if</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_scalar.html"><tt
|
|
class="docutils literal">is_scalar</tt></a><T>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">true_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/eval-if.html"><tt
|
|
class="docutils literal">eval_if</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_same.html"><tt
|
|
class="docutils literal">is_same</tt></a><
|
|
typename Tag::qualifier
|
|
, boost::parameter::in_reference
|
|
>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">true_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/if.html"><tt
|
|
class="docutils literal">if_</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_same.html"><tt
|
|
class="docutils literal">is_same</tt></a><
|
|
typename Tag::qualifier
|
|
, boost::parameter::forward_reference
|
|
>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">true_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">false_</tt></a>
|
|
>
|
|
>
|
|
>::type
|
|
, <em>tagged default</em>
|
|
>::type constexpr
|
|
<a class="reference internal"
|
|
href="#id9">operator|</a>(T const& x) const;
|
|
|
|
template <typename T>
|
|
typename boost::<a class="reference external"
|
|
href="../../../core/doc/html/core/enable_if.html"><tt
|
|
class="docutils literal">enable_if</tt></a><
|
|
typename boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/eval-if.html"><tt
|
|
class="docutils literal">eval_if</tt></a><
|
|
typename boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/eval-if.html"><tt
|
|
class="docutils literal">eval_if</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_same.html"><tt
|
|
class="docutils literal">is_same</tt></a><
|
|
typename Tag::qualifier
|
|
, boost::parameter::out_reference
|
|
>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">true_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/if.html"><tt
|
|
class="docutils literal">if_</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_same.html"><tt
|
|
class="docutils literal">is_same</tt></a><
|
|
typename Tag::qualifier
|
|
, boost::parameter::forward_reference
|
|
>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">true_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">false_</tt></a>
|
|
>
|
|
>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/if.html"><tt
|
|
class="docutils literal">if_</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_const.html"><tt
|
|
class="docutils literal">is_const</tt></a><T>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">false_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">true_</tt></a>
|
|
>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">false_</tt></a>
|
|
>::type
|
|
, <em>tagged default</em>
|
|
>::type constexpr
|
|
<a class="reference internal"
|
|
href="#id9">operator|</a>(T& x) const;
|
|
|
|
template <typename T>
|
|
typename boost::<a class="reference external"
|
|
href="../../../core/doc/html/core/enable_if.html"><tt
|
|
class="docutils literal">enable_if</tt></a><
|
|
typename boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/eval-if.html"><tt
|
|
class="docutils literal">eval_if</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_scalar.html"><tt
|
|
class="docutils literal">is_scalar</tt></a><T>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">false_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/eval-if.html"><tt
|
|
class="docutils literal">eval_if</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_same.html"><tt
|
|
class="docutils literal">is_same</tt></a><
|
|
typename Tag::qualifier
|
|
, boost::parameter::in_reference
|
|
>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">true_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/if.html"><tt
|
|
class="docutils literal">if_</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_same.html"><tt
|
|
class="docutils literal">is_same</tt></a><
|
|
typename Tag::qualifier
|
|
, boost::parameter::forward_reference
|
|
>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">true_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">false_</tt></a>
|
|
>
|
|
>
|
|
>::type
|
|
, <em>tagged default</em>
|
|
>::type constexpr
|
|
<a class="reference internal"
|
|
href="#id9">operator|</a>(T const&& x) const;
|
|
|
|
template <typename T>
|
|
typename boost::<a class="reference external"
|
|
href="../../../core/doc/html/core/enable_if.html"><tt
|
|
class="docutils literal">enable_if</tt></a><
|
|
typename boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/eval-if.html"><tt
|
|
class="docutils literal">eval_if</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_scalar.html"><tt
|
|
class="docutils literal">is_scalar</tt></a><T>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">false_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/eval-if.html"><tt
|
|
class="docutils literal">eval_if</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_same.html"><tt
|
|
class="docutils literal">is_same</tt></a><
|
|
typename Tag::qualifier
|
|
, boost::parameter::consume_reference
|
|
>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">true_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/if.html"><tt
|
|
class="docutils literal">if_</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_same.html"><tt
|
|
class="docutils literal">is_same</tt></a><
|
|
typename Tag::qualifier
|
|
, boost::parameter::forward_reference
|
|
>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">true_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">false_</tt></a>
|
|
>
|
|
>
|
|
>::type
|
|
, <em>tagged default</em>
|
|
>::type constexpr
|
|
<a class="reference internal"
|
|
href="#id9">operator|</a>(T&& x) const;
|
|
|
|
template <typename F>
|
|
<em>tagged lazy default</em> <a class="reference internal"
|
|
href="#id10">operator||</a>(F const&) const;
|
|
|
|
template <typename F>
|
|
<em>tagged lazy default</em> <a class="reference internal"
|
|
href="#id10">operator||</a>(F&) const;
|
|
|
|
static keyword<Tag> const& <a class="reference internal"
|
|
href="#instance">instance</a>;
|
|
|
|
static keyword<Tag>& <a class="reference internal"
|
|
href="#get">get</a>();
|
|
};
|
|
</pre>
|
|
<p><strong>If</strong> <a class="reference internal"
|
|
href="#boost-parameter-has-perfect-forwarding"
|
|
id="id61"><tt class="docutils literal"
|
|
>BOOST_PARAMETER_HAS_PERFECT_FORWARDING</tt></a> is <strong>not</strong>
|
|
<tt class="docutils literal">#defined</tt>, <strong>then</strong>:</p>
|
|
<pre class="literal-block">
|
|
template <typename Tag>
|
|
struct keyword
|
|
{
|
|
typedef Tag tag;
|
|
|
|
template <typename T>
|
|
typename boost::<a class="reference external"
|
|
href="../../../core/doc/html/core/enable_if.html"><tt
|
|
class="docutils literal">enable_if</tt></a><
|
|
typename boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/eval-if.html"><tt
|
|
class="docutils literal">eval_if</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_scalar.html"><tt
|
|
class="docutils literal">is_scalar</tt></a><T>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">true_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/eval-if.html"><tt
|
|
class="docutils literal">eval_if</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_same.html"><tt
|
|
class="docutils literal">is_same</tt></a><
|
|
typename Tag::qualifier
|
|
, boost::parameter::in_reference
|
|
>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">true_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/if.html"><tt
|
|
class="docutils literal">if_</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_same.html"><tt
|
|
class="docutils literal">is_same</tt></a><
|
|
typename Tag::qualifier
|
|
, boost::parameter::forward_reference
|
|
>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">true_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">false_</tt></a>
|
|
>
|
|
>
|
|
>::type
|
|
, <a class="reference internal" href="#argumentpack"><span
|
|
class="concept">ArgumentPack</span></a>
|
|
>::type constexpr
|
|
<a class="reference internal"
|
|
href="#operator">operator=</a>(T const& value) const;
|
|
|
|
template <typename T>
|
|
typename boost::<a class="reference external"
|
|
href="../../../core/doc/html/core/enable_if.html"><tt
|
|
class="docutils literal">enable_if</tt></a><
|
|
typename boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/eval-if.html"><tt
|
|
class="docutils literal">eval_if</tt></a><
|
|
typename boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/eval-if.html"><tt
|
|
class="docutils literal">eval_if</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_same.html"><tt
|
|
class="docutils literal">is_same</tt></a><
|
|
typename Tag::qualifier
|
|
, boost::parameter::out_reference
|
|
>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">true_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/if.html"><tt
|
|
class="docutils literal">if_</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_same.html"><tt
|
|
class="docutils literal">is_same</tt></a><
|
|
typename Tag::qualifier
|
|
, boost::parameter::forward_reference
|
|
>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">true_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">false_</tt></a>
|
|
>
|
|
>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/if.html"><tt
|
|
class="docutils literal">if_</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_const.html"><tt
|
|
class="docutils literal">is_const</tt></a><T>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">false_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">true_</tt></a>
|
|
>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">false_</tt></a>
|
|
>::type
|
|
, <a class="reference internal" href="#argumentpack"><span
|
|
class="concept">ArgumentPack</span></a>
|
|
>::type constexpr
|
|
<a class="reference internal"
|
|
href="#operator">operator=</a>(T& value) const;
|
|
|
|
template <typename T>
|
|
typename boost::<a class="reference external"
|
|
href="../../../core/doc/html/core/enable_if.html"><tt
|
|
class="docutils literal">enable_if</tt></a><
|
|
typename boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/eval-if.html"><tt
|
|
class="docutils literal">eval_if</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_scalar.html"><tt
|
|
class="docutils literal">is_scalar</tt></a><T>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">true_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/eval-if.html"><tt
|
|
class="docutils literal">eval_if</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_same.html"><tt
|
|
class="docutils literal">is_same</tt></a><
|
|
typename Tag::qualifier
|
|
, boost::parameter::in_reference
|
|
>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">true_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/if.html"><tt
|
|
class="docutils literal">if_</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_same.html"><tt
|
|
class="docutils literal">is_same</tt></a><
|
|
typename Tag::qualifier
|
|
, boost::parameter::forward_reference
|
|
>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">true_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">false_</tt></a>
|
|
>
|
|
>
|
|
>::type
|
|
, <em>tagged default</em>
|
|
>::type constexpr
|
|
<a class="reference internal"
|
|
href="#id9">operator|</a>(T const& x) const;
|
|
|
|
template <typename T>
|
|
typename boost::<a class="reference external"
|
|
href="../../../core/doc/html/core/enable_if.html"><tt
|
|
class="docutils literal">enable_if</tt></a><
|
|
typename boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/eval-if.html"><tt
|
|
class="docutils literal">eval_if</tt></a><
|
|
typename boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/eval-if.html"><tt
|
|
class="docutils literal">eval_if</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_same.html"><tt
|
|
class="docutils literal">is_same</tt></a><
|
|
typename Tag::qualifier
|
|
, boost::parameter::out_reference
|
|
>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">true_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/if.html"><tt
|
|
class="docutils literal">if_</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_same.html"><tt
|
|
class="docutils literal">is_same</tt></a><
|
|
typename Tag::qualifier
|
|
, boost::parameter::forward_reference
|
|
>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">true_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">false_</tt></a>
|
|
>
|
|
>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/if.html"><tt
|
|
class="docutils literal">if_</tt></a><
|
|
boost::<a class="reference external"
|
|
href="../../../type_traits/doc/html/boost_typetraits/is_const.html"><tt
|
|
class="docutils literal">is_const</tt></a><T>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">false_</tt></a>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">true_</tt></a>
|
|
>
|
|
, boost::mpl::<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/bool.html"><tt
|
|
class="docutils literal">false_</tt></a>
|
|
>::type
|
|
, <em>tagged default</em>
|
|
>::type constexpr
|
|
<a class="reference internal"
|
|
href="#id9">operator|</a>(T& x) const;
|
|
|
|
template <typename F>
|
|
<em>tagged lazy default</em> <a class="reference internal"
|
|
href="#id10">operator||</a>(F const&) const;
|
|
|
|
template <typename F>
|
|
<em>tagged lazy default</em> <a class="reference internal"
|
|
href="#id10">operator||</a>(F&) const;
|
|
|
|
static keyword<Tag> const& <a class="reference internal"
|
|
href="#instance">instance</a>;
|
|
|
|
static keyword<Tag>& <a class="reference internal"
|
|
href="#get">get</a>();
|
|
};
|
|
</pre>
|
|
<dl class="docutils" id="operator">
|
|
<dt><tt class="docutils literal">operator=</tt></dt>
|
|
<dd>
|
|
<pre class="first literal-block">
|
|
template <typename T> <a class="reference internal" href="#argumentpack"
|
|
><span class="concept">ArgumentPack</span></a
|
|
> operator=(T const& value) const;
|
|
template <typename T> <a class="reference internal" href="#argumentpack"
|
|
><span class="concept">ArgumentPack</span></a
|
|
> operator=(T& value) const;
|
|
</pre>
|
|
<p><strong>If</strong> <a class="reference internal"
|
|
href="#boost-parameter-has-perfect-forwarding"><tt class="docutils literal"
|
|
>BOOST_PARAMETER_HAS_PERFECT_FORWARDING</tt></a> is
|
|
<tt class="docutils literal">#defined</tt>, <strong>then</strong>:</p>
|
|
<pre class="first literal-block">
|
|
template <typename T> <a class="reference internal" href="#argumentpack"
|
|
><span class="concept">ArgumentPack</span></a
|
|
> operator=(T const&& value) const;
|
|
template <typename T> <a class="reference internal" href="#argumentpack"
|
|
><span class="concept">ArgumentPack</span></a
|
|
> operator=(T&& value) const;
|
|
</pre>
|
|
<table class="last docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Requires:</th>
|
|
<td class="field-body">one of the following:
|
|
<ul>
|
|
<li>The nested <tt class="docutils literal">qualifier</tt> type of
|
|
<tt class="docutils literal">Tag</tt> must be
|
|
<tt class="docutils literal">forward_reference</tt>.</li>
|
|
<li>To use the <tt class="docutils literal">const</tt> lvalue reference
|
|
overload, <tt class="docutils literal">T</tt> must be scalar, or the nested
|
|
<tt class="docutils literal">qualifier</tt> type of
|
|
<tt class="docutils literal">Tag</tt> must be
|
|
<tt class="docutils literal">in_reference</tt>.</li>
|
|
<li>To use the mutable lvalue reference overload, the nested
|
|
<tt class="docutils literal">qualifier</tt> type of
|
|
<tt class="docutils literal">Tag</tt> must be
|
|
<tt class="docutils literal">out_reference</tt> or
|
|
<tt class="docutils literal">in_out_reference</tt>, and
|
|
<tt class="docutils literal">T</tt> must not be
|
|
<tt class="docutils literal">const</tt>-qualified.</li>
|
|
<li>To use the <tt class="docutils literal">const</tt> rvalue reference
|
|
overload for non-scalar <tt class="docutils literal">T</tt>, the nested
|
|
<tt class="docutils literal">qualifier</tt> type of
|
|
<tt class="docutils literal">Tag</tt> must be
|
|
<tt class="docutils literal">in_reference</tt>.</li>
|
|
<li>To use the mutable rvalue reference overload for non-scalar
|
|
<tt class="docutils literal">T</tt>, the nested
|
|
<tt class="docutils literal">qualifier</tt> type of
|
|
<tt class="docutils literal">Tag</tt> must be
|
|
<tt class="docutils literal">consume_reference</tt> or
|
|
<tt class="docutils literal">move_from_reference</tt>.</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field">
|
|
<th class="field-name">Returns:</th>
|
|
<td class="field-body">an <a class="reference internal"
|
|
href="#argumentpack"><span class="concept">ArgumentPack</span></a> containing
|
|
a single <a class="reference internal" href="#tagged-reference">tagged
|
|
reference</a> to <tt class="docutils literal">value</tt> with
|
|
<a class="reference internal" href="#kw">keyword</a>
|
|
<tt class="docutils literal">Tag</tt></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="docutils" id="id9">
|
|
<dt><tt class="docutils literal">operator|</tt></dt>
|
|
<dd><pre class="first literal-block">
|
|
template <typename T> <em
|
|
>tagged default</em> operator|(T const& x) const;
|
|
template <typename T> <em
|
|
>tagged default</em> operator|(T& x) const;
|
|
</pre>
|
|
<p><strong>If</strong> <a class="reference internal"
|
|
href="#boost-parameter-has-perfect-forwarding"><tt class="docutils literal"
|
|
>BOOST_PARAMETER_HAS_PERFECT_FORWARDING</tt></a> is
|
|
<tt class="docutils literal">#defined</tt>, <strong>then</strong>:</p>
|
|
<pre class="first literal-block">
|
|
template <typename T> <em
|
|
>tagged default</em> operator|(T const&& x) const;
|
|
template <typename T> <em
|
|
>tagged default</em> operator|(T&& x) const;
|
|
</pre>
|
|
<table class="last docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Requires:</th>
|
|
<td class="field-body">one of the following:
|
|
<ul>
|
|
<li>The nested <tt class="docutils literal">qualifier</tt> type of
|
|
<tt class="docutils literal">Tag</tt> must be
|
|
<tt class="docutils literal">forward_reference</tt>.</li>
|
|
<li>To use the <tt class="docutils literal">const</tt> lvalue reference
|
|
overload, <tt class="docutils literal">T</tt> must be scalar, or the nested
|
|
<tt class="docutils literal">qualifier</tt> type of
|
|
<tt class="docutils literal">Tag</tt> must be
|
|
<tt class="docutils literal">in_reference</tt>.</li>
|
|
<li>To use the mutable lvalue reference overload, the nested
|
|
<tt class="docutils literal">qualifier</tt> type of
|
|
<tt class="docutils literal">Tag</tt> must be
|
|
<tt class="docutils literal">out_reference</tt> or
|
|
<tt class="docutils literal">in_out_reference</tt>, and
|
|
<tt class="docutils literal">T</tt> must not be
|
|
<tt class="docutils literal">const</tt>-qualified.</li>
|
|
<li>To use the <tt class="docutils literal">const</tt> rvalue reference
|
|
overload for non-scalar <tt class="docutils literal">T</tt>, the nested
|
|
<tt class="docutils literal">qualifier</tt> type of
|
|
<tt class="docutils literal">Tag</tt> must be
|
|
<tt class="docutils literal">in_reference</tt>.</li>
|
|
<li>To use the mutable rvalue reference overload for non-scalar
|
|
<tt class="docutils literal">T</tt>, the nested
|
|
<tt class="docutils literal">qualifier</tt> type of
|
|
<tt class="docutils literal">Tag</tt> must be
|
|
<tt class="docutils literal">consume_reference</tt> or
|
|
<tt class="docutils literal">move_from_reference</tt>.</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field">
|
|
<th class="field-name">Returns:</th>
|
|
<td class="field-body">a <a class="reference internal"
|
|
href="#tagged-default">tagged default</a> with <em>value</em>
|
|
<tt class="docutils literal">x</tt> and
|
|
<a class="reference internal" href="#kw">keyword</a>
|
|
<tt class="docutils literal">Tag</tt>.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="docutils" id="id10">
|
|
<dt><tt class="docutils literal">operator||</tt></dt>
|
|
<dd>
|
|
<pre class="first literal-block">
|
|
template <typename F> <em
|
|
>tagged lazy default</em> operator||(F const& g) const;
|
|
template <typename F> <em
|
|
>tagged lazy default</em> operator||(F& g) const;
|
|
</pre>
|
|
<table class="last docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Requires:</th>
|
|
<td class="field-body"><tt class="docutils literal">g()</tt> is valid, with
|
|
type <tt class="docutils literal">boost::</tt><a class="reference external"
|
|
href="../../../utility/utility.htm#result_of"><tt class="docutils literal"
|
|
>result_of</tt></a><tt class="docutils literal"><span class="pre"
|
|
><F()>::type</span></tt>.<a class="footnote-reference"
|
|
href="#no-result-of" id="id11"><sup>2</sup></a></td>
|
|
</tr>
|
|
<tr class="field">
|
|
<th class="field-name">Returns:</th>
|
|
<td class="field-body">a <a class="reference internal"
|
|
href="#tagged-lazy-default">tagged lazy default</a> with <em>value</em>
|
|
<tt class="docutils literal">g</tt> and <a class="reference internal"
|
|
href="#kw">keyword</a> <tt class="docutils literal">Tag</tt>.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="docutils" id="instance">
|
|
<dt><tt class="docutils literal">instance</tt></dt>
|
|
<dd><pre class="first literal-block">
|
|
static keyword<Tag> const& instance;
|
|
</pre>
|
|
<table class="last docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Returns:</th>
|
|
<td class="field-body">a “singleton instance”: the same object will be
|
|
returned on each invocation of
|
|
<tt class="docutils literal">instance</tt>.</td>
|
|
</tr>
|
|
<tr class="field">
|
|
<th class="field-name">Thread Safety:</th>
|
|
<td class="field-body"><tt class="docutils literal">instance</tt> can be
|
|
accessed from multiple threads simultaneously.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="docutils" id="get">
|
|
<dt><tt class="docutils literal">get</tt></dt>
|
|
<dd><pre class="first literal-block">
|
|
static keyword<Tag>& get();
|
|
</pre>
|
|
<div class="admonition-deprecated admonition">
|
|
<p class="first admonition-title">Deprecated</p>
|
|
<p class="last">This macro has been deprecated in favor of
|
|
<tt class="docutils literal">instance</tt>.</p>
|
|
</div>
|
|
<table class="last docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Returns:</th>
|
|
<td class="field-body">a “singleton instance”: the same object will be
|
|
returned on each invocation of
|
|
<tt class="docutils literal">get()</tt>.</td>
|
|
</tr>
|
|
<tr class="field">
|
|
<th class="field-name">Thread Safety:</th>
|
|
<td class="field-body"><tt class="docutils literal">get()</tt> can be called
|
|
from multiple threads simultaneously.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<div class="section" id="template-keyword">
|
|
<h2><a class="toc-backref" href="#id41">4.2 <tt
|
|
class="docutils literal">template_keyword</tt></a></h2>
|
|
<p>This class template encapsulates a named template parameter. Every type
|
|
generated by the <a class="reference internal"
|
|
href="#boost-parameter-template-keyword-name"><tt class="docutils literal"
|
|
>BOOST_PARAMETER_TEMPLATE_KEYWORD</tt></a> macro is a specialization of
|
|
<tt class="docutils literal">template_keyword</tt>.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Defined in:</th>
|
|
<td class="field-body"><a class="reference external"
|
|
href="../../../../boost/parameter/template_keyword.hpp"
|
|
>boost/parameter/template_keyword.hpp</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<pre class="literal-block">
|
|
template <typename Tag, typename T>
|
|
struct template_keyword
|
|
{
|
|
typedef Tag key_type;
|
|
typedef T value_type;
|
|
typedef <em>implementation defined</em> reference;
|
|
};
|
|
</pre>
|
|
<p>The <a class="reference external" href="../../test/ntp.cpp"
|
|
>test/ntp.cpp</a> test program demonstrates proper usage of this class
|
|
template.</p>
|
|
</div>
|
|
<div class="section" id="parameters">
|
|
<h2><a class="toc-backref" href="#id42">4.3 <tt
|
|
class="docutils literal">parameters</tt></a></h2>
|
|
<p>Provides an interface for assembling the actual arguments to a
|
|
<cite>forwarding function</cite> into an <span class="concept"
|
|
>ArgumentPack</span>, in which any <a class="reference internal"
|
|
href="#positional">positional</a> arguments will be tagged according to the
|
|
corresponding template argument to
|
|
<tt class="docutils literal">parameters</tt>.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Defined in:</th>
|
|
<td class="field-body"><a class="reference external"
|
|
href="../../../../boost/parameter/parameters.hpp"
|
|
>boost/parameter/parameters.hpp</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>If</strong> <a class="reference internal"
|
|
href="#boost-parameter-has-perfect-forwarding"><tt class="docutils literal"
|
|
>BOOST_PARAMETER_HAS_PERFECT_FORWARDING</tt></a> is
|
|
<tt class="docutils literal">#defined</tt>, <strong>then</strong>:</p>
|
|
<pre class="literal-block">
|
|
template <typename ...PSpec>
|
|
struct parameters
|
|
{
|
|
template <typename ...Args>
|
|
struct <a class="reference internal" href="#match">match</a>
|
|
{
|
|
typedef … type;
|
|
};
|
|
|
|
template <typename ...Args>
|
|
<a class="reference internal" href="#argumentpack"><span
|
|
class="concept">ArgumentPack</span></a> <a class="reference internal"
|
|
href="#id13">operator()</a>(Args&... args) const;
|
|
};
|
|
</pre>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Requires:</th>
|
|
<td class="field-body">Each element in the <tt class="docutils literal"
|
|
>PSpec</tt> parameter pack must be a model of <a class="reference internal"
|
|
href="#parameterspec"><span class="concept">ParameterSpec</span></a>.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<div class="note">
|
|
<p class="first admonition-title">Note</p>
|
|
<p>In this section, <tt class="docutils literal">R</tt> ## <em>i</em> and
|
|
<tt class="docutils literal">K</tt> ## <em>i</em> are defined as follows: for
|
|
any argument type <tt class="docutils literal">A</tt> ## <em>i</em>:</p>
|
|
<blockquote class="last">
|
|
<div class="line-block">
|
|
<div class="line">let <tt class="docutils literal">D0</tt> the set [d0, …, d
|
|
## <em>j</em>] of all <strong>deduced</strong> <em>parameter specs</em> in
|
|
the <tt class="docutils literal">PSpec</tt> parameter pack</div>
|
|
<div class="line"><tt class="docutils literal">R</tt> ## <em>i</em> is the
|
|
<a class="reference internal" href="#intended-argument-type">intended argument
|
|
type</a> of <tt class="docutils literal">A</tt> ## <em>i</em></div>
|
|
<div class="line"><br /></div>
|
|
<div class="line">if <tt class="docutils literal">A</tt> ## <em>i</em> is a
|
|
result type of <tt class="docutils literal"><span class="pre"
|
|
>keyword<T>::</span></tt><a class="reference internal" href="#operator"
|
|
><tt class="docutils literal">operator=</tt></a></div>
|
|
<div class="line">then</div>
|
|
<div class="line-block">
|
|
<div class="line"><tt class="docutils literal">K</tt> ## <em>i</em> is
|
|
<tt class="docutils literal">T</tt></div>
|
|
</div>
|
|
<div class="line">else</div>
|
|
<div class="line-block">
|
|
<div class="line">if some <tt class="docutils literal">A</tt> ## <em>j</em>
|
|
where <em>j</em> ≤ <em>i</em> is a result type of <tt class="docutils literal"
|
|
><span class="pre">keyword<T>::</span></tt><a class="reference internal"
|
|
href="#operator"><tt class="docutils literal">operator=</tt></a></div>
|
|
<div class="line"><em>or</em> some <tt class="docutils literal">P</tt> ##
|
|
<em>j</em> in <em>j</em> ≤ <em>i</em> is <strong>deduced</strong></div>
|
|
<div class="line">then</div>
|
|
<div class="line-block">
|
|
<div class="line">if some <em>parameter spec</em> <tt class="docutils literal"
|
|
>d</tt><em>j</em> in <tt class="docutils literal">D</tt> ## <em>i</em> matches
|
|
<tt class="docutils literal">A</tt><em>i</em></div>
|
|
<div class="line">then</div>
|
|
<div class="line-block">
|
|
<div class="line"><tt class="docutils literal">K</tt> ## <em>i</em> is <tt
|
|
class="docutils literal">d</tt> ## <em>j</em>'s <a class="reference internal"
|
|
href="#keyword-tag-type">keyword tag type</a>.</div>
|
|
<div class="line"><tt class="docutils literal">D</tt><sub>i+1</sub> is
|
|
<tt class="docutils literal">D</tt> ## <em>i</em> -
|
|
[<tt class="docutils literal">d</tt> ## <em>j</em>]</div>
|
|
</div>
|
|
</div>
|
|
<div class="line">else</div>
|
|
<div class="line-block">
|
|
<div class="line"><tt class="docutils literal">K</tt> ## <em>i</em> is <tt
|
|
class="docutils literal">P</tt> ## <em>i</em>'s <a class="reference internal"
|
|
href="#keyword-tag-type">keyword tag type</a>.</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</blockquote>
|
|
</div>
|
|
<p><strong>If</strong> <a class="reference internal"
|
|
href="#boost-parameter-has-perfect-forwarding"><tt class="docutils literal"
|
|
>BOOST_PARAMETER_HAS_PERFECT_FORWARDING</tt></a> is <strong>not</strong>
|
|
<tt class="docutils literal">#defined</tt>, <strong>then</strong>:</p>
|
|
<pre class="literal-block">
|
|
template <
|
|
typename P0 = <em>unspecified</em>
|
|
, typename P1 = <em>unspecified</em>
|
|
, …
|
|
, typename P ## β = <em>unspecified</em>
|
|
>
|
|
struct parameters
|
|
{
|
|
template <
|
|
typename A0
|
|
, typename A1 = <em>unspecified</em>
|
|
, …
|
|
, typename A ## β = <em>unspecified</em>
|
|
>
|
|
struct <a class="reference internal" href="#match">match</a>
|
|
{
|
|
typedef … type;
|
|
};
|
|
|
|
template <typename A0>
|
|
<a class="reference internal" href="#argumentpack"><span
|
|
class="concept">ArgumentPack</span></a> <a class="reference internal"
|
|
href="#id13">operator()</a>(A0& a0) const;
|
|
|
|
template <typename A0, typename A1>
|
|
<a class="reference internal" href="#argumentpack"><span
|
|
class="concept">ArgumentPack</span></a> <a class="reference internal"
|
|
href="#id13">operator()</a>(A0& a0, A1& a1) const;
|
|
|
|
<span class="vellipsis">⋮</span>
|
|
|
|
template <typename A0, typename A1, …, typename A ## β>
|
|
<a class="reference internal" href="#argumentpack"><span
|
|
class="concept">ArgumentPack</span></a>
|
|
<a class="reference internal" href="#id13"
|
|
>operator()</a>(A0& a0, A1& a1, …, A ## β & a ## β) const;
|
|
};
|
|
</pre>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Requires:</th>
|
|
<td class="field-body"><tt class="docutils literal">P0</tt>,
|
|
<tt class="docutils literal">P1</tt>, …, <tt class="docutils literal">P</tt>
|
|
## β are models of <a class="reference internal" href="#parameterspec"
|
|
><span class="concept">ParameterSpec</span></a>.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<div class="note">
|
|
<p class="first admonition-title">Note</p>
|
|
<p>In this section, <tt class="docutils literal">R</tt> ## <em>i</em> and
|
|
<tt class="docutils literal">K</tt> ## <em>i</em> are defined as follows: for
|
|
any argument type <tt class="docutils literal">A</tt> ## <em>i</em>:</p>
|
|
<blockquote class="last">
|
|
<div class="line-block">
|
|
<div class="line">let <tt class="docutils literal">D0</tt> the set [d0, …, d
|
|
## <em>j</em>] of all <strong>deduced</strong> <em>parameter specs</em> in
|
|
[<tt class="docutils literal">P0</tt>, …, <tt class="docutils literal">P</tt>
|
|
## β]</div>
|
|
<div class="line"><tt class="docutils literal">R</tt> ## <em>i</em> is the
|
|
<a class="reference internal" href="#intended-argument-type">intended argument
|
|
type</a> of <tt class="docutils literal">A</tt> ## <em>i</em></div>
|
|
<div class="line"><br /></div>
|
|
<div class="line">if <tt class="docutils literal">A</tt> ## <em>i</em> is a
|
|
result type of <tt class="docutils literal"><span class="pre"
|
|
>keyword<T>::</span></tt><a class="reference internal" href="#operator"
|
|
><tt class="docutils literal">operator=</tt></a></div>
|
|
<div class="line">then</div>
|
|
<div class="line-block">
|
|
<div class="line"><tt class="docutils literal">K</tt> ## <em>i</em> is
|
|
<tt class="docutils literal">T</tt></div>
|
|
</div>
|
|
<div class="line">else</div>
|
|
<div class="line-block">
|
|
<div class="line">if some <tt class="docutils literal">A</tt> ## <em>j</em>
|
|
where <em>j</em> ≤ <em>i</em> is a result type of <tt class="docutils literal"
|
|
><span class="pre">keyword<T>::</span></tt><a class="reference internal"
|
|
href="#operator"><tt class="docutils literal">operator=</tt></a></div>
|
|
<div class="line"><em>or</em> some <tt class="docutils literal">P</tt> ##
|
|
<em>j</em> in <em>j</em> ≤ <em>i</em> is <strong>deduced</strong></div>
|
|
<div class="line">then</div>
|
|
<div class="line-block">
|
|
<div class="line">if some <em>parameter spec</em> <tt class="docutils literal"
|
|
>d</tt><em>j</em> in <tt class="docutils literal">D</tt> ## <em>i</em> matches
|
|
<tt class="docutils literal">A</tt><em>i</em></div>
|
|
<div class="line">then</div>
|
|
<div class="line-block">
|
|
<div class="line"><tt class="docutils literal">K</tt> ## <em>i</em> is <tt
|
|
class="docutils literal">d</tt> ## <em>j</em>'s <a class="reference internal"
|
|
href="#keyword-tag-type">keyword tag type</a>.</div>
|
|
<div class="line"><tt class="docutils literal">D</tt><sub>i+1</sub> is
|
|
<tt class="docutils literal">D</tt> ## <em>i</em> -
|
|
[<tt class="docutils literal">d</tt> ## <em>j</em>]</div>
|
|
</div>
|
|
</div>
|
|
<div class="line">else</div>
|
|
<div class="line-block">
|
|
<div class="line"><tt class="docutils literal">K</tt> ## <em>i</em> is <tt
|
|
class="docutils literal">P</tt> ## <em>i</em>'s <a class="reference internal"
|
|
href="#keyword-tag-type">keyword tag type</a>.</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</blockquote>
|
|
</div>
|
|
<dl class="docutils" id="match">
|
|
<dt><tt class="docutils literal">match</tt></dt>
|
|
<dd>
|
|
<p class="first">A <a class="reference external"
|
|
href="../../../mpl/doc/refmanual/metafunction.html"><span class="concept"
|
|
>Metafunction</span></a> used to remove a <a class="reference external"
|
|
href="index.html#forwarding-functions">forwarding function</a> from overload
|
|
resolution.</p>
|
|
<p><strong>If</strong> <a class="reference internal"
|
|
href="#boost-parameter-has-perfect-forwarding"><tt class="docutils literal"
|
|
>BOOST_PARAMETER_HAS_PERFECT_FORWARDING</tt></a> is
|
|
<tt class="docutils literal">#defined</tt>, <strong>then</strong>:</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Returns:</th>
|
|
<td class="field-body">if all elements in
|
|
<tt class="docutils literal">Params...</tt> are <em>satisfied</em> (see
|
|
below), then <tt class="docutils literal"><span
|
|
class="pre">parameters<Params...></span></tt>. Otherwise,
|
|
<tt class="docutils literal"><span
|
|
class="pre">match<Args...>::type</span></tt> is not defined.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Each element <tt class="docutils literal">P</tt> in
|
|
<tt class="docutils literal">Params</tt> is <strong>satisfied</strong> if
|
|
either:</p>
|
|
<ul class="last simple">
|
|
<li><tt class="docutils literal">P</tt> is the <em>unspecified</em>
|
|
default</li>
|
|
<li><strong>or</strong>, <tt class="docutils literal">P</tt> is a
|
|
<em>keyword tag type</em></li>
|
|
<li><strong>or</strong>, <tt class="docutils literal">P</tt> is
|
|
<a class="reference internal" href="#optional"><tt class="docutils literal"
|
|
>optional</tt></a><tt class="docutils literal"><X,F></tt> and either
|
|
<ul>
|
|
<li><tt class="docutils literal">X</tt> is not <tt class="docutils literal"
|
|
>K</tt> ## <em>i</em> for any <em>i</em>,</li>
|
|
<li><strong>or</strong> <tt class="docutils literal">X</tt> is some
|
|
<tt class="docutils literal">K</tt> ## <em>i</em> and
|
|
<tt class="docutils literal"><span class="pre">mpl::apply<F,R</span></tt>
|
|
## <em>i</em><tt class="docutils literal"><span class="pre"
|
|
>>::type::value</span></tt> is <tt class="docutils literal">true</tt></li>
|
|
</ul>
|
|
</li>
|
|
<li><strong>or</strong>, <tt class="docutils literal">P</tt> is
|
|
<a class="reference internal" href="#required"><tt class="docutils literal"
|
|
>required</tt></a><tt class="docutils literal"><X,F></tt>, and
|
|
<ul>
|
|
<li><tt class="docutils literal">X</tt> is some <tt class="docutils literal"
|
|
>K</tt> ## <em>i</em>, <strong>and</strong></li>
|
|
<li><tt class="docutils literal"><span class="pre"
|
|
>mpl::apply<F,R</span></tt> ## <em>i</em><tt class="docutils literal"
|
|
><span class="pre">>::type::value</span></tt> is
|
|
<tt class="docutils literal">true</tt></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<p><strong>If</strong> <a class="reference internal"
|
|
href="#boost-parameter-has-perfect-forwarding"><tt class="docutils literal"
|
|
>BOOST_PARAMETER_HAS_PERFECT_FORWARDING</tt></a> is <strong>not</strong>
|
|
<tt class="docutils literal">#defined</tt>, <strong>then</strong>:</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Returns:</th>
|
|
<td class="field-body">if <tt class="docutils literal">P0</tt>, <tt
|
|
class="docutils literal">P1</tt>, …, <tt class="docutils literal">Pβ</tt> are
|
|
<em>satisfied</em> (see below), then <tt class="docutils literal"><span
|
|
class="pre">parameters<P0,P1,…,Pβ></span></tt>. Otherwise,
|
|
<tt class="docutils literal"><span
|
|
class="pre">match<A0,A1,…,Aβ>::type</span></tt> is not defined.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><tt class="docutils literal">P0</tt>, <tt class="docutils literal">P1</tt>,
|
|
…, <tt class="docutils literal">Pβ</tt> are <strong>satisfied</strong> if, for
|
|
every <em>j</em> in 0…β, either:</p>
|
|
<ul class="last simple">
|
|
<li><tt class="docutils literal">P</tt> ## <em>j</em> is the
|
|
<em>unspecified</em> default</li>
|
|
<li><strong>or</strong>, <tt class="docutils literal">P</tt> ## <em>j</em> is
|
|
a <em>keyword tag type</em></li>
|
|
<li><strong>or</strong>, <tt class="docutils literal">P</tt> ## <em>j</em> is
|
|
<a class="reference internal" href="#optional"><tt class="docutils literal"
|
|
>optional</tt></a><tt class="docutils literal"><X,F></tt> and either
|
|
<ul>
|
|
<li><tt class="docutils literal">X</tt> is not <tt class="docutils literal"
|
|
>K</tt> ## <em>i</em> for any <em>i</em>,</li>
|
|
<li><strong>or</strong> <tt class="docutils literal">X</tt> is some
|
|
<tt class="docutils literal">K</tt> ## <em>i</em> and
|
|
<tt class="docutils literal"><span class="pre">mpl::apply<F,R</span></tt>
|
|
## <em>i</em><tt class="docutils literal"><span class="pre"
|
|
>>::type::value</span></tt> is <tt class="docutils literal">true</tt></li>
|
|
</ul>
|
|
</li>
|
|
<li><strong>or</strong>, <tt class="docutils literal">P</tt> ## <em>j</em> is
|
|
<a class="reference internal" href="#required"><tt class="docutils literal"
|
|
>required</tt></a><tt class="docutils literal"><X,F></tt>, and
|
|
<ul>
|
|
<li><tt class="docutils literal">X</tt> is some <tt class="docutils literal"
|
|
>K</tt> ## <em>i</em>, <strong>and</strong></li>
|
|
<li><tt class="docutils literal"><span class="pre"
|
|
>mpl::apply<F,R</span></tt> ## <em>i</em><tt class="docutils literal"
|
|
><span class="pre">>::type::value</span></tt> is
|
|
<tt class="docutils literal">true</tt></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="docutils" id="id13">
|
|
<dt><tt class="docutils literal">operator()</tt></dt>
|
|
<dd>
|
|
<p><strong>If</strong> <a class="reference internal"
|
|
href="#boost-parameter-has-perfect-forwarding"
|
|
id="id61"><tt class="docutils literal"
|
|
>BOOST_PARAMETER_HAS_PERFECT_FORWARDING</tt></a> is
|
|
<tt class="docutils literal">#defined</tt>, <strong>then</strong>:</p>
|
|
<pre class="first literal-block">
|
|
template <typename ...Args> <a class="reference internal"
|
|
href="#argumentpack"><span class="concept"
|
|
>ArgumentPack</span></a> operator()(Args&&... args) const;
|
|
</pre>
|
|
<p><strong>Else</strong>:</p>
|
|
<pre class="first literal-block">
|
|
template <typename A0> <a class="reference internal"
|
|
href="#argumentpack"><span class="concept"
|
|
>ArgumentPack</span></a> operator()(A0 const& a0) const;
|
|
|
|
<span class="vellipsis">⋮</span>
|
|
|
|
template <typename A0, …, typename A ## β> <a class="reference internal"
|
|
href="#argumentpack"><span class="concept"
|
|
>ArgumentPack</span></a> <a class="reference internal" href="#id13"
|
|
>operator()</a>(A0 const& a0, …, A ## β const& a ## β) const;
|
|
</pre>
|
|
<table class="last docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Returns:</th>
|
|
<td class="field-body"><p class="first">An <a class="reference internal"
|
|
href="#argumentpack"><span class="concept">ArgumentPack</span></a>
|
|
containing, for each <tt class="docutils literal">a</tt> ## <em>i</em>,</p>
|
|
<ul class="last simple">
|
|
<li>if <tt class="docutils literal">a</tt> ## <em>i</em> is a single-element
|
|
<span class="concept">ArgumentPack</span>, its element</li>
|
|
<li>Otherwise, a <a class="reference internal" href="#tagged-reference">tagged
|
|
reference</a> with <a class="reference internal" href="#kw">keyword</a>
|
|
<tt class="docutils literal">K</tt> ## <em>i</em> and <em>value</em>
|
|
<tt class="docutils literal">a</tt> ## <em>i</em></li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<div class="section" id="optional-required">
|
|
<span id="required"></span><span id="optional"></span><h2><a
|
|
class="toc-backref" href="#id43">4.4 <tt
|
|
class="docutils literal">optional</tt>, <tt class="docutils literal"
|
|
>required</tt></a></h2>
|
|
<p>These templates describe the requirements on a function parameter.</p>
|
|
<p><tt class="docutils literal">optional</tt> is defined in: <a
|
|
class="reference external" href="../../../../boost/parameter/optional.hpp"
|
|
>boost/parameter/optional.hpp</a>.</p>
|
|
<p><tt class="docutils literal">required</tt> is defined in: <a
|
|
class="reference external" href="../../../../boost/parameter/required.hpp"
|
|
>boost/parameter/required.hpp</a>.</p>
|
|
<p>Both headers are included by: <a class="reference external"
|
|
href="../../../../boost/parameter/parameters.hpp"
|
|
>boost/parameter/parameters.hpp</a></p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name" colspan="2">Specializations model:</th>
|
|
</tr>
|
|
<tr>
|
|
<td> </td>
|
|
<td class="field-body"><a class="reference internal" href="#parameterspec"
|
|
><span class="concept">ParameterSpec</span></a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<pre class="literal-block">
|
|
template <typename Tag, typename Predicate = <em>unspecified</em>>
|
|
struct optional;
|
|
|
|
template <typename Tag, typename Predicate = <em>unspecified</em>>
|
|
struct required;
|
|
</pre>
|
|
<p>The default value of <tt class="docutils literal">Predicate</tt> is an
|
|
unspecified <a class="reference external"
|
|
href="../../../mpl/doc/refmanual/metafunction-class.html">MPL Binary
|
|
Metafunction Class</a> that returns <tt class="docutils literal"><span
|
|
class="pre">mpl::true_</span></tt> for any argument.</p>
|
|
</div>
|
|
<div class="section" id="deduced">
|
|
<h2><a class="toc-backref" href="#id44">4.5 <tt
|
|
class="docutils literal">deduced</tt></a></h2>
|
|
<p>This template is used to wrap the <em>keyword tag</em> argument to
|
|
<tt class="docutils literal">optional</tt> or <tt class="docutils literal"
|
|
>required</tt>.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Defined in:</th>
|
|
<td class="field-body"><a class="reference external"
|
|
href="../../../../boost/parameter/deduced.hpp"
|
|
>boost/parameter/deduced.hpp</a></td>
|
|
</tr>
|
|
<tr class="field">
|
|
<th class="field-name">Included by:</th>
|
|
<td class="field-body"><a class="reference external"
|
|
href="../../../../boost/parameter/parameters.hpp"
|
|
>boost/parameter/parameters.hpp</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<pre class="literal-block">
|
|
template <typename Tag>
|
|
struct deduced;
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
<hr class="docutils" />
|
|
<div class="section" id="metafunctions">
|
|
<h1><a class="toc-backref" href="#id45"
|
|
>5 Metafunctions</a></h1>
|
|
<p>A <a class="reference external"
|
|
href="../../../mpl/doc/refmanual/metafunction.html"><span class="concept"
|
|
>Metafunction</span></a> is conceptually a function that operates on, and
|
|
returns, C++ types.</p>
|
|
<div class="section" id="binding">
|
|
<h2><a class="toc-backref" href="#id46">5.1 <tt
|
|
class="docutils literal">binding</tt></a></h2>
|
|
<p>Returns the result type of indexing an argument pack with a
|
|
<a class="reference internal" href="#keyword-tag-type">keyword tag type</a> or
|
|
with a <a class="reference internal" href="#tagged-default">tagged
|
|
default</a>.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Defined in:</th>
|
|
<td class="field-body"><a class="reference external"
|
|
href="../../../../boost/parameter/binding.hpp"
|
|
>boost/parameter/binding.hpp</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<pre class="literal-block">
|
|
template <typename A, typename K, typename D = void_>
|
|
struct binding
|
|
{
|
|
typedef … type;
|
|
};
|
|
</pre>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Requires:</th>
|
|
<td class="field-body"><tt class="docutils literal">A</tt> is a model of
|
|
<a class="reference internal" href="#argumentpack"><span class="concept"
|
|
>ArgumentPack</span></a>.</td>
|
|
</tr>
|
|
<tr class="field">
|
|
<th class="field-name">Returns:</th>
|
|
<td class="field-body">the reference type of the <a class="reference internal"
|
|
href="#tagged-reference">tagged reference</a> in <tt class="docutils literal"
|
|
>A</tt> having <a class="reference internal" href="#keyword-tag-type">keyword
|
|
tag type</a> <tt class="docutils literal">K</tt>, if any. If no such
|
|
<a class="reference internal" href="#tagged-reference">tagged reference</a>
|
|
exists, returns <tt class="docutils literal">D</tt>.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="section" id="lazy-binding">
|
|
<h2><a class="toc-backref" href="#id47">5.2 <tt
|
|
class="docutils literal">lazy_binding</tt></a></h2>
|
|
<p>Returns the result type of indexing an argument pack with a
|
|
<a class="reference internal" href="#tagged-lazy-default">tagged lazy
|
|
default</a>.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Defined in:</th>
|
|
<td class="field-body"><a class="reference external"
|
|
href="../../../../boost/parameter/binding.hpp"
|
|
>boost/parameter/binding.hpp</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<pre class="literal-block">
|
|
template <typename A, typename K, typename F>
|
|
struct lazy_binding
|
|
{
|
|
typedef … type;
|
|
};
|
|
</pre>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Requires:</th>
|
|
<td class="field-body"><tt class="docutils literal">A</tt> is a model of
|
|
<a class="reference internal" href="#argumentpack"><span class="concept"
|
|
>ArgumentPack</span></a>.</td>
|
|
</tr>
|
|
<tr class="field">
|
|
<th class="field-name">Returns:</th>
|
|
<td class="field-body">the reference type of the <a class="reference internal"
|
|
href="#tagged-reference">tagged reference</a> in <tt class="docutils literal"
|
|
>A</tt> having <a class="reference internal" href="#keyword-tag-type">keyword
|
|
tag type</a> <tt class="docutils literal">K</tt>, if any. If no such
|
|
<a class="reference internal" href="#tagged-reference">tagged reference</a>
|
|
exists, returns <tt class="docutils literal">boost::</tt><a
|
|
class="reference external" href="../../../utility/utility.htm#result_of"
|
|
><tt class="docutils literal">result_of</tt></a><tt class="docutils literal"
|
|
><span class="pre"><F()>::type</span></tt>.<a class="footnote-reference"
|
|
href="#no-result-of" id="id18"><sup>2</sup></a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="section" id="value-type">
|
|
<h2><a class="toc-backref" href="#id48">5.3 <tt
|
|
class="docutils literal">value_type</tt></a></h2>
|
|
<p>Returns the result type of indexing an argument pack with a
|
|
<a class="reference internal" href="#keyword-tag-type">keyword tag type</a> or
|
|
with a <a class="reference internal" href="#tagged-default">tagged
|
|
default</a>.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Defined n:</th>
|
|
<td class="field-body"><a class="reference external"
|
|
href="../../../../boost/parameter/value_type.hpp"
|
|
>boost/parameter/value_type.hpp</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<pre class="literal-block">
|
|
template <typename A, typename K, typename D = void_>
|
|
struct value_type
|
|
{
|
|
typedef … type;
|
|
};
|
|
</pre>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Requires:</th>
|
|
<td class="field-body">
|
|
<p class="first"><tt class="docutils literal">A</tt> is a model of
|
|
<a class="reference internal" href="#argumentpack"><span class="concept"
|
|
>ArgumentPack</span></a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field">
|
|
<th class="field-name">Returns:</th>
|
|
<td class="field-body">
|
|
<p class="first">the type of the <a class="reference internal"
|
|
href="#tagged-reference">tagged reference</a> in <tt class="docutils literal"
|
|
>A</tt> having <a class="reference internal" href="#keyword-tag-type">keyword
|
|
tag type</a> <tt class="docutils literal">K</tt>, if any. If no such
|
|
<a class="reference internal" href="#tagged-reference">tagged reference</a>
|
|
exists, returns <tt class="docutils literal">D</tt>. Equivalent to:</p>
|
|
<pre class="literal-block">
|
|
typename remove_reference<
|
|
typename binding<A, K, D>::type
|
|
>::type
|
|
</pre>
|
|
<p class="last">… when <tt class="docutils literal">D</tt> is not a reference
|
|
type.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="section" id="is-argument-pack">
|
|
<h2><a class="toc-backref" href="#id49">5.4 <tt
|
|
class="docutils literal">is_argument_pack</tt></a></h2>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Defined in:</th>
|
|
<td class="field-body"><a class="reference external"
|
|
href="../../../../boost/parameter/is_argument_pack.hpp"
|
|
>boost/parameter/is_argument_pack.hpp</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<pre class="literal-block">
|
|
template <typename T>
|
|
struct is_argument_pack // : mpl::true_ or mpl::false_
|
|
{
|
|
};
|
|
</pre>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Returns:</th>
|
|
<td class="field-body"><tt class="docutils literal"><span class="pre"
|
|
>mpl::true_</span></tt> if <tt class="docutils literal">T</tt> is a model of
|
|
<a class="reference internal" href="#argumentpack"><span class="concept"
|
|
>ArgumentPack</span></a>, <tt class="docutils literal"><span class="pre"
|
|
>mpl::false_</span></tt> otherwise.</a>
|
|
exists, returns <tt class="docutils literal">D</tt>.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<hr class="docutils" />
|
|
<div class="section" id="code-generation-macros">
|
|
<h1><a class="toc-backref" href="#id50">6 Code Generation
|
|
Macros</a></h1>
|
|
<p>Macros in this section can be used to ease the writing of code using the
|
|
Parameter libray by eliminating repetitive boilerplate.</p>
|
|
<div class="section"
|
|
id="boost-parameter-function-result-name-tag-namespace-arguments">
|
|
<h2><a class="toc-backref" href="#id51">6.1 <tt
|
|
class="docutils literal">BOOST_PARAMETER_FUNCTION(result, name, tag_namespace,
|
|
arguments)</tt></a></h2>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Defined in:</th>
|
|
<td class="field-body"><a class="reference external"
|
|
href="../../../../boost/parameter/preprocessor.hpp"
|
|
>boost/parameter/preprocessor.hpp</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name" colspan="2">Requires:</th>
|
|
</tr>
|
|
<tr>
|
|
<td> </td>
|
|
<td class="field-body">
|
|
<p class="first"><tt class="docutils literal">result</tt> is the parenthesized
|
|
return type of the function. <tt class="docutils literal">name</tt> is the
|
|
base name of the function, this is the name of the generated forwarding
|
|
functions. <tt class="docutils literal">tag_namespace</tt> is the namespace
|
|
in which the keywords used by the function
|
|
resides. <tt class="docutils literal">arguments</tt> is a list of
|
|
<em>argument specifiers</em>, as defined below.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field">
|
|
<th class="field-name" colspan="2">Argument specifiers syntax:</th>
|
|
</tr>
|
|
<tr>
|
|
<td> </td>
|
|
<td class="field-body">
|
|
<pre class="first literal-block">
|
|
argument-specifiers ::= <em>specifier-group0</em> {<em>specifier-group0</em>}
|
|
|
|
specifier-group0 ::= <em>specifier-group1</em> |
|
|
(
|
|
'<strong>(</strong>' '<strong>deduced</strong>'
|
|
<em>specifier-group1</em> {<em>specifier-group1</em>}
|
|
'<strong>)</strong>'
|
|
)
|
|
|
|
specifier-group1 ::=
|
|
(
|
|
'<strong>(</strong>' '<strong>optional</strong>'
|
|
<em>optional-specifier</em> {<em>optional-specifier</em>}
|
|
'<strong>)</strong>'
|
|
) | (
|
|
'<strong>(</strong>' '<strong>required</strong>'
|
|
<em>required-specifier</em> {<em>required-specifier</em>}
|
|
'<strong>)</strong>'
|
|
)
|
|
|
|
optional-specifier ::=
|
|
'<strong>(</strong>'
|
|
<em>argument-name</em> '<strong>,</strong>' <em
|
|
>restriction</em> '<strong>,</strong>' <em>default-value</em>
|
|
')'
|
|
|
|
required-specifier ::=
|
|
'<strong>(</strong>' <em>argument-name</em> '<strong>,</strong>' <em
|
|
>restriction</em> ')'
|
|
|
|
restriction ::=
|
|
( '<strong>*</strong>' '<strong>(</strong>' <em>mfc</em> '<strong
|
|
>)</strong>' ) |
|
|
( '<strong>(</strong>' <em>typename</em> '<strong>)</strong>' ) |
|
|
'<strong>*</strong>'
|
|
</pre>
|
|
<ul class="last simple">
|
|
<li><tt class="docutils literal">argument-name</tt> is any valid C++
|
|
identifier.</li>
|
|
<li><tt class="docutils literal">default-value</tt> is any valid C++
|
|
expression; if necessary, user code can compute it in terms of
|
|
<tt class="docutils literal">previous-name ## _type</tt>, where
|
|
<tt class="docutils literal">previous-name</tt> is the
|
|
<tt class="docutils literal">argument-name</tt> in a previous
|
|
<tt class="docutils literal">specifier-group0</tt> or
|
|
<tt class="docutils literal">specifier-group1</tt>. <em>This expression will
|
|
be invoked exactly once.</em></li>
|
|
<li><tt class="docutils literal">mfc</tt> is an <a class="reference external"
|
|
href="../../../mpl/doc/refmanual/metafunction-class.html">MPL Binary
|
|
Metafunction Class</a> whose first argument will be the type of the
|
|
corresponding <tt class="docutils literal">argument-name</tt>, whose second
|
|
argument will be the entire <a class="reference internal" href="#argumentpack"
|
|
><span class="concept">ArgumentPack</span></a>, and whose return type is a
|
|
<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/integral-constant.html">Boolean Integral
|
|
Concept</a>; however, user code <em>cannot</em> compute
|
|
<tt class="docutils literal">mfc</tt> in terms of
|
|
<tt class="docutils literal">previous-name ## _type</tt>.</li>
|
|
<li><tt class="docutils literal">type-name</tt> is either the name of a
|
|
<strong>target type</strong> or an <a class="reference external"
|
|
href="../../../mpl/doc/refmanual/metafunction-class.html">MPL Binary
|
|
Metafunction Class</a> whose first argument will be the type of the
|
|
corresponding <tt class="docutils literal">argument-name</tt>, whose second
|
|
argument will be the entire <a class="reference internal" href="#argumentpack"
|
|
><span class="concept">ArgumentPack</span></a>, and whose return type is the
|
|
<strong>target type</strong>. If <tt class="docutils literal"
|
|
>restriction</tt> uses this form, then the type of the generated name <tt
|
|
class="docutils literal">argument-name ## _type</tt> will be computed in terms
|
|
of the <strong>target type</strong>, and the generated reference
|
|
<tt class="docutils literal">argument-name</tt> (but not its corresponding
|
|
entry in <tt class="docutils literal">args</tt>) will be cast to that
|
|
type.</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name" colspan="2">Generated names in enclosing scope:</th>
|
|
</tr>
|
|
<tr>
|
|
<td> </td>
|
|
<td class="field-body">
|
|
<ul class="first last simple">
|
|
<li><tt class="docutils literal">boost_param_result_ ## __LINE__ ##
|
|
name</tt></li>
|
|
<li><tt class="docutils literal">boost_param_params_ ## __LINE__ ##
|
|
name</tt></li>
|
|
<li><tt class="docutils literal">boost_param_parameters_ ## __LINE__ ##
|
|
name</tt></li>
|
|
<li><tt class="docutils literal">boost_param_impl ## name</tt></li>
|
|
<li><tt class="docutils literal">boost_param_dispatch_0boost_ ## __LINE__ ##
|
|
name</tt></li>
|
|
<li><tt class="docutils literal">boost_param_dispatch_1boost_ ## __LINE__ ##
|
|
name</tt></li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="docutils">
|
|
<dt>Approximate expansion:</dt>
|
|
<dd>
|
|
<p class="first"><strong>Where</strong>:</p>
|
|
<ul class="simple">
|
|
<li><tt class="docutils literal">n</tt> denotes the <em>minimum</em> arity, as
|
|
determined from <tt class="docutils literal">arguments</tt>.</li>
|
|
<li><tt class="docutils literal">m</tt> denotes the <em>maximum</em> arity, as
|
|
determined from <tt class="docutils literal">arguments</tt>.</li>
|
|
</ul>
|
|
<p><strong>If</strong> <a class="reference internal"
|
|
href="#boost-parameter-has-perfect-forwarding"><tt class="docutils literal"
|
|
>BOOST_PARAMETER_HAS_PERFECT_FORWARDING</tt></a> is
|
|
<tt class="docutils literal">#defined</tt>, <strong>then</strong>:</p>
|
|
<pre class="last literal-block">
|
|
template <typename T>
|
|
struct boost_param_result_ ## __LINE__ ## <strong>name</strong>
|
|
{
|
|
typedef <strong>result</strong> type;
|
|
};
|
|
|
|
struct boost_param_params_ ## __LINE__ ## <strong>name</strong>
|
|
: boost::parameter::parameters<
|
|
<em>list of parameter specifications, based on arguments</em>
|
|
>
|
|
{
|
|
};
|
|
|
|
typedef boost_param_params_ ## __LINE__ ## <strong>name</strong>
|
|
boost_param_parameters_ ## __LINE__ ## <strong>name</strong>;
|
|
|
|
template <typename Args>
|
|
typename boost_param_result_ ## __LINE__ ## <strong
|
|
>name</strong><Args>::type
|
|
boost_param_impl ## <strong>name</strong>(Args const&);
|
|
|
|
template <typename A0, …, typename A ## <strong>n</strong>>
|
|
<em>result type</em>
|
|
<strong>name</strong>(
|
|
A0&& a0, …, A ## <strong>n</strong> && a ## <strong
|
|
>n</strong>
|
|
, typename boost_param_parameters_ ## __LINE__ ## <strong
|
|
>name</strong>::match<
|
|
A0, …, A ## <strong>n</strong>
|
|
>::type = boost_param_parameters_ ## __LINE__ ## <strong
|
|
>name</strong>()
|
|
)
|
|
{
|
|
return boost_param_impl ## <strong>name</strong>(
|
|
boost_param_parameters_ ## __LINE__ ## <strong>name</strong>()(
|
|
std::<a class="reference external"
|
|
href="http://en.cppreference.com/w/cpp/utility/forward"><tt
|
|
class="docutils literal">forward</tt></a><A0>(a0)
|
|
, …
|
|
, std::<a class="reference external"
|
|
href="http://en.cppreference.com/w/cpp/utility/forward"><tt
|
|
class="docutils literal">forward</tt></a><A ## <strong
|
|
>n</strong>>(a ## <strong>n</strong>)
|
|
)
|
|
);
|
|
}
|
|
|
|
<span class="vellipsis">⋮</span>
|
|
|
|
template <typename A0, …, typename A ## <strong>m</strong>>
|
|
<em>result type</em>
|
|
<strong>name</strong>(
|
|
A0&& a0, …, A ## <strong>m</strong> && a ## <strong
|
|
>m</strong>
|
|
, typename boost_param_parameters_ ## __LINE__ ## <strong
|
|
>name</strong>::match<
|
|
A0, …, A ## <strong>m</strong>
|
|
>::type = boost_param_parameters_ ## __LINE__ ## <strong
|
|
>name</strong>()
|
|
)
|
|
{
|
|
return boost_param_impl ## <strong>name</strong>(
|
|
boost_param_parameters_ ## __LINE__ ## <strong>name</strong>()(
|
|
std::<a class="reference external"
|
|
href="http://en.cppreference.com/w/cpp/utility/forward"><tt
|
|
class="docutils literal">forward</tt></a><A0>(a0)
|
|
, …
|
|
, std::<a class="reference external"
|
|
href="http://en.cppreference.com/w/cpp/utility/forward"><tt
|
|
class="docutils literal">forward</tt></a><A ## <strong
|
|
>m</strong>>(a ## <strong>m</strong>)
|
|
)
|
|
);
|
|
}
|
|
|
|
template <
|
|
typename ResultType
|
|
, typename Args
|
|
, typename <em>argument name</em> ## <strong>0</strong> ## _type
|
|
, …
|
|
, typename <em>argument name</em> ## <strong>n</strong> ## _type
|
|
>
|
|
ResultType
|
|
boost_param_dispatch_0boost_ ## __LINE__ ## <strong>name</strong>(
|
|
(ResultType(*)())
|
|
, Args const& args
|
|
, <em>argument name</em> ## <strong>0</strong> ## _type&& <em
|
|
>argument name</em> ## <strong>0</strong>
|
|
, …
|
|
, <em>argument name</em> ## <strong>n</strong> ## _type&& <em
|
|
>argument name</em> ## <strong>n</strong>
|
|
);
|
|
|
|
<span class="vellipsis">⋮</span>
|
|
|
|
template <
|
|
typename ResultType
|
|
, typename Args
|
|
, typename <em>argument name</em> ## <strong>0</strong> ## _type
|
|
, …
|
|
, typename <em>argument name</em> ## <strong>m</strong> ## _type
|
|
>
|
|
ResultType
|
|
boost_param_dispatch_0boost_ ## __LINE__ ## <strong>name</strong>(
|
|
(ResultType(*)())
|
|
, Args const& args
|
|
, <em>argument name</em> ## <strong>0</strong> ## _type&& <em
|
|
>argument name</em> ## <strong>0</strong>
|
|
, …
|
|
, <em>argument name</em> ## <strong>m</strong> ## _type&& <em
|
|
>argument name</em> ## <strong>m</strong>
|
|
);
|
|
|
|
template <typename Args>
|
|
typename boost_param_result_ ## __LINE__ ## <strong
|
|
>name</strong><Args>::type
|
|
boost_param_impl ## <strong>name</strong>(Args const& args)
|
|
{
|
|
return boost_param_dispatch_0boost_ ## __LINE__ ## <strong>name</strong>(
|
|
static_cast<ResultType(*)()>(std::nullptr)
|
|
, args
|
|
, std::<a class="reference external"
|
|
href="http://en.cppreference.com/w/cpp/utility/forward"><tt
|
|
class="docutils literal">forward</tt></a><
|
|
typename boost::parameter::value_type<
|
|
Args
|
|
, <em
|
|
>keyword tag type of required parameter</em> ## <strong>0</strong>
|
|
>::type
|
|
>(args[ <em>keyword object of required parameter</em> ## <strong
|
|
>0</strong>])
|
|
, …
|
|
, std::<a class="reference external"
|
|
href="http://en.cppreference.com/w/cpp/utility/forward"><tt
|
|
class="docutils literal">forward</tt></a><
|
|
typename boost::parameter::value_type<
|
|
Args
|
|
, <em
|
|
>keyword tag type of required parameter</em> ## <strong>n</strong>
|
|
>::type
|
|
>(args[ <em>keyword object of required parameter</em> ## <strong
|
|
>n</strong>])
|
|
);
|
|
}
|
|
|
|
template <
|
|
typename ResultType
|
|
, typename Args
|
|
, typename <em>argument name</em> ## <strong>0</strong> ## _type
|
|
, …
|
|
, typename <em>argument name</em> ## <strong>n</strong> ## _type
|
|
>
|
|
ResultType
|
|
boost_param_dispatch_0boost_ ## __LINE__ ## <strong>name</strong>(
|
|
(ResultType(*)())
|
|
, Args const& args
|
|
, <em>argument name</em> ## <strong>0</strong> ## _type&& <em
|
|
>argument name</em> ## <strong>0</strong>
|
|
, …
|
|
, <em>argument name</em> ## <strong>n</strong> ## _type&& <em
|
|
>argument name</em> ## <strong>n</strong>
|
|
)
|
|
{
|
|
return boost_param_dispatch_0boost_ ## __LINE__ ## <strong>name</strong>(
|
|
static_cast<ResultType(*)()>(std::nullptr)
|
|
, (args, <em>keyword object of optional parameter</em> ## <strong
|
|
>n + 1</strong> =
|
|
<em>default value of optional parameter</em> ## <strong
|
|
>n + 1</strong>
|
|
)
|
|
, std::<a class="reference external"
|
|
href="http://en.cppreference.com/w/cpp/utility/forward"><tt
|
|
class="docutils literal">forward</tt></a>< <em
|
|
>argument name</em> ## <strong>0</strong> ## _type>(
|
|
<em>argument name</em> ## <strong>0</strong>
|
|
)
|
|
, …
|
|
, std::<a class="reference external"
|
|
href="http://en.cppreference.com/w/cpp/utility/forward"><tt
|
|
class="docutils literal">forward</tt></a>< <em
|
|
>argument name</em> ## <strong>n</strong> ## _type>(
|
|
<em>argument name</em> ## <strong>n</strong>
|
|
)
|
|
, std::<a class="reference external"
|
|
href="http://en.cppreference.com/w/cpp/utility/forward"><tt
|
|
class="docutils literal">forward</tt></a><
|
|
typename boost::parameter::value_type<
|
|
Args
|
|
, <em
|
|
>keyword tag type of optional parameter</em> ## <strong>n + 1</strong>
|
|
>::type
|
|
>(<em>default value of optional parameter</em> ## <strong
|
|
>n + 1</strong>)
|
|
);
|
|
}
|
|
|
|
<span class="vellipsis">⋮</span>
|
|
|
|
template <
|
|
typename ResultType
|
|
, typename Args
|
|
, typename <em>argument name</em> ## <strong>0</strong> ## _type
|
|
, …
|
|
, typename <em>argument name</em> ## <strong>m</strong> ## _type
|
|
>
|
|
ResultType
|
|
boost_param_dispatch_0boost_ ## __LINE__ ## <strong>name</strong>(
|
|
(ResultType(*)())
|
|
, Args const& args
|
|
, <em>argument name</em> ## <strong>0</strong> ## _type&& <em
|
|
>argument name</em> ## <strong>0</strong>
|
|
, …
|
|
, <em>argument name</em> ## <strong>m</strong> ## _type&& <em
|
|
>argument name</em> ## <strong>m</strong>
|
|
)
|
|
</pre>
|
|
<p><strong>If</strong> <a class="reference internal"
|
|
href="#boost-parameter-has-perfect-forwarding"><tt class="docutils literal"
|
|
>BOOST_PARAMETER_HAS_PERFECT_FORWARDING</tt></a> is <strong>not</strong>
|
|
<tt class="docutils literal">#defined</tt>, <strong>then</strong>:</p>
|
|
<pre class="last literal-block">
|
|
template <typename T>
|
|
struct boost_param_result_ ## __LINE__ ## <strong>name</strong>
|
|
{
|
|
typedef <strong>result</strong> type;
|
|
};
|
|
|
|
struct boost_param_params_ ## __LINE__ ## <strong>name</strong>
|
|
: boost::parameter::parameters<
|
|
<em>list of parameter specifications, based on arguments</em>
|
|
>
|
|
{
|
|
};
|
|
|
|
typedef boost_param_params_ ## __LINE__ ## <strong>name</strong>
|
|
boost_param_parameters_ ## __LINE__ ## <strong>name</strong>;
|
|
|
|
template <typename Args>
|
|
typename boost_param_result_ ## __LINE__ ## <strong
|
|
>name</strong><Args>::type
|
|
boost_param_impl ## <strong>name</strong>(Args const&);
|
|
|
|
template <typename A0, …, typename A ## <strong>n</strong>>
|
|
<em>result type</em>
|
|
<strong>name</strong>(
|
|
A0 const& a0, …, A ## <strong>n</strong> const& a ## <strong
|
|
>n</strong>
|
|
, typename boost_param_parameters_ ## __LINE__ ## <strong
|
|
>name</strong>::match<
|
|
A0 const, …, A ## <strong>n</strong> const
|
|
>::type = boost_param_parameters_ ## __LINE__ ## <strong
|
|
>name</strong>()
|
|
)
|
|
{
|
|
return boost_param_impl ## <strong>name</strong>(
|
|
boost_param_parameters_ ## __LINE__ ## <strong>name</strong>()(
|
|
a0, …, a ## <strong>n</strong>
|
|
)
|
|
);
|
|
}
|
|
|
|
<em>… exponential number of overloads …</em>
|
|
<span class="vellipsis">⋮</span>
|
|
|
|
template <typename A0, …, typename A ## <strong>n</strong>>
|
|
<em>result type</em>
|
|
<strong>name</strong>(
|
|
A0& a0, …, A ## <strong>n</strong> & a ## <strong>n</strong>
|
|
, typename boost_param_parameters_ ## __LINE__ ## <strong
|
|
>name</strong>::match<
|
|
A0, …, A ## <strong>n</strong>
|
|
>::type = boost_param_parameters_ ## __LINE__ ## <strong
|
|
>name</strong>()
|
|
)
|
|
{
|
|
return boost_param_impl ## <strong>name</strong>(
|
|
boost_param_parameters_ ## __LINE__ ## <strong>name</strong>()(
|
|
a0, …, a ## <strong>n</strong>
|
|
)
|
|
);
|
|
}
|
|
|
|
<span class="vellipsis">⋮</span>
|
|
|
|
template <typename A0, …, typename A ## <strong>m</strong>>
|
|
<em>result type</em>
|
|
<strong>name</strong>(
|
|
A0 const& a0, …, A ## <strong>m</strong> const& ## ; a<strong
|
|
>m</strong>
|
|
, typename boost_param_parameters_ ## __LINE__ ## <strong
|
|
>name</strong>::match<
|
|
A0 const, …, A ## <strong>m</strong> const
|
|
>::type = boost_param_parameters_ ## __LINE__ ## <strong
|
|
>name</strong>()
|
|
)
|
|
{
|
|
return boost_param_impl ## <strong>name</strong>(
|
|
boost_param_parameters_ ## __LINE__ ## <strong>name</strong>()(
|
|
a0, …, a ## <strong>m</strong>
|
|
)
|
|
);
|
|
}
|
|
|
|
<em>… exponential number of overloads …</em>
|
|
<span class="vellipsis">⋮</span>
|
|
|
|
template <typename A0, …, typename A ## <strong>m</strong>>
|
|
<em>result type</em>
|
|
<strong>name</strong>(
|
|
A0& a0, …, A ## <strong>m</strong> & ## ; a<strong>m</strong>
|
|
, typename boost_param_parameters_ ## __LINE__ ## <strong
|
|
>name</strong>::match<
|
|
A0, …, A ## <strong>m</strong>
|
|
>::type = boost_param_parameters_ ## __LINE__ ## <strong
|
|
>name</strong>()
|
|
)
|
|
{
|
|
return boost_param_impl ## <strong>name</strong>(
|
|
boost_param_parameters_ ## __LINE__ ## <strong>name</strong>()(
|
|
a0, …, a ## <strong>m</strong>
|
|
)
|
|
);
|
|
}
|
|
|
|
template <
|
|
typename ResultType
|
|
, typename Args
|
|
, typename <em>argument name</em> ## <strong>0</strong> ## _type
|
|
, …
|
|
, typename <em>argument name</em> ## <strong>n</strong> ## _type
|
|
>
|
|
ResultType
|
|
boost_param_dispatch_0boost_ ## __LINE__ ## <strong>name</strong>(
|
|
(ResultType(*)())
|
|
, Args const& args
|
|
, <em>argument name</em> ## <strong>0</strong> ## _type& <em
|
|
>argument name</em> ## <strong>0</strong>
|
|
, …
|
|
, <em>argument name</em> ## <strong>n</strong> ## _type& <em
|
|
>argument name</em> ## <strong>n</strong>
|
|
);
|
|
|
|
<span class="vellipsis">⋮</span>
|
|
|
|
template <
|
|
typename ResultType
|
|
, typename Args
|
|
, typename <em>argument name</em> ## <strong>0</strong> ## _type
|
|
, …
|
|
, typename <em>argument name</em> ## <strong>m</strong> ## _type
|
|
>
|
|
ResultType
|
|
boost_param_dispatch_0boost_ ## __LINE__ ## <strong>name</strong>(
|
|
(ResultType(*)())
|
|
, Args const& args
|
|
, <em>argument name</em> ## <strong>0</strong> ## _type& <em
|
|
>argument name</em> ## <strong>0</strong>
|
|
, …
|
|
, <em>argument name</em> ## <strong>m</strong> ## _type& <em
|
|
>argument name</em> ## <strong>m</strong>
|
|
);
|
|
|
|
template <typename Args>
|
|
typename boost_param_result_ ## __LINE__ ## <strong
|
|
>name</strong><Args>::type
|
|
boost_param_impl ## <strong>name</strong>(Args const& args)
|
|
{
|
|
return boost_param_dispatch_0boost_ ## __LINE__ ## <strong>name</strong>(
|
|
static_cast<ResultType(*)()>(std::nullptr)
|
|
, args
|
|
, args[ <em>keyword object of required parameter</em> ## <strong
|
|
>0</strong>]
|
|
, …
|
|
, args[ <em>keyword object of required parameter</em> ## <strong
|
|
>n</strong>]
|
|
);
|
|
}
|
|
|
|
template <
|
|
typename ResultType
|
|
, typename Args
|
|
, typename <em>argument name</em> ## <strong>0</strong> ## _type
|
|
, …
|
|
, typename <em>argument name</em> ## <strong>n</strong> ## _type
|
|
>
|
|
ResultType
|
|
boost_param_dispatch_0boost_ ## __LINE__ ## <strong>name</strong>(
|
|
(ResultType(*)())
|
|
, Args const& args
|
|
, <em>argument name</em> ## <strong>0</strong> ## _type& <em
|
|
>argument name</em> ## <strong>0</strong>
|
|
, …
|
|
, <em>argument name</em> ## <strong>n</strong> ## _type& <em
|
|
>argument name</em> ## <strong>n</strong>
|
|
)
|
|
{
|
|
return boost_param_dispatch_0boost_ ## __LINE__ ## <strong>name</strong>(
|
|
static_cast<ResultType(*)()>(std::nullptr)
|
|
, (args, <em>keyword object of optional parameter</em> ## <strong
|
|
>n + 1</strong> =
|
|
<em>default value of optional parameter</em> ## <strong
|
|
>n + 1</strong>
|
|
)
|
|
, <em>argument name</em> ## <strong>0</strong>
|
|
, …
|
|
, <em>argument name</em> ## <strong>n</strong>
|
|
, <em>default value of optional parameter</em> ## <strong
|
|
>n + 1</strong>
|
|
);
|
|
}
|
|
|
|
<span class="vellipsis">⋮</span>
|
|
|
|
template <
|
|
typename ResultType
|
|
, typename Args
|
|
, typename <em>argument name</em> ## <strong>0</strong> ## _type
|
|
, …
|
|
, typename <em>argument name</em> ## <strong>m</strong> ## _type
|
|
>
|
|
ResultType
|
|
boost_param_dispatch_0boost_ ## __LINE__ ## <strong>name</strong>(
|
|
(ResultType(*)())
|
|
, Args const& args
|
|
, <em>argument name</em> ## <strong>0</strong> ## _type& <em
|
|
>argument name</em> ## <strong>0</strong>
|
|
, …
|
|
, <em>argument name</em> ## <strong>m</strong> ## _type& <em
|
|
>argument name</em> ## <strong>m</strong>
|
|
)
|
|
</pre>
|
|
</dd>
|
|
</dl>
|
|
<p>The <a class="reference external" href="../../test/preprocessor.cpp"
|
|
>test/preprocessor.cpp</a>, <a class="reference external"
|
|
href="../../test/preprocessor_deduced.cpp">test/preprocessor_deduced.cpp</a>,
|
|
and <a class="reference external"
|
|
href="../../test/preprocessor_eval_category.cpp"
|
|
>test/preprocessor_eval_category.cpp</a> test programs demonstrate proper
|
|
usage of this macro.</p>
|
|
</div>
|
|
<div class="section"
|
|
id="boost-parameter-member-function-result-name-tag-namespace-arguments">
|
|
<h2><a class="toc-backref" href="#id52">6.2 <tt
|
|
class="docutils literal">BOOST_PARAMETER_MEMBER_FUNCTION(result, name,
|
|
tag_namespace, arguments)</tt></a></h2>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Defined in:</th>
|
|
<td class="field-body"><a class="reference external"
|
|
href="../../../../boost/parameter/preprocessor.hpp"
|
|
>boost/parameter/preprocessor.hpp</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Same as <a class="reference internal"
|
|
href="#boost-parameter-function-result-name-tag-namespace-arguments"
|
|
><tt class="docutils literal">BOOST_PARAMETER_FUNCTION</tt></a>, except:</p>
|
|
<ul>
|
|
<li><tt class="docutils literal">name</tt> may be qualified by the
|
|
<tt class="docutils literal">static</tt> keyword to declare the member
|
|
function and its helpers as not associated with any object of the enclosing
|
|
type.</li>
|
|
<li>Expansion of this macro omits all forward declarations of the front-end
|
|
implementation and dispatch functions.</li>
|
|
</ul>
|
|
<p>The <a class="reference external" href="../../test/preprocessor.cpp"
|
|
>test/preprocessor.cpp</a> and <a class="reference external"
|
|
href="../../test/preprocessor_eval_category.cpp"
|
|
>test/preprocessor_eval_category.cpp</a> test programs demonstrate proper
|
|
usage of this macro.</p>
|
|
</div>
|
|
<div class="section"
|
|
id="boost-parameter-c-mem-function-result-name-tag-namespace-arguments">
|
|
<h2><a class="toc-backref" href="#id53">6.3 <tt
|
|
class="docutils literal">BOOST_PARAMETER_CONST_MEMBER_FUNCTION(result, name,
|
|
tag_namespace, arguments)</tt></a></h2>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Defined in:</th>
|
|
<td class="field-body"><a class="reference external"
|
|
href="../../../../boost/parameter/preprocessor.hpp"
|
|
>boost/parameter/preprocessor.hpp</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Same as <a class="reference internal"
|
|
href="#boost-parameter-member-function-result-name-tag-namespace-arguments"
|
|
><tt class="docutils literal">BOOST_PARAMETER_MEMBER_FUNCTION</tt></a>,
|
|
except that the overloaded forwarding member functions and their helper
|
|
methods are <tt class="docutils literal">const</tt>-qualified.</p>
|
|
<p>The <a class="reference external" href="../../test/preprocessor.cpp"
|
|
>test/preprocessor.cpp</a> test program demonstrates proper usage of this
|
|
macro.</p>
|
|
</div>
|
|
<div class="section"
|
|
id="boost-parameter-function-call-op-result-tag-namespace-arguments">
|
|
<h2><a class="toc-backref" href="#id54">6.4 <tt
|
|
class="docutils literal">BOOST_PARAMETER_FUNCTION_CALL_OPERATOR(result,
|
|
tag_ns, arguments)</tt></a></h2>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Defined in:</th>
|
|
<td class="field-body"><a class="reference external"
|
|
href="../../../../boost/parameter/preprocessor.hpp"
|
|
>boost/parameter/preprocessor.hpp</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Same as <a class="reference internal"
|
|
href="#boost-parameter-member-function-result-name-tag-namespace-arguments"
|
|
><tt class="docutils literal">BOOST_PARAMETER_MEMBER_FUNCTION</tt></a>,
|
|
except that the name of the forwarding member function overloads is
|
|
<tt class="docutils literal">operator()</tt>.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name" colspan="2">Generated names in enclosing scope:</th>
|
|
</tr>
|
|
<tr>
|
|
<td> </td>
|
|
<td class="field-body">
|
|
<ul class="first last simple">
|
|
<li><tt class="docutils literal">boost_param_result_ ## __LINE__ ##
|
|
operator</tt></li>
|
|
<li><tt class="docutils literal">boost_param_params_ ## __LINE__ ##
|
|
operator</tt></li>
|
|
<li><tt class="docutils literal">boost_param_parameters_ ## __LINE__ ##
|
|
operator</tt></li>
|
|
<li><tt class="docutils literal">boost_param_impl ## operator</tt></li>
|
|
<li><tt class="docutils literal">boost_param_dispatch_0boost_ ## __LINE__ ##
|
|
operator</tt></li>
|
|
<li><tt class="docutils literal">boost_param_dispatch_1boost_ ## __LINE__ ##
|
|
operator</tt></li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>The <a class="reference external" href="../../test/preprocessor.cpp"
|
|
>test/preprocessor.cpp</a> test program demonstrates proper usage of this
|
|
macro.</p>
|
|
</div>
|
|
<div class="section"
|
|
id="boost-parameter-const-function-call-op-result-tag-namespace-arguments">
|
|
<h2><a class="toc-backref" href="#id55">6.5 <tt
|
|
class="docutils literal">BOOST_PARAMETER_CONST_FUNCTION_CALL_OPERATOR(result,
|
|
tag_ns, arguments)</tt></a></h2>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Defined in:</th>
|
|
<td class="field-body"><a class="reference external"
|
|
href="../../../../boost/parameter/preprocessor.hpp"
|
|
>boost/parameter/preprocessor.hpp</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Same as <a class="reference internal"
|
|
href="#boost-parameter-function-call-op-result-tag-namespace-arguments"
|
|
><tt class="docutils literal">BOOST_PARAMETER_FUNCTION_CALL_OPERATOR</tt></a>,
|
|
except that the overloaded function call operators and their helper methods
|
|
are <tt class="docutils literal">const</tt>-qualified.</p>
|
|
<p>The <a class="reference external" href="../../test/preprocessor.cpp"
|
|
>test/preprocessor.cpp</a> and <a class="reference external"
|
|
href="../../test/preprocessor_eval_cat_8.cpp"
|
|
>test/preprocessor_eval_cat_8.cpp</a> test programs demonstrate proper usage
|
|
of this macro.</p>
|
|
</div>
|
|
<div class="section"
|
|
id="boost-parameter-constructor-cls-impl-tag-namespace-arguments">
|
|
<h2><a class="toc-backref" href="#id56">6.6 <tt
|
|
class="docutils literal">BOOST_PARAMETER_CONSTRUCTOR(cls, impl, tag_namespace,
|
|
arguments)</tt></a></h2>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Defined in:</th>
|
|
<td class="field-body"><a class="reference external"
|
|
href="../../../../boost/parameter/preprocessor.hpp"
|
|
>boost/parameter/preprocessor.hpp</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name" colspan="2">Requires:</th>
|
|
</tr>
|
|
<tr>
|
|
<td> </td>
|
|
<td class="field-body">
|
|
<p class="first"><tt class="docutils literal">cls</tt> is the name of this
|
|
class. <tt class="docutils literal">impl</tt> is the parenthesized
|
|
implementation base class for <tt class="docutils literal"
|
|
>cls</tt>. <tt class="docutils literal">tag_namespace</tt> is the namespace
|
|
in which the keywords used by the function resides. <tt
|
|
class="docutils literal">arguments</tt> is a list of
|
|
<em>argument-specifiers</em>, as defined in <a class="reference internal"
|
|
href="#boost-parameter-function-result-name-tag-namespace-arguments"
|
|
><tt class="docutils literal">BOOST_PARAMETER_FUNCTION</tt></a> except that
|
|
<em>optional-specifier</em> no longer includes <em>default-value</em>. It is
|
|
up to the delegate constructor in <tt class="docutils literal">impl</tt> to
|
|
determine the default value of all optional arguments.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field">
|
|
<th class="field-name" colspan="2">Generated names in enclosing scope:</th>
|
|
</tr>
|
|
<tr>
|
|
<td> </td>
|
|
<td class="field-body">
|
|
<ul class="first last simple">
|
|
<li><tt class="docutils literal">boost_param_params_ ## __LINE__ ##
|
|
ctor</tt></li>
|
|
<li><tt class="docutils literal">constructor_parameters ## __LINE__</tt></li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="docutils">
|
|
<dt>Approximate expansion:</dt>
|
|
<dd>
|
|
<p class="first"><strong>Where</strong>:</p>
|
|
<ul class="simple">
|
|
<li><tt class="docutils literal">n</tt> denotes the <em>minimum</em> arity, as
|
|
determined from <tt class="docutils literal">arguments</tt>.</li>
|
|
<li><tt class="docutils literal">m</tt> denotes the <em>maximum</em> arity, as
|
|
determined from <tt class="docutils literal">arguments</tt>.</li>
|
|
</ul>
|
|
<p><strong>If</strong> <a class="reference internal"
|
|
href="#boost-parameter-has-perfect-forwarding"><tt class="docutils literal"
|
|
>BOOST_PARAMETER_HAS_PERFECT_FORWARDING</tt></a> is
|
|
<tt class="docutils literal">#defined</tt>, <strong>then</strong>:</p>
|
|
<pre class="last literal-block">
|
|
struct boost_param_params_ ## __LINE__ ## ctor
|
|
: boost::parameter::parameters<
|
|
<em>list of parameter specifications, based on arguments</em>
|
|
>
|
|
{
|
|
};
|
|
|
|
typedef boost_param_params_ ## __LINE__ ## <strong>name</strong>
|
|
constructor_parameters ## __LINE__;
|
|
|
|
template <typename A0, …, typename A ## <strong>n</strong>>
|
|
<em>cls</em>(A0&& a0, …, A ## <strong
|
|
>n</strong> && a ## <strong>n</strong>)
|
|
: <em>impl</em>(
|
|
constructor_parameters ## __LINE__(
|
|
std::<a class="reference external"
|
|
href="http://en.cppreference.com/w/cpp/utility/forward"><tt
|
|
class="docutils literal">forward</tt></a><A0>(a0)
|
|
, …
|
|
, std::<a class="reference external"
|
|
href="http://en.cppreference.com/w/cpp/utility/forward"><tt
|
|
class="docutils literal">forward</tt></a><A ## <strong
|
|
>n</strong>>(a ## <strong>n</strong>)
|
|
)
|
|
)
|
|
{
|
|
}
|
|
|
|
<span class="vellipsis">⋮</span>
|
|
|
|
template <typename A0, …, typename A ## <strong>m</strong>>
|
|
<em>cls</em>(A0&& a0, …, A ## <strong
|
|
>m</strong>&& a ## <strong>m</strong>)
|
|
: <em>impl</em>(
|
|
constructor_parameters ## __LINE__(
|
|
std::<a class="reference external"
|
|
href="http://en.cppreference.com/w/cpp/utility/forward"><tt
|
|
class="docutils literal">forward</tt></a><A0>(a0)
|
|
, …
|
|
, std::<a class="reference external"
|
|
href="http://en.cppreference.com/w/cpp/utility/forward"><tt
|
|
class="docutils literal">forward</tt></a><A ## <strong
|
|
>m</strong>>(a ## <strong>m</strong>)
|
|
)
|
|
)
|
|
{
|
|
}
|
|
</pre>
|
|
<p><strong>If</strong> <a class="reference internal"
|
|
href="#boost-parameter-has-perfect-forwarding"><tt class="docutils literal"
|
|
>BOOST_PARAMETER_HAS_PERFECT_FORWARDING</tt></a> is <strong>not</strong>
|
|
<tt class="docutils literal">#defined</tt>, <strong>then</strong>:</p>
|
|
<pre class="last literal-block">
|
|
struct boost_param_params_ ## __LINE__ ## ctor
|
|
: boost::parameter::parameters<
|
|
<em>list of parameter specifications, based on arguments</em>
|
|
>
|
|
{
|
|
};
|
|
|
|
typedef boost_param_params_ ## __LINE__ ## <strong>name</strong>
|
|
constructor_parameters ## __LINE__;
|
|
|
|
template <typename A0, …, typename A ## <strong>n</strong>>
|
|
<em>cls</em>(A0 const& a0, …, A ## <strong
|
|
>n</strong> const& a ## <strong>n</strong>)
|
|
: <em>impl</em>(constructor_parameters ## __LINE__(a0, …, a ## <strong
|
|
>n</strong>))
|
|
{
|
|
}
|
|
|
|
<em>… exponential number of overloads …</em>
|
|
<span class="vellipsis">⋮</span>
|
|
|
|
template <typename A0, …, typename A ## <strong>n</strong>>
|
|
<em>cls</em>(A0& a0, …, A ## <strong
|
|
>n</strong> & a ## <strong>n</strong>)
|
|
: <em>impl</em>(constructor_parameters ## __LINE__(a0, …, a ## <strong
|
|
>n</strong>))
|
|
{
|
|
}
|
|
|
|
<span class="vellipsis">⋮</span>
|
|
|
|
template <typename A0, …, typename A ## <strong>m</strong>>
|
|
<em>cls</em>(A0 const& a0, …, A ## <strong
|
|
>m</strong> const& a ## <strong>m</strong>)
|
|
: <em>impl</em>(constructor_parameters ## __LINE__(a0, …, a ## <strong
|
|
>m</strong>))
|
|
{
|
|
}
|
|
|
|
<em>… exponential number of overloads …</em>
|
|
<span class="vellipsis">⋮</span>
|
|
|
|
template <typename A0, …, typename A ## <strong>m</strong>>
|
|
<em>cls</em>(A0& a0, …, A ## <strong
|
|
>m</strong> & a ## <strong>m</strong>)
|
|
: <em>impl</em>(constructor_parameters ## __LINE__(a0, …, a ## <strong
|
|
>m</strong>))
|
|
{
|
|
}
|
|
</pre>
|
|
</dd>
|
|
</dl>
|
|
<p>The <a class="reference external" href="../../test/preprocessor.cpp"
|
|
>test/preprocessor.cpp</a> and <a class="reference external"
|
|
href="../../test/preprocessor_eval_category.cpp"
|
|
>test/preprocessor_eval_category.cpp</a> test programs demonstrate proper
|
|
usage of this macro.</p>
|
|
</div>
|
|
<div class="section"
|
|
id="boost-parameter-basic-function-result-name-tag-namespace-arguments">
|
|
<h2><a class="toc-backref" href="#id57">6.7 <tt
|
|
class="docutils literal">BOOST_PARAMETER_BASIC_FUNCTION(result, name,
|
|
tag_namespace, arguments)</tt></a></h2>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Defined in:</th>
|
|
<td class="field-body"><a class="reference external"
|
|
href="../../../../boost/parameter/preprocessor.hpp"
|
|
>boost/parameter/preprocessor.hpp</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Same as <a class="reference internal"
|
|
href="#boost-parameter-function-result-name-tag-namespace-arguments"
|
|
><tt class="docutils literal">BOOST_PARAMETER_FUNCTION</tt></a>, except:</p>
|
|
<ul>
|
|
<li>For the argument specifiers syntax, <em>optional-specifier</em> no longer
|
|
includes <em>default-value</em>. It is up to the function body to determine
|
|
the default value of all optional arguments.</li>
|
|
<li>Generated names in the enclosing scope no longer include
|
|
<tt class="docutils literal">boost_param_dispatch_0boost_ ## __LINE__ ##
|
|
name</tt> or <tt class="docutils literal">boost_param_dispatch_1boost_ ##
|
|
__LINE__ ## name</tt>.</li>
|
|
<li>Expansion of this macro omits all overloads of <tt
|
|
class="docutils literal">boost_param_dispatch_0boost_ ## __LINE__ ## name</tt>
|
|
and <tt class="docutils literal">boost_param_dispatch_1boost_ ## __LINE__ ##
|
|
name</tt> and stops at the header of <tt class="docutils literal"
|
|
>boost_param_impl ## name</tt>. Therefore, only the <a
|
|
class="reference internal" href="#argumentpack"><span class="concept"
|
|
>ArgumentPack</span></a> type <tt class="docutils literal">Args</tt> and its
|
|
object instance <tt class="docutils literal">args</tt> are available for use
|
|
within the function body.</li>
|
|
</ul>
|
|
<p>The <a class="reference external" href="../../test/preprocessor.cpp"
|
|
>test/preprocessor.cpp</a> test program demonstrates proper usage of this
|
|
macro.</p>
|
|
</div>
|
|
<div class="section"
|
|
id="boost-parameter-basic-member-function-result-name-tag-ns-arguments">
|
|
<h2><a class="toc-backref" href="#id58">6.8 <tt
|
|
class="docutils literal">BOOST_PARAMETER_BASIC_MEMBER_FUNCTION(result, name,
|
|
tag_namespace, arguments)</tt></a></h2>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Defined in:</th>
|
|
<td class="field-body"><a class="reference external"
|
|
href="../../../../boost/parameter/preprocessor.hpp"
|
|
>boost/parameter/preprocessor.hpp</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Same as <a class="reference internal"
|
|
href="#boost-parameter-basic-function-result-name-tag-namespace-arguments"
|
|
><tt class="docutils literal">BOOST_PARAMETER_BASIC_FUNCTION</tt></a>,
|
|
except that:</p>
|
|
<ul>
|
|
<li><tt class="docutils literal">name</tt> may be qualified by the
|
|
<tt class="docutils literal">static</tt> keyword to declare the member
|
|
function and its helpers as not associated with any object of the enclosing
|
|
type.</li>
|
|
<li>Expansion of this macro omits the forward declaration of the
|
|
implementation function.</li>
|
|
</ul>
|
|
<p>The <a class="reference external" href="../../test/preprocessor.cpp"
|
|
>test/preprocessor.cpp</a> test program demonstrates proper usage of this
|
|
macro.</p>
|
|
</div>
|
|
<div class="section"
|
|
id="boost-parameter-basic-c-mem-function-result-name-tag-ns-arguments">
|
|
<h2><a class="toc-backref" href="#id59">6.9 <tt
|
|
class="docutils literal">BOOST_PARAMETER_BASIC_CONST_MEMBER_FUNCTION(result,
|
|
name, tag_namespace, arguments)</tt></a></h2>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Defined in:</th>
|
|
<td class="field-body"><a class="reference external"
|
|
href="../../../../boost/parameter/preprocessor.hpp"
|
|
>boost/parameter/preprocessor.hpp</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Same as <a class="reference internal"
|
|
href="#boost-parameter-basic-member-function-result-name-tag-ns-arguments"
|
|
><tt class="docutils literal">BOOST_PARAMETER_BASIC_MEMBER_FUNCTION</tt></a>,
|
|
except that the overloaded forwarding member functions and their helper
|
|
methods are <tt class="docutils literal">const</tt>-qualified.</p>
|
|
<p>The <a class="reference external" href="../../test/preprocessor.cpp"
|
|
>test/preprocessor.cpp</a> test program demonstrates proper usage of this
|
|
macro.</p>
|
|
</div>
|
|
<div class="section" id="boost-parameter-name-name">
|
|
<h2><a class="toc-backref" href="#id60">6.10 <tt
|
|
class="docutils literal">BOOST_PARAMETER_NAME(name)</tt></a></h2>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Defined in:</th>
|
|
<td class="field-body"><a class="reference external"
|
|
href="../../../../boost/parameter/name.hpp">boost/parameter/name.hpp</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Declares a tag-type and keyword object.</p>
|
|
<p><strong>If</strong> <em>name</em> is of the form:</p>
|
|
<pre class="literal-block">
|
|
(<em>object-name</em>, <em>namespace-name</em>) <em>qualifier</em>(<em
|
|
>tag-name</em>)
|
|
</pre>
|
|
<p><strong>then</strong></p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Requires:</th>
|
|
<td class="field-body">
|
|
<p class="first"><em>qualifier</em> is either <tt class="docutils literal"
|
|
>in</tt>, <tt class="docutils literal">out</tt>, <tt class="docutils literal"
|
|
>in_out</tt>, <tt class="docutils literal">consume</tt>, <tt
|
|
class="docutils literal">move_from</tt>, or <tt class="docutils literal"
|
|
>forward</tt>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Expands to:</p>
|
|
<pre class="literal-block">
|
|
namespace <em>namespace-name</em> {
|
|
|
|
struct <em>tag-name</em>
|
|
{
|
|
static char const* keyword_name()
|
|
{
|
|
return ##<em>tag-name</em>;
|
|
}
|
|
|
|
typedef <em>unspecified</em> _;
|
|
typedef <em>unspecified</em> _1;
|
|
typedef boost::parameter::<em>qualifier</em> ## _reference qualifier;
|
|
};
|
|
}
|
|
|
|
::boost::parameter::keyword<<em>tag-namespace</em>::<em
|
|
>tag-name</em>> const&
|
|
<em>object-name</em> = ::boost::parameter::keyword<
|
|
<em>tag-namespace</em>::<em>tag-name</em>
|
|
>::instance;
|
|
</pre>
|
|
<p><strong>Else If</strong> <em>name</em> is of the form:</p>
|
|
<pre class="literal-block">
|
|
(<em>object-name</em>, <em>namespace-name</em>) <em>tag-name</em>
|
|
</pre>
|
|
<p><strong>then</strong></p>
|
|
<p>Treats <em>name</em> as if it were of the form:</p>
|
|
<pre class="literal-block">
|
|
(<em>object-name</em>, <em>namespace-name</em>) forward(<em>tag-name</em>)
|
|
</pre>
|
|
<p><strong>Else If</strong> <em>name</em> is of the form:</p>
|
|
<pre class="literal-block">
|
|
<em>qualifier</em>(<em>tag-name</em>)
|
|
</pre>
|
|
<p><strong>then</strong></p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Requires:</th>
|
|
<td class="field-body">
|
|
<p class="first"><em>qualifier</em> is either <tt class="docutils literal"
|
|
>in</tt>, <tt class="docutils literal">out</tt>, <tt class="docutils literal"
|
|
>in_out</tt>, <tt class="docutils literal">consume</tt>, <tt
|
|
class="docutils literal">move_from</tt>, or <tt class="docutils literal"
|
|
>forward</tt>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Expands to:</p>
|
|
<pre class="literal-block">
|
|
namespace tag {
|
|
|
|
struct <em>tag-name</em>
|
|
{
|
|
static char const* keyword_name()
|
|
{
|
|
return ##<em>tag-name</em>;
|
|
}
|
|
|
|
typedef <em>unspecified</em> _;
|
|
typedef <em>unspecified</em> _1;
|
|
typedef boost::parameter::<em>qualifier</em> ## _reference qualifier;
|
|
};
|
|
}
|
|
|
|
::boost::parameter::keyword<tag::<em>tag-name</em>> const& _ ## <em
|
|
>tag-name</em>
|
|
= ::boost::parameter::keyword<tag::<em>tag-name</em>>::instance;
|
|
</pre>
|
|
<p><strong>Else</strong></p>
|
|
<p>Treats <em>name</em> as if it were of the form:</p>
|
|
<pre class="literal-block">
|
|
forward(<em>tag-name</em>)
|
|
</pre>
|
|
</div>
|
|
<div class="section" id="boost-parameter-nested-keyword-t-n-a">
|
|
<h2><a class="toc-backref" href="#id61">6.11 <tt
|
|
class="docutils literal">BOOST_PARAMETER_NESTED_KEYWORD(tag_namespace, name,
|
|
alias)</tt></a></h2>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Defined in:</th>
|
|
<td class="field-body"><a class="reference external"
|
|
href="../../../../boost/parameter/nested_keyword.hpp"
|
|
>boost/parameter/nested_keyword.hpp</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Declares a tag-type, a keyword object, and an alias for that object nested
|
|
in the tag-type.</p>
|
|
<p><strong>If</strong> <em>name</em> is of the form:</p>
|
|
<pre class="literal-block">
|
|
<em>qualifier</em>(<em>tag-name</em>)
|
|
</pre>
|
|
<p><strong>then</strong></p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Requires:</th>
|
|
<td class="field-body">
|
|
<p class="first"><em>qualifier</em> is either <tt class="docutils literal"
|
|
>in</tt>, <tt class="docutils literal">out</tt>, <tt class="docutils literal"
|
|
>in_out</tt>, <tt class="docutils literal">consume</tt>, <tt
|
|
class="docutils literal">move_from</tt>, or <tt class="docutils literal"
|
|
>forward</tt>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Expands to:</p>
|
|
<pre class="literal-block">
|
|
namespace tag {
|
|
|
|
struct <em>tag-name</em>
|
|
{
|
|
static char const* keyword_name()
|
|
{
|
|
return ##<em>tag-name</em>;
|
|
}
|
|
|
|
typedef <em>unspecified</em> _;
|
|
typedef <em>unspecified</em> _1;
|
|
typedef boost::parameter::<em>qualifier</em> ## _reference qualifier;
|
|
static ::boost::parameter::keyword<<em>tag-name</em>> const& <em
|
|
>alias</em>;
|
|
};
|
|
|
|
::boost::parameter::keyword<<em>tag-name</em>> const& <em
|
|
>tag-name</em>::<em>alias</em>
|
|
= ::boost::parameter::keyword<<em>tag-name</em>>::instance;
|
|
}
|
|
|
|
::boost::parameter::keyword<tag::<em>tag-name</em>> const& _ ## <em
|
|
>tag-name</em>
|
|
= ::boost::parameter::keyword<tag::<em>tag-name</em>>::instance;
|
|
</pre>
|
|
<p><strong>Else</strong></p>
|
|
<p>Treats <em>name</em> as if it were of the form:</p>
|
|
<pre class="literal-block">
|
|
forward(<em>tag-name</em>)
|
|
</pre>
|
|
</div>
|
|
<div class="section" id="boost-parameter-template-keyword-name">
|
|
<h2><a class="toc-backref" href="#id62">6.12 <tt
|
|
class="docutils literal">BOOST_PARAMETER_TEMPLATE_KEYWORD(name)</tt></a></h2>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Defined in:</th>
|
|
<td class="field-body"><a class="reference external"
|
|
href="../../../../boost/parameter/template_keyword.hpp"
|
|
>boost/parameter/template_keyword.hpp</a></td>
|
|
</tr>
|
|
<tr class="field">
|
|
<th class="field-name">Included by:</th>
|
|
<td class="field-body"><a class="reference external"
|
|
href="../../../../boost/parameter/name.hpp">boost/parameter/name.hpp</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Expands to:</p>
|
|
<pre class="literal-block">
|
|
namespace tag {
|
|
|
|
struct <em>name</em>;
|
|
}
|
|
|
|
template <typename T>
|
|
struct <em>name</em>
|
|
: ::boost::parameter::template_keyword<tag::<em>name</em>, T>
|
|
{
|
|
};
|
|
</pre>
|
|
<p>The <a class="reference external"
|
|
href="../../test/function_type_tpl_param.cpp"
|
|
>test/function_type_tpl_param.cpp</a> test program demonstrates proper usage
|
|
of this macro.</p>
|
|
</div>
|
|
<div class="section" id="boost-parameter-fun-r-n-l-h-p">
|
|
<h2><a class="toc-backref" href="#id63">6.13 <tt
|
|
class="docutils literal">BOOST_PARAMETER_FUN(r, n, l, h, p)</tt></a></h2>
|
|
<div class="admonition-deprecated admonition">
|
|
<p class="first admonition-title">Deprecated</p>
|
|
<p class="last">This macro has been deprecated in favor of
|
|
<a class="reference internal"
|
|
href="#boost-parameter-function-result-name-tag-namespace-arguments"
|
|
><tt class="docutils literal">BOOST_PARAMETER_FUNCTION</tt></a>.</p>
|
|
</div>
|
|
<p>Generates a sequence of <a class="reference external"
|
|
href="index.html#forwarding-functions">forwarding function</a> templates named
|
|
<tt class="docutils literal">n</tt>, with arities ranging from
|
|
<tt class="docutils literal">l</tt> to <tt class="docutils literal">h</tt>,
|
|
returning <tt class="docutils literal">r</tt>, and using
|
|
<tt class="docutils literal">p</tt> to control overload resolution and assign
|
|
tags to positional arguments.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Defined in:</th>
|
|
<td class="field-body"><a class="reference external"
|
|
href="../../../../boost/parameter/macros.hpp"
|
|
>boost/parameter/macros.hpp</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Requires:</th>
|
|
<td class="field-body"><tt class="docutils literal">l</tt> and <tt
|
|
class="docutils literal">h</tt> are nonnegative integer tokens such that <tt
|
|
class="docutils literal">l</tt> < <tt class="docutils literal">h</tt></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>If</strong> <a class="reference internal"
|
|
href="#boost-parameter-has-perfect-forwarding"><tt class="docutils literal"
|
|
>BOOST_PARAMETER_HAS_PERFECT_FORWARDING</tt></a> is
|
|
<tt class="docutils literal">#defined</tt>, <strong>then</strong>:</p>
|
|
<dl class="docutils">
|
|
<dt>Expands to:</dt>
|
|
<dd>
|
|
<pre class="first last literal-block">
|
|
template <typename A1, typename A2, …, typename A ## <strong>l</strong>>
|
|
r
|
|
name(
|
|
A1&& a1, A2&& a2, …, A ## <strong
|
|
>l</strong> && a ## <strong>l</strong>
|
|
, typename <strong>p</strong>::match<A1, A2, …, A ## <strong
|
|
>l</strong>>::type pk = <strong>p</strong>()
|
|
)
|
|
{
|
|
return <strong>name</strong>_with_named_params(
|
|
pk(
|
|
std::<a class="reference external"
|
|
href="http://en.cppreference.com/w/cpp/utility/forward"><tt
|
|
class="docutils literal">forward</tt></a><A1>(a1)
|
|
, std::<a class="reference external"
|
|
href="http://en.cppreference.com/w/cpp/utility/forward"><tt
|
|
class="docutils literal">forward</tt></a><A2>(a2)
|
|
, …
|
|
, std::<a class="reference external"
|
|
href="http://en.cppreference.com/w/cpp/utility/forward"><tt
|
|
class="docutils literal">forward</tt></a><A ## <strong
|
|
>l</strong>>(a ## <strong>l</strong>)
|
|
)
|
|
);
|
|
}
|
|
|
|
template <
|
|
typename A1
|
|
, typename A2
|
|
, …
|
|
, typename A ## <strong>l</strong>
|
|
, typename A ## <a class="reference external"
|
|
href="../../../preprocessor/doc/ref/inc.html">BOOST_PP_INC</a>(<strong
|
|
>l</strong>)
|
|
>
|
|
r
|
|
name(
|
|
A1&& a1, A2&& a2, …, A ## <strong
|
|
>l</strong> && a ## <strong>l</strong>
|
|
, A ## <a class="reference external"
|
|
href="../../../preprocessor/doc/ref/inc.html">BOOST_PP_INC</a>(<strong
|
|
>l</strong>) && a ## <a class="reference external"
|
|
href="../../../preprocessor/doc/ref/inc.html">BOOST_PP_INC</a>(<strong
|
|
>l</strong>)
|
|
, typename <strong>p</strong>::match<A1, A2, …, A<strong
|
|
>l</strong>, A ## <a class="reference external"
|
|
href="../../../preprocessor/doc/ref/inc.html">BOOST_PP_INC</a>(<strong
|
|
>l</strong>)>::type pk = <strong>p</strong>())
|
|
{
|
|
return <strong>name</strong>_with_named_params(
|
|
pk(
|
|
std::<a class="reference external"
|
|
href="http://en.cppreference.com/w/cpp/utility/forward"><tt
|
|
class="docutils literal">forward</tt></a><A1>(a1)
|
|
, std::<a class="reference external"
|
|
href="http://en.cppreference.com/w/cpp/utility/forward"><tt
|
|
class="docutils literal">forward</tt></a><A2>(a2)
|
|
, …
|
|
, std::<a class="reference external"
|
|
href="http://en.cppreference.com/w/cpp/utility/forward"><tt
|
|
class="docutils literal">forward</tt></a><A ## <strong
|
|
>l</strong>>(a ## <strong>l</strong>)
|
|
, std::<a class="reference external"
|
|
href="http://en.cppreference.com/w/cpp/utility/forward"><tt
|
|
class="docutils literal">forward</tt></a><A ## <a
|
|
class="reference external" href="../../../preprocessor/doc/ref/inc.html"
|
|
>BOOST_PP_INC</a>(<strong>l</strong>)>(a ## <a class="reference external"
|
|
href="../../../preprocessor/doc/ref/inc.html">BOOST_PP_INC</a>(<strong
|
|
>l</strong>))
|
|
)
|
|
);
|
|
}
|
|
|
|
<span class="vellipsis">⋮</span>
|
|
|
|
template <typename A1, typename A2, …, typename A ## <strong>h</strong>>
|
|
r
|
|
name(
|
|
A1&& a1, A2&& a2, …, A ## <strong
|
|
>h</strong> && a ## <strong>h</strong>
|
|
, typename <strong>p</strong>::match<A1, A2, …, A ## <strong
|
|
>h</strong>>::type pk = <strong>p</strong>()
|
|
)
|
|
{
|
|
return <strong>name</strong>_with_named_params(
|
|
pk(
|
|
std::<a class="reference external"
|
|
href="http://en.cppreference.com/w/cpp/utility/forward"><tt
|
|
class="docutils literal">forward</tt></a><A1>(a1)
|
|
, std::<a class="reference external"
|
|
href="http://en.cppreference.com/w/cpp/utility/forward"><tt
|
|
class="docutils literal">forward</tt></a><A2>(a2)
|
|
, …
|
|
, std::<a class="reference external"
|
|
href="http://en.cppreference.com/w/cpp/utility/forward"><tt
|
|
class="docutils literal">forward</tt></a><A ## <strong
|
|
>h</strong>>(a ## <strong>h</strong>)
|
|
)
|
|
);
|
|
}
|
|
</pre>
|
|
</dd>
|
|
</dl>
|
|
<p><strong>If</strong> <a class="reference internal"
|
|
href="#boost-parameter-has-perfect-forwarding"><tt class="docutils literal"
|
|
>BOOST_PARAMETER_HAS_PERFECT_FORWARDING</tt></a> is <strong>not</strong>
|
|
<tt class="docutils literal">#defined</tt>, <strong>then</strong>:</p>
|
|
<dl class="docutils">
|
|
<dt>Expands to:</dt>
|
|
<dd>
|
|
<pre class="first last literal-block">
|
|
template <typename A1, typename A2, …, typename A ## <strong>l</strong>>
|
|
r
|
|
name(
|
|
A1 const& a1, A2 const& a2, …, A ## <strong
|
|
>l</strong> const& a ## <strong>l</strong>
|
|
, typename <strong>p</strong>::match<A1, A2, …, A ## <strong
|
|
>l</strong>>::type pk = <strong>p</strong>()
|
|
)
|
|
{
|
|
return <strong>name</strong>_with_named_params(pk(a1, a2, …, a ## <strong
|
|
>l</strong>));
|
|
}
|
|
|
|
<em>… exponential number of overloads …</em>
|
|
<span class="vellipsis">⋮</span>
|
|
|
|
template <typename A1, typename A2, …, typename A ## <strong>l</strong>>
|
|
r
|
|
name(
|
|
A1& a1, A2& a2, …, A ## <strong
|
|
>l</strong> & a ## <strong>l</strong>
|
|
, typename <strong>p</strong>::match<A1, A2, …, A ## <strong
|
|
>l</strong>>::type pk = <strong>p</strong>()
|
|
)
|
|
{
|
|
return <strong>name</strong>_with_named_params(pk(a1, a2, …, a ## <strong
|
|
>l</strong>));
|
|
}
|
|
|
|
template <
|
|
typename A1
|
|
, typename A2
|
|
, …
|
|
, typename A ## <strong>l</strong>
|
|
, typename A ## <a class="reference external"
|
|
href="../../../preprocessor/doc/ref/inc.html">BOOST_PP_INC</a>(<strong
|
|
>l</strong>)
|
|
>
|
|
r
|
|
name(
|
|
A1 const& a1, A2 const& a2, …, A ## <strong
|
|
>l</strong> const& a ## <strong>l</strong>
|
|
, A ## <a class="reference external"
|
|
href="../../../preprocessor/doc/ref/inc.html">BOOST_PP_INC</a>(<strong
|
|
>l</strong>) const& a ## <a class="reference external"
|
|
href="../../../preprocessor/doc/ref/inc.html">BOOST_PP_INC</a>(<strong
|
|
>l</strong>)
|
|
, typename <strong>p</strong>::match<A1, A2, …, A<strong
|
|
>l</strong>, A ## <a class="reference external"
|
|
href="../../../preprocessor/doc/ref/inc.html">BOOST_PP_INC</a>(<strong
|
|
>l</strong>)>::type pk = <strong>p</strong>()
|
|
)
|
|
{
|
|
return <strong>name</strong>_with_named_params(
|
|
pk(a1, a2, …, a ## <strong>l</strong>, a ## <a
|
|
class="reference external" href="../../../preprocessor/doc/ref/inc.html"
|
|
>BOOST_PP_INC</a>(<strong>l</strong>))
|
|
);
|
|
}
|
|
|
|
<em>… exponential number of overloads …</em>
|
|
<span class="vellipsis">⋮</span>
|
|
|
|
template <
|
|
typename A1
|
|
, typename A2
|
|
, …
|
|
, typename A ## <strong>l</strong>
|
|
, typename A ## <a class="reference external"
|
|
href="../../../preprocessor/doc/ref/inc.html">BOOST_PP_INC</a>(<strong
|
|
>l</strong>)
|
|
>
|
|
r
|
|
name(
|
|
A1& a1, A2& a2, …, A ## <strong
|
|
>l</strong> & a ## <strong>l</strong>
|
|
, A ## <a class="reference external"
|
|
href="../../../preprocessor/doc/ref/inc.html">BOOST_PP_INC</a>(<strong
|
|
>l</strong>) & a ## <a class="reference external"
|
|
href="../../../preprocessor/doc/ref/inc.html">BOOST_PP_INC</a>(<strong
|
|
>l</strong>)
|
|
, typename <strong>p</strong>::match<A1, A2, …, A<strong
|
|
>l</strong>, A ## <a class="reference external"
|
|
href="../../../preprocessor/doc/ref/inc.html">BOOST_PP_INC</a>(<strong
|
|
>l</strong>)>::type pk = <strong>p</strong>()
|
|
)
|
|
{
|
|
return <strong>name</strong>_with_named_params(
|
|
pk(a1, a2, …, a ## <strong>l</strong>, a ## <a
|
|
class="reference external" href="../../../preprocessor/doc/ref/inc.html"
|
|
>BOOST_PP_INC</a>(<strong>l</strong>))
|
|
);
|
|
}
|
|
|
|
<span class="vellipsis">⋮</span>
|
|
|
|
template <typename A1, typename A2, …, typename A ## <strong>h</strong>>
|
|
r
|
|
name(
|
|
A1 const& a1, A2 const& a2, …, A ## <strong
|
|
>h</strong> const& a ## <strong>h</strong>
|
|
, typename <strong>p</strong>::match<A1, A2, …, A ## <strong
|
|
>h</strong>>::type pk = <strong>p</strong>()
|
|
)
|
|
{
|
|
return <strong>name</strong>_with_named_params(pk(a1, a2, …, a ## <strong
|
|
>h</strong>));
|
|
}
|
|
|
|
<em>… exponential number of overloads …</em>
|
|
<span class="vellipsis">⋮</span>
|
|
|
|
template <typename A1, typename A2, …, typename A ## <strong>h</strong>>
|
|
r
|
|
name(
|
|
A1& a1, A2& a2, …, A ## <strong
|
|
>h</strong>& a ## <strong>h</strong>
|
|
, typename <strong>p</strong>::match<A1, A2, …, A ## <strong
|
|
>h</strong>>::type pk = <strong>p</strong>()
|
|
)
|
|
{
|
|
return <strong>name</strong>_with_named_params(pk(a1, a2, …, a ## <strong
|
|
>h</strong>));
|
|
}
|
|
</pre>
|
|
</dd>
|
|
</dl>
|
|
<p>The <a class="reference external" href="../../test/macros.cpp"
|
|
>test/macros.cpp</a> and <a class="reference external"
|
|
href="../../test/macros_eval_category.cpp">test/macros_eval_category.cpp</a>
|
|
test programs demonstrate proper usage of this macro.</p>
|
|
</div>
|
|
<div class="section" id="boost-parameter-keyword-n-k">
|
|
<h2><a class="toc-backref" href="#id64">6.14 <tt
|
|
class="docutils literal">BOOST_PARAMETER_KEYWORD(n, k)</tt></a></h2>
|
|
<div class="admonition-deprecated admonition">
|
|
<p class="first admonition-title">Deprecated</p>
|
|
<p class="last">This macro has been deprecated in favor of
|
|
<a class="reference internal" href="#boost-parameter-name-name"><tt
|
|
class="docutils literal">BOOST_PARAMETER_NAME</tt></a>.</p>
|
|
</div>
|
|
<p>Generates the declaration of a <a class="reference internal"
|
|
href="#keyword-tag-type">keyword tag type</a> named
|
|
<tt class="docutils literal">k</tt> in namespace
|
|
<tt class="docutils literal">n</tt>, and a corresponding
|
|
<a class="reference internal" href="#keyword-object">keyword object</a>
|
|
definition in the enclosing namespace.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Defined in:</th>
|
|
<td class="field-body"><a class="reference external"
|
|
href="../../../../boost/parameter/keyword.hpp"
|
|
>boost/parameter/keyword.hpp</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="docutils">
|
|
<dt>Generates</dt>
|
|
<dd><pre class="first last literal-block">
|
|
namespace <strong>n</strong> {
|
|
|
|
struct <strong>k</strong>
|
|
{
|
|
typedef boost::parameter::forward_reference qualifier;
|
|
};
|
|
}
|
|
|
|
namespace {
|
|
|
|
boost::parameter::keyword<<em>tag-namespace</em>::<strong
|
|
>k</strong>>& <strong>k</strong>
|
|
= boost::parameter::keyword<<em>tag-namespace</em>::<strong
|
|
>k</strong>>::instance;
|
|
}
|
|
</pre>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<div class="section" id="boost-parameter-match-p-a-x">
|
|
<h2><a class="toc-backref" href="#id65">6.15 <tt
|
|
class="docutils literal">BOOST_PARAMETER_MATCH(p, a, x)</tt></a></h2>
|
|
<p>Generates a defaulted parameter declaration for a
|
|
<a class="reference external"
|
|
href="index.html#forwarding-functions">forwarding function</a>.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Defined in:</th>
|
|
<td class="field-body"><a class="reference external"
|
|
href="../../../../boost/parameter/match.hpp"
|
|
>boost/parameter/match.hpp</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Requires:</th>
|
|
<td class="field-body">
|
|
<p class="first"><tt class="docutils literal">a</tt> is a
|
|
<a class="reference external" href="../../../preprocessor/doc/data.html"
|
|
>Boost.Preprocessor sequence</a> of the form</p>
|
|
<pre class="last literal-block">
|
|
(A0)(A1)…(A<em>n</em>)
|
|
</pre>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="docutils">
|
|
<dt>Generates</dt>
|
|
<dd>
|
|
<pre class="first last literal-block">
|
|
typename <strong>p</strong>::match<<strong>A0</strong>, <strong
|
|
>A1</strong>, …, <strong>A</strong> ## <em>n</em>>::type
|
|
<strong>x</strong> = <strong>p</strong>()
|
|
</pre>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="configuration-macros">
|
|
<h1><a class="toc-backref" href="#id66">7 Configuration
|
|
Macros</a></h1>
|
|
<div class="section" id="boost-parameter-has-perfect-forwarding">
|
|
<h2><a class="toc-backref" href="#id67">7.1 <tt
|
|
class="docutils literal">BOOST_PARAMETER_HAS_PERFECT_FORWARDING</tt></a></h2>
|
|
<p>Determines whether or not the library supports perfect forwarding, or the
|
|
preservation of parameter value categories. Users can manually disable this
|
|
macro by <tt class="docutils literal">#defining</tt> the <a
|
|
class="reference internal" href="#boost-parameter-disable-perfect-forwarding"
|
|
><tt class="docutils literal">BOOST_PARAMETER_DISABLE_PERFECT_FORWARDING</tt
|
|
></a> macro. Otherwise, the library will <tt class="docutils literal"
|
|
>#define</tt> this macro if and only if it and the configuration macros
|
|
<a class="reference external"
|
|
href="../../../config/doc/html/boost_config/boost_macro_reference.html"
|
|
><tt class="docutils literal">BOOST_NO_FUNCTION_TEMPLATE_ORDERING</tt></a>,
|
|
<a class="reference external"
|
|
href="../../../config/doc/html/boost_config/boost_macro_reference.html"
|
|
><tt class="docutils literal">BOOST_NO_SFINAE</tt></a>,
|
|
<a class="reference external"
|
|
href="../../../config/doc/html/boost_config/boost_macro_reference.html"
|
|
><tt class="docutils literal">BOOST_NO_CXX11_RVALUE_REFERENCES</tt></a>, and
|
|
<a class="reference external"
|
|
href="../../../config/doc/html/boost_config/boost_macro_reference.html"
|
|
><tt class="docutils literal">BOOST_NO_CXX11_VARIADIC_TEMPLATES</tt></a> are
|
|
not already defined by <a class="reference external"
|
|
href="../../../config/doc/html/index.html">Boost.Config</a>.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Defined in:</th>
|
|
<td class="field-body"><a class="reference external"
|
|
href="../../../../boost/parameter/config.hpp"
|
|
>boost/parameter/config.hpp</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="section" id="boost-parameter-disable-perfect-forwarding">
|
|
<h2><a class="toc-backref" href="#id68">7.2 <tt
|
|
class="docutils literal">BOOST_PARAMETER_DISABLE_PERFECT_FORWARDING</tt></a
|
|
></h2>
|
|
<p>It may be necessary to test user code in case perfect forwarding support is
|
|
unavailable. Users can <tt class="docutils literal">#define</tt> this macro
|
|
either in their project settings or before including any library header
|
|
files. Doing so will leave <a class="reference internal"
|
|
href="#boost-parameter-has-perfect-forwarding"><tt class="docutils literal"
|
|
>BOOST_PARAMETER_HAS_PERFECT_FORWARDING</tt></a> undefined.</p>
|
|
</div>
|
|
<div class="section" id="boost-parameter-variadic-mpl-sequence">
|
|
<h2><a class="toc-backref" href="#id69">7.3 <tt
|
|
class="docutils literal">BOOST_PARAMETER_VARIADIC_MPL_SEQUENCE</tt></a></h2>
|
|
<p>If <a class="reference internal"
|
|
href="#boost-parameter-has-perfect-forwarding"><tt class="docutils literal"
|
|
>BOOST_PARAMETER_HAS_PERFECT_FORWARDING</tt></a> is
|
|
<tt class="docutils literal">#defined</tt>, then determines the
|
|
<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/variadic-sequence.html">MPL Variadic
|
|
Sequence</a> underlying the nested <tt class="docutils literal"
|
|
>parameter_spec</tt> type of <a class="reference internal" href="#parameters"
|
|
><tt class="docutils literal">parameters</tt></a>. If the user does not
|
|
manually <tt class="docutils literal">#define</tt> this macro, then the
|
|
library will <tt class="docutils literal">#define</tt> it as
|
|
<a class="reference external"
|
|
href="../../../fusion/doc/html/fusion/container/list.html"
|
|
><tt class="docutils literal">::boost::fusion::list</tt></a> if
|
|
<a class="reference external"
|
|
href="../../../../boost/fusion/container/list/list_fwd.hpp"
|
|
><tt class="docutils literal">BOOST_FUSION_HAS_VARIADIC_LIST</tt></a> is
|
|
defined (by <a class="reference external"
|
|
href="../../../fusion/doc/html/index.html">Boost.Fusion</a>),
|
|
<a class="reference external"
|
|
href="../../../fusion/doc/html/fusion/container/deque.html"
|
|
><tt class="docutils literal">::boost::fusion::deque</tt></a> if
|
|
<a class="reference external"
|
|
href="../../../../boost/fusion/container/deque/deque_fwd.hpp"
|
|
><tt class="docutils literal">BOOST_FUSION_HAS_VARIADIC_DEQUE</tt></a> is
|
|
defined (by <a class="reference external"
|
|
href="../../../fusion/doc/html/index.html">Boost.Fusion</a>), or
|
|
<a class="reference external" href="../../../mpl/doc/refmanual/vector.html"
|
|
><tt class="docutils literal">::boost::mpl::vector</tt></a> otherwise.</p>
|
|
<dl class="docutils">
|
|
<dt>Example:</dt>
|
|
<dd>
|
|
<pre class="first last literal-block">
|
|
#define BOOST_PARAMETER_VARIADIC_MPL_SEQUENCE <a class="reference external"
|
|
href="../../../fusion/doc/html/fusion/container/vector.html"
|
|
><tt class="docutils literal">::boost::fusion::vector</tt></a>
|
|
</pre>
|
|
</dd>
|
|
</dl>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Defined in:</th>
|
|
<td class="field-body"><a class="reference external"
|
|
href="../../../../boost/parameter/parameters.hpp"
|
|
>boost/parameter/parameters.hpp</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="section" id="boost-parameter-max-arity">
|
|
<h2><a class="toc-backref" href="#id70">7.4 <tt
|
|
class="docutils literal">BOOST_PARAMETER_MAX_ARITY</tt></a></h2>
|
|
<p>Determines the maximum number of arguments supported by the library.</p>
|
|
<p>If <a class="reference internal"
|
|
href="#boost-parameter-has-perfect-forwarding"><tt class="docutils literal"
|
|
>BOOST_PARAMETER_HAS_PERFECT_FORWARDING</tt></a> is
|
|
<tt class="docutils literal">#defined</tt>, then:</p>
|
|
<ul>
|
|
<li>If the <a class="reference external"
|
|
href="../../../mpl/doc/refmanual/variadic-sequence.html">MPL Variadic
|
|
Sequence</a> underlying the nested <tt class="docutils literal"
|
|
>parameter_spec</tt> type of <a class="reference internal" href="#parameters"
|
|
><tt class="docutils literal">parameters</tt></a> does not have a size
|
|
limit--which is the case with <a class="reference external"
|
|
href="../../../fusion/doc/html/fusion/container/list.html"
|
|
><tt class="docutils literal">::boost::fusion::list</tt></a> and
|
|
<a class="reference external"
|
|
href="../../../fusion/doc/html/fusion/container/deque.html"
|
|
><tt class="docutils literal">::boost::fusion::deque</tt></a> but not
|
|
<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/vector.html"
|
|
><tt class="docutils literal">::boost::mpl::vector</tt></a>--then this macro
|
|
can be safely ignored. User code that manually defines
|
|
<a class="reference internal" href="#boost-parameter-variadic-mpl-sequence"
|
|
><tt class="docutils literal">BOOST_PARAMETER_VARIADIC_MPL_SEQUENCE</tt></a>
|
|
should also manually define this macro to the size limit of the sequence if it
|
|
has one.</li>
|
|
</ul>
|
|
<p>If <a class="reference internal"
|
|
href="#boost-parameter-has-perfect-forwarding"><tt class="docutils literal"
|
|
>BOOST_PARAMETER_HAS_PERFECT_FORWARDING</tt></a> is <strong>not</strong>
|
|
<tt class="docutils literal">#defined</tt>, then:</p>
|
|
<ul>
|
|
<li>Mutable references must be wrapped by
|
|
<a class="reference external" href="../../../core/doc/html/core/ref.html"
|
|
><tt class="docutils literal">boost::ref</tt></a> or
|
|
<a class="reference external"
|
|
href="http://en.cppreference.com/w/cpp/utility/functional/ref"
|
|
><tt class="docutils literal">std::ref</tt></a> if passed by position to
|
|
Boost.Parameter-enabled functions with arity greater than or equal to
|
|
<a class="reference internal"
|
|
href="#boost-parameter-exponential-overload-threshold-arity"
|
|
><tt class="docutils literal"
|
|
>BOOST_PARAMETER_EXPONENTIAL_OVERLOAD_THRESHOLD_ARITY</tt></a>.</li>
|
|
</ul>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Defined in:</th>
|
|
<td class="field-body"><a class="reference external"
|
|
href="../../../../boost/parameter/config.hpp"
|
|
>boost/parameter/config.hpp</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Default Value:</th>
|
|
<td class="field-body"><a class="reference external"
|
|
href="../../../mpl/doc/refmanual/limit-vector-size.html"
|
|
><tt class="docutils literal">BOOST_MPL_LIMIT_VECTOR_SIZE</tt></a> (defined by
|
|
<a class="reference external" href="../../../mpl/doc/index.html"
|
|
>Boost.MPL</a>) if perfect forwarding is supported,
|
|
<tt class="docutils literal">8</tt> otherwise.</td>
|
|
</tr>
|
|
<tr class="field">
|
|
<th class="field-name">Minimum Value:</th>
|
|
<td class="field-body"><tt class="docutils literal">2</tt></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="section" id="boost-parameter-exponential-overload-threshold-arity"
|
|
><h2><a class="toc-backref" href="#id71">7.5 <tt
|
|
class="docutils literal"
|
|
>BOOST_PARAMETER_EXPONENTIAL_OVERLOAD_THRESHOLD_ARITY</tt></a></h2>
|
|
<p>If this library does <strong>not</strong> support perfect forwarding,
|
|
determines the number of arguments less than which
|
|
<a class="reference internal" href="#parameters"><tt class="docutils literal"
|
|
>parameters</tt></a> generates an exponential number of function call operator
|
|
overloads, and greater than or equal to which <a class="reference internal"
|
|
href="#parameters"><tt class="docutils literal">parameters</tt></a> does
|
|
not. Will only be <tt class="docutils literal">#defined</tt> by the library
|
|
if it is not already <tt class="docutils literal">#defined</tt> and
|
|
<a class="reference internal" href="#boost-parameter-has-perfect-forwarding"
|
|
><tt class="docutils literal">BOOST_PARAMETER_HAS_PERFECT_FORWARDING</tt></a>
|
|
is <strong>not</strong> <tt class="docutils literal">#defined</tt>.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Defined in:</th>
|
|
<td class="field-body"><a class="reference external"
|
|
href="../../../../boost/parameter/config.hpp"
|
|
>boost/parameter/config.hpp</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<th class="field-name">Default Value:</th>
|
|
<td class="field-body"><tt class="docutils literal">0</tt></td>
|
|
</tr>
|
|
<tr class="field">
|
|
<th class="field-name">Minimum Value:</th>
|
|
<td class="field-body"><tt class="docutils literal">0</tt></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="section" id="outside-of-this-library"
|
|
><h2><a class="toc-backref" href="#id72">7.6 ...Outside Of
|
|
This Library</a></h2>
|
|
<ol>
|
|
<li>If <a class="reference external"
|
|
href="../../../config/doc/html/index.html">Boost.Config</a> defines the macro
|
|
<a class="reference external"
|
|
href="../../../config/doc/html/boost_config/boost_macro_reference.html"
|
|
><tt class="docutils literal">BOOST_NO_FUNCTION_TEMPLATE_ORDERING</tt></a>,
|
|
then the macro <a class="reference internal"
|
|
href="#boost-parameter-has-perfect-forwarding"><tt class="docutils literal"
|
|
>BOOST_PARAMETER_HAS_PERFECT_FORWARDING</tt></a> will be left undefined;
|
|
otherwise, the code generation macros would not work correctly.</li>
|
|
<li>If <a class="reference external"
|
|
href="../../../config/doc/html/index.html">Boost.Config</a> defines the macro
|
|
<a class="reference external"
|
|
href="../../../config/doc/html/boost_config/boost_macro_reference.html"
|
|
><tt class="docutils literal">BOOST_NO_SFINAE</tt></a>, then the macro
|
|
<a class="reference internal" href="#boost-parameter-has-perfect-forwarding"
|
|
><tt class="docutils literal">BOOST_PARAMETER_HAS_PERFECT_FORWARDING</tt></a>
|
|
will be left undefined; otherwise, keyword types generated by
|
|
<a class="reference internal" href="#boost-parameter-name-name"
|
|
><tt class="docutils literal">BOOST_PARAMETER_NAME</tt></a> and
|
|
<a class="reference internal" href="#boost-parameter-nested-keyword-t-n-a"
|
|
><tt class="docutils literal">BOOST_PARAMETER_NESTED_KEYWORD</tt></a> would
|
|
not work correctly.</li>
|
|
<li>If <a class="reference external"
|
|
href="../../../config/doc/html/index.html">Boost.Config</a> defines the macro
|
|
<a class="reference external"
|
|
href="../../../config/doc/html/boost_config/boost_macro_reference.html"
|
|
><tt class="docutils literal">BOOST_NO_CXX11_RVALUE_REFERENCES</tt></a>, then
|
|
the macro <a class="reference internal"
|
|
href="#boost-parameter-has-perfect-forwarding"><tt class="docutils literal"
|
|
>BOOST_PARAMETER_HAS_PERFECT_FORWARDING</tt></a> will be left undefined.</li>
|
|
<li>If <a class="reference external"
|
|
href="../../../config/doc/html/index.html">Boost.Config</a> defines the macro
|
|
<a class="reference external"
|
|
href="../../../config/doc/html/boost_config/boost_macro_reference.html"
|
|
><tt class="docutils literal">BOOST_NO_CXX11_VARIADIC_TEMPLATES</tt></a>, then
|
|
the macro <a class="reference internal"
|
|
href="#boost-parameter-has-perfect-forwarding"><tt class="docutils literal"
|
|
>BOOST_PARAMETER_HAS_PERFECT_FORWARDING</tt></a> will be left undefined.</li>
|
|
<li>If <a class="reference external"
|
|
href="../../../fusion/doc/html/index.html">Boost.Fusion</a> defines the macro
|
|
<a class="reference external"
|
|
href="../../../../boost/fusion/container/list/list_fwd.hpp"
|
|
><tt class="docutils literal">BOOST_FUSION_HAS_VARIADIC_LIST</tt></a>, if
|
|
this library defines the macro <a class="reference internal"
|
|
href="#boost-parameter-has-perfect-forwarding"><tt class="docutils literal"
|
|
>BOOST_PARAMETER_HAS_PERFECT_FORWARDING</tt></a>, and if the macro
|
|
<a class="reference internal" href="#boost-parameter-variadic-mpl-sequence"
|
|
><tt class="docutils literal">BOOST_PARAMETER_VARIADIC_MPL_SEQUENCE</tt></a>
|
|
is left undefined, then the <a class="reference external"
|
|
href="../../../mpl/doc/refmanual/variadic-sequence.html">MPL Variadic
|
|
Sequence</a> underlying the nested <tt class="docutils literal"
|
|
>parameter_spec</tt> type of <a class="reference internal" href="#parameters"
|
|
><tt class="docutils literal">parameters</tt></a> will be
|
|
<a class="reference external"
|
|
href="../../../fusion/doc/html/fusion/container/list.html"
|
|
><tt class="docutils literal">::boost::fusion::list</tt></a>.</li>
|
|
<li>If <a class="reference external"
|
|
href="../../../fusion/doc/html/index.html">Boost.Fusion</a> defines the macro
|
|
<a class="reference external"
|
|
href="../../../../boost/fusion/container/deque/deque_fwd.hpp"
|
|
><tt class="docutils literal">BOOST_FUSION_HAS_VARIADIC_DEQUE</tt></a>, if
|
|
this library defines the macro <a class="reference internal"
|
|
href="#boost-parameter-has-perfect-forwarding"><tt class="docutils literal"
|
|
>BOOST_PARAMETER_HAS_PERFECT_FORWARDING</tt></a>, and if the macro
|
|
<a class="reference internal" href="#boost-parameter-variadic-mpl-sequence"
|
|
><tt class="docutils literal">BOOST_PARAMETER_VARIADIC_MPL_SEQUENCE</tt></a>
|
|
is left undefined, then the <a class="reference external"
|
|
href="../../../mpl/doc/refmanual/variadic-sequence.html">MPL Variadic
|
|
Sequence</a> underlying the nested <tt class="docutils literal"
|
|
>parameter_spec</tt> type of <a class="reference internal" href="#parameters"
|
|
><tt class="docutils literal">parameters</tt></a> will be
|
|
<a class="reference external"
|
|
href="../../../fusion/doc/html/fusion/container/deque.html"
|
|
><tt class="docutils literal">::boost::fusion::deque</tt></a>.</li>
|
|
<li>The value that <a class="reference external"
|
|
href="../../../mpl/doc/index.html">Boost.MPL</a> defines the macro
|
|
<a class="reference external"
|
|
href="../../../mpl/doc/refmanual/limit-vector-size.html"
|
|
><tt class="docutils literal">BOOST_MPL_LIMIT_VECTOR_SIZE</tt></a> as will be
|
|
the value that this library defines the macro <a class="reference internal"
|
|
href="#boost-parameter-max-arity"><tt class="docutils literal"
|
|
>BOOST_PARAMETER_MAX_ARITY</tt></a> as if this library defines the macro
|
|
<a class="reference internal" href="#boost-parameter-has-perfect-forwarding"
|
|
><tt class="docutils literal">BOOST_PARAMETER_HAS_PERFECT_FORWARDING</tt></a
|
|
>.</li>
|
|
</ol>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="tutorial">
|
|
<h1><a class="toc-backref" href="#id73">8 Tutorial</a></h1>
|
|
<p>Follow <a class="reference external" href="index.html#tutorial">this
|
|
link</a> to the Boost.Parameter tutorial documentation.</p>
|
|
<hr class="docutils" />
|
|
<table class="docutils footnote" frame="void" id="thread" rules="none">
|
|
<colgroup><col class="label" /><col /></colgroup>
|
|
<tbody valign="top">
|
|
<tr>
|
|
<td class="label"><a class="fn-backref" href="#id2">[1]</a></td>
|
|
<td>References to tag objects may be initialized multiple times. This
|
|
scenario can only occur in the presence of threading. Because the C++
|
|
standard doesn't consider threading, it doesn't explicitly allow or forbid
|
|
multiple initialization of references. That said, it's hard to imagine an
|
|
implementation where it could make a difference.</td></tr>
|
|
</tbody>
|
|
</table>
|
|
<table class="docutils footnote" frame="void" id="no-result-of" rules="none">
|
|
<colgroup><col class="label" /><col /></colgroup>
|
|
<tbody valign="top">
|
|
<tr>
|
|
<td class="label">[2]</td>
|
|
<td><em>(<a class="fn-backref" href="#id11">1</a>, <a class="fn-backref"
|
|
href="#id18">2</a>)</em> Where <a class="reference external"
|
|
href="../../../utility/utility.htm#BOOST_NO_RESULT_OF"><tt
|
|
class="docutils literal">BOOST_NO_RESULT_OF</tt></a> is <tt
|
|
class="docutils literal">#defined</tt>, <tt class="docutils literal"
|
|
>boost::</tt><a class="reference external"
|
|
href="../../../utility/utility.htm#result_of"><tt class="docutils literal"
|
|
>result_of</tt></a><tt class="docutils literal"><span class="pre"
|
|
><F()>::type</span></tt> is replaced by <tt class="docutils literal"
|
|
><span class="pre">F::result_type</span></tt>.</td></tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="footer">
|
|
<hr class="footer" />
|
|
Generated on: 2011-11-08 21:40 UTC. Generated by <a
|
|
class="reference external" href="http://docutils.sourceforge.net/"
|
|
>Docutils</a> from <a class="reference external"
|
|
href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
|
|
</div>
|
|
</body>
|
|
</html>
|