doc/html/boost/proto/fold/impl.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Struct template impl</title>
   5 <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   8 <link rel="up" href="../fold.html#idp389424464" title="Description">
   9 <link rel="prev" href="../fold.html" title="Struct template fold">
  10 <link rel="next" href="../reverse_fold.html" title="Struct template reverse_fold">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="../fold.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../fold.html#idp389424464"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../reverse_fold.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.proto.fold.impl"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Struct template impl</span></h2>
  29 <p>boost::proto::fold::impl</p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../../proto/reference.html#header.boost.proto.transform.fold_hpp" title="Header &lt;boost/proto/transform/fold.hpp&gt;">boost/proto/transform/fold.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <a class="link" href="../../../Expr.html" title="Concept Expr">Expr</a><span class="special">,</span> <span class="keyword">typename</span> State<span class="special">,</span> <span class="keyword">typename</span> Data<span class="special">&gt;</span>
  36 <span class="keyword">struct</span> <a class="link" href="impl.html" title="Struct template impl">impl</a> <span class="special">:</span> <span class="keyword"></span> <a class="link" href="../transform_impl.html" title="Struct template transform_impl">proto::transform_impl</a><span class="special">&lt;</span> <span class="identifier">Expr</span><span class="special">,</span> <span class="identifier">State</span><span class="special">,</span> <span class="identifier">Data</span> <span class="special">&gt;</span> <span class="special">{</span>
  37   <span class="comment">// types</span>
  38   <span class="keyword">typedef</span> <a class="link" href="../when.html" title="Struct template when">when</a><span class="special">&lt;</span><a class="link" href="../_.html" title="Struct _">_</a><span class="special">,</span> <span class="identifier">Sequence</span><span class="special">&gt;</span>                                        <a name="boost.proto.fold.impl.X"></a><span class="identifier">X</span><span class="special">;</span>            <span class="comment">// For exposition only</span>
  39   <span class="keyword">typedef</span> <a class="link" href="../when.html" title="Struct template when">when</a><span class="special">&lt;</span><a class="link" href="../_.html" title="Struct _">_</a><span class="special">,</span> <span class="identifier">State0</span><span class="special">&gt;</span>                                          <a name="boost.proto.fold.impl.Y"></a><span class="identifier">Y</span><span class="special">;</span>            <span class="comment">// For exposition only</span>
  40   <span class="keyword">typedef</span> <span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">result_of</span><span class="special">&lt;</span><span class="identifier">X</span><span class="special">(</span><span class="identifier">Expr</span><span class="special">,</span> <span class="identifier">State</span><span class="special">,</span> <span class="identifier">Data</span><span class="special">)</span><span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span>    <a name="boost.proto.fold.impl.seq"></a><span class="identifier">seq</span><span class="special">;</span>          <span class="comment">// A Fusion sequence, for exposition only</span>
  41   <span class="keyword">typedef</span> <span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">result_of</span><span class="special">&lt;</span><span class="identifier">Y</span><span class="special">(</span><span class="identifier">Expr</span><span class="special">,</span> <span class="identifier">State</span><span class="special">,</span> <span class="identifier">Data</span><span class="special">)</span><span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span>    <a name="boost.proto.fold.impl.state0"></a><span class="identifier">state0</span><span class="special">;</span>       <span class="comment">// An initial state for the fold, for exposition only</span>
  42   <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span>                                              <a name="boost.proto.fold.impl.fun"></a><span class="identifier">fun</span><span class="special">;</span>          <span class="comment">// <code class="computeroutput">fun(d)(s,e) == when&lt;_,Fun&gt;()(e,s,d)</code></span>
  43   <span class="keyword">typedef</span> <span class="keyword">typename</span> <span class="identifier">fusion</span><span class="special">::</span><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">fold</span><span class="special">&lt;</span><span class="identifier">seq</span><span class="special">,</span> <span class="identifier">state0</span><span class="special">,</span> <span class="identifier">fun</span><span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <a name="boost.proto.fold.impl.result_type"></a><span class="identifier">result_type</span><span class="special">;</span>
  44
  45   <span class="comment">// <a class="link" href="impl.html#idp207145088-bb">public member functions</a></span>
  46   <span class="identifier">result_type</span> <a class="link" href="impl.html#idp207145648-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">impl</span><span class="special">::</span><span class="identifier">expr_param</span><span class="special">,</span>
  47                          <span class="keyword">typename</span> <span class="identifier">impl</span><span class="special">::</span><span class="identifier">state_param</span><span class="special">,</span>
  48                          <span class="keyword">typename</span> <span class="identifier">impl</span><span class="special">::</span><span class="identifier">data_param</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  49 <span class="special">}</span><span class="special">;</span></pre></div>
  50 <div class="refsect1">
  51 <a name="idp389516880"></a><h2>Description</h2>
  52 <div class="refsect2">
  53 <a name="idp389517296"></a><h3>
  54 <a name="idp207145088-bb"></a><code class="computeroutput">impl</code> public member functions</h3>
  55 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  56 <pre class="literallayout"><span class="identifier">result_type</span> <a name="idp207145648-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">impl</span><span class="special">::</span><span class="identifier">expr_param</span> expr<span class="special">,</span>
  57                        <span class="keyword">typename</span> <span class="identifier">impl</span><span class="special">::</span><span class="identifier">state_param</span> state<span class="special">,</span>
  58                        <span class="keyword">typename</span> <span class="identifier">impl</span><span class="special">::</span><span class="identifier">data_param</span> data<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
  59 <p>
  60                   Let <code class="computeroutput">seq</code> be
  61                   <code class="computeroutput"><code class="computeroutput"><a class="link" href="../when.html" title="Struct template when">when</a></code>&lt;<code class="computeroutput"><a class="link" href="../_.html" title="Struct _">_</a></code>, Sequence&gt;()(expr, state, data)</code>,
  62                   let <code class="computeroutput">state0</code> be
  63                   <code class="computeroutput"><code class="computeroutput"><a class="link" href="../when.html" title="Struct template when">when</a></code>&lt;<code class="computeroutput"><a class="link" href="../_.html" title="Struct _">_</a></code>, State0&gt;()(expr, state, data)</code>,
  64                   and let <code class="computeroutput">fun(data)</code> be an object such that
  65                   <code class="computeroutput">fun(data)(state, expr)</code> is equivalent to
  66                   <code class="computeroutput"><code class="computeroutput"><a class="link" href="../when.html" title="Struct template when">when</a></code>&lt;<code class="computeroutput"><a class="link" href="../_.html" title="Struct _">_</a></code>, Fun&gt;()(expr, state, data)</code>. Then,
  67                   this function returns <code class="computeroutput">fusion::fold(seq, state0, fun(data))</code>.
  68                 </p>
  69 <div class="variablelist"><table border="0" class="variablelist compact">
  70 <colgroup>
  71 <col align="left" valign="top">
  72 <col>
  73 </colgroup>
  74 <tbody><tr>
  75 <td><p><span class="term">Parameters:</span></p></td>
  76 <td><div class="variablelist"><table border="0" class="variablelist compact">
  77 <colgroup>
  78 <col align="left" valign="top">
  79 <col>
  80 </colgroup>
  81 <tbody>
  82 <tr>
  83 <td><p><span class="term"><code class="computeroutput">data</code></span></p></td>
  84 <td><p>An arbitrary data </p></td>
  85 </tr>
  86 <tr>
  87 <td><p><span class="term"><code class="computeroutput">expr</code></span></p></td>
  88 <td><p>The current expression </p></td>
  89 </tr>
  90 <tr>
  91 <td><p><span class="term"><code class="computeroutput">state</code></span></p></td>
  92 <td><p>The current state </p></td>
  93 </tr>
  94 </tbody>
  95 </table></div></td>
  96 </tr></tbody>
  97 </table></div>
  98 </li></ol></div>
  99 </div>
 100 </div>
 101 </div>
 102 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 103 <td align="left"></td>
 104 <td align="right"><div class="copyright-footer">Copyright &#169; 2008 Eric Niebler<p>
 105         Distributed under the Boost Software License, Version 1.0. (See accompanying
 106         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
 107       </p>
 108 </div></td>
 109 </tr></table>
 110 <hr>
 111 <div class="spirit-nav">
 112 <a accesskey="p" href="../fold.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../fold.html#idp389424464"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../reverse_fold.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
 113 </div>
 114 </body>
 115 </html>