summaryrefslogtreecommitdiff
path: root/libs/preprocessor/doc/ref/seq_transform_s.html
blob: dd205cedd571b7a3a23a558c2f87aa3639681b24 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
<html>
	<head>
		<title>BOOST_PP_SEQ_TRANSFORM_S</title>
		<link rel="stylesheet" type="text/css" href="../styles.css">
	</head>
	<body>
		<div style="margin-left:  0px;">
			The <b>BOOST_PP_SEQ_TRANSFORM_S</b> macro transforms each element in a <i>seq</i>
			according to a supplied transformation.&nbsp; It reenters <b>BOOST_PP_SEQ_FOLD_LEFT</b>
			with maximum efficiency.
		</div>
		<h4>
			Usage
		</h4>
		<div class="code">
			<b>BOOST_PP_SEQ_TRANSFORM_S</b>(<i>s</i>, <i>op</i>, <i>data</i>, <i>seq</i>)
		</div>
		<h4>
			Arguments
		</h4>
		<dl>
			<dt>s</dt>
			<dd>
				The next available <b>BOOST_PP_SEQ_FOLD_LEFT</b> fold step.
			</dd>
			<dt>op</dt>
			<dd>
				A ternary predicate of the form <i>op</i>(<i>s</i>, <i>data</i>, <i>elem</i>).&nbsp; 
				This transformation is expanded by <b>BOOST_PP_SEQ_TRANSFORM</b> for each 
				element in <i>seq</i> with the next available <b>BOOST_PP_SEQ_FOLD_LEFT</b> fold 
				step, the auxiliary <i>data</i>, and the current element in <i>seq</i>.&nbsp;
			</dd>
			<dt>data</dt>
			<dd>
				Auxiliary data passed to <i>pred</i>.
			</dd>
			<dt>seq</dt>
			<dd>
				The <i>seq</i> to be transformed.
			</dd>
		</dl>
		<h4>
			Remarks
		</h4>
		<div>
			This macro expands <i>op</i> for each element in <i>seq</i>.&nbsp; It builds a 
			new <i>seq</i> out of the results of each call.&nbsp; If, for example, <i>seq</i>
			is (<i>a</i>)(<i>b</i>)(<i>c</i>), this macro expands to...
			<div>
				(<i>op</i>(<i>d</i>, <i>data</i>, <i>a</i>))(<i>op</i>(<i>d</i>, <i>data</i>, <i>b</i>))(<i>op</i>(<i>d</i>,
				<i>data</i>, <i>c</i>))
			</div>
		</div>
		<h4>
			See Also
		</h4>
		<ul>
			<li>
				<a href="seq_transform.html">BOOST_PP_SEQ_TRANSFORM</a></li>
		</ul>
		<h4>
			Requirements
		</h4>
		<div>
			<b>Header:</b> &nbsp;<a href="../headers/seq/transform.html">&lt;boost/preprocessor/seq/transform.hpp&gt;</a>
		</div>
	<hr size="1">
	<div style="margin-left: 0px;">
		<i>© Copyright <a href="http://www.housemarque.com" target="_top">Housemarque Oy</a> 2002</i>
		</br><i>© Copyright Paul Mensonides 2002</i>
	</div>
	<div style="margin-left: 0px;">
		<p><small>Distributed under the Boost Software License, Version 1.0. (See
		accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
		copy at <a href=
		"http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
	</div>
	</body>
</html>