• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<html>
3<head>
4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5<title>Concept Transform</title>
6<link rel="stylesheet" href="../../doc/src/boostbook.css" type="text/css">
7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
8<link rel="home" href="index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
9<link rel="up" href="proto/reference.html" title="Reference">
10<link rel="prev" href="PrimitiveTransform.html" title="Concept PrimitiveTransform">
11<link rel="next" href="proto/appendices.html" title="Appendices">
12</head>
13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
14<table cellpadding="2" width="100%"><tr>
15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../boost.png"></td>
16<td align="center"><a href="../../index.html">Home</a></td>
17<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
20<td align="center"><a href="../../more/index.htm">More</a></td>
21</tr></table>
22<hr>
23<div class="spirit-nav">
24<a accesskey="p" href="PrimitiveTransform.html"><img src="../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="proto/reference.html"><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="proto/appendices.html"><img src="../../doc/src/images/next.png" alt="Next"></a>
25</div>
26<div class="refentry">
27<a name="Transform"></a><div class="titlepage"></div>
28<div class="refnamediv">
29<h2><span class="refentrytitle">Concept Transform</span></h2>
30<p>Transform</p>
31</div>
32<div class="refsect1">
33<a name="id-1.3.33.5.65.3"></a><h2>Description</h2>
34<p>
35      A Transform is a PrimitiveTransform, a CallableTransform
36      or an ObjectTransform.
37    </p>
38</div>
39<div class="refsect1">
40<a name="id-1.3.33.5.65.4"></a><h2>Associated types</h2>
41<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
42<p><span class="bold"><strong>result_type</strong></span></p>
43<pre class="literallayout">boost::result_of&lt;when&lt; _, Tn &gt;(Expr, State, Data)&gt;::type</pre>
44<p>
45      </p>
46<p>The result of applying the Transform.</p>
47<p>
48    </p>
49</li></ul></div>
50</div>
51<div class="refsect1">
52<a name="id-1.3.33.5.65.5"></a><h2>Notation</h2>
53<div class="variablelist"><dl class="variablelist">
54<dt><span class="term">Tn</span></dt>
55<dd>A type playing the role of transform-type in the <a class="link" href="Transform.html" title="Concept Transform">Transform</a> concept.</dd>
56<dt><span class="term">Expr</span></dt>
57<dd>A type playing the role of expression-type in the <a class="link" href="Transform.html" title="Concept Transform">Transform</a> concept.</dd>
58<dt><span class="term">State</span></dt>
59<dd>A type playing the role of state-type in the <a class="link" href="Transform.html" title="Concept Transform">Transform</a> concept.</dd>
60<dt><span class="term">Data</span></dt>
61<dd>A type playing the role of data-type in the <a class="link" href="Transform.html" title="Concept Transform">Transform</a> concept.</dd>
62<dt><span class="term"><code class="varname">expr</code></span></dt>
63<dd>Object of type Expr</dd>
64<dt><span class="term"><code class="varname">state</code></span></dt>
65<dd>Object of type State</dd>
66<dt><span class="term"><code class="varname">data</code></span></dt>
67<dd>Object of type Data</dd>
68</dl></div>
69</div>
70<div class="refsect1">
71<a name="id-1.3.33.5.65.6"></a><h2>Valid expressions</h2>
72<div class="informaltable"><table class="table">
73<colgroup>
74<col>
75<col>
76<col>
77<col>
78</colgroup>
79<thead><tr>
80<th>Name</th>
81<th>Expression</th>
82<th>Type</th>
83<th>Semantics</th>
84</tr></thead>
85<tbody><tr>
86<td><p>Apply Transform</p></td>
87<td><p>when&lt; _, Tn &gt;()(expr, state, data)</p></td>
88<td><p><span class="type">result_type</span></p></td>
89<td><p>Applies the transform.</p></td>
90</tr></tbody>
91</table></div>
92</div>
93<div class="refsect1">
94<a name="id-1.3.33.5.65.7"></a><h2>Models</h2>
95<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><span class="simplelist"><span class="type">boost::proto::_child(boost::proto::_left)</span></span></li></ul></div>
96</div>
97</div>
98<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
99<td align="left"></td>
100<td align="right"><div class="copyright-footer">Copyright © 2008 Eric Niebler<p>
101        Distributed under the Boost Software License, Version 1.0. (See accompanying
102        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>)
103      </p>
104</div></td>
105</tr></table>
106<hr>
107<div class="spirit-nav">
108<a accesskey="p" href="PrimitiveTransform.html"><img src="../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="proto/reference.html"><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="proto/appendices.html"><img src="../../doc/src/images/next.png" alt="Next"></a>
109</div>
110</body>
111</html>
112