Files
boost_fusion/doc/html/fusion/sequences/views/transform_view.html
Joel de Guzman 6ca462baa0 doc updates
[SVN r35784]
2006-10-30 01:20:23 +00:00

271 lines
16 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>transform_view</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
<link rel="start" href="../../../index.html" title="Chapter 1. Fusion 2.0">
<link rel="up" href="../views.html" title="Views">
<link rel="prev" href="zip_view.html" title="zip_view">
<link rel="next" href="reverse_view.html" title="reverse_view">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../../../libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="zip_view.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../views.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="reverse_view.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="fusion.sequences.views.transform_view"></a><a href="transform_view.html" title="transform_view">transform_view</a></h4></div></div></div>
<p>
<tt class="computeroutput"><span class="identifier">transform_view</span></tt> presents
a transformed view of its underlying sequence given a unary <a href="../../algorithms/concepts/polymorphic_function_object.html" title="Polymorphic
Function Object">Polymorphic
Function Object</a>. The <tt class="computeroutput"><span class="identifier">transform_view</span></tt>
inherits the traversal characteristics (see <a href="../concepts.html#fusion.sequences.concepts.traversal">Sequence
Traversal Concept</a>) of its underlying sequence.
</p>
<a name="fusion.sequences.views.transform_view.header"></a><h5>
<a name="id496766"></a>
<a href="transform_view.html#fusion.sequences.views.transform_view.header">Header</a>
</h5>
<pre class="programlisting">
<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">fusion</span><span class="special">/</span><span class="identifier">sequence</span><span class="special">/</span><span class="identifier">view</span><span class="special">/</span><span class="identifier">transform_view</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.sequences.views.transform_view.synopsis"></a><h5>
<a name="id496871"></a>
<a href="transform_view.html#fusion.sequences.views.transform_view.synopsis">Synopsis</a>
</h5>
<p>
<span class="bold"><b>Unary Version</b></span>
</p>
<pre class="programlisting">
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Sequence</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">F</span><span class="special">&gt;</span>
<span class="keyword">struct</span> <span class="identifier">transform_view</span><span class="special">;</span>
</pre>
<p>
<span class="bold"><b>Binary Version</b></span>
</p>
<pre class="programlisting">
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Sequence1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Sequence2</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">F</span><span class="special">&gt;</span>
<span class="keyword">struct</span> <span class="identifier">transform_view</span><span class="special">;</span>
</pre>
<a name="fusion.sequences.views.transform_view.template_parameters"></a><h5>
<a name="id497075"></a>
<a href="transform_view.html#fusion.sequences.views.transform_view.template_parameters">Template
parameters</a>
</h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Parameter</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody>
<tr>
<td><tt class="computeroutput"><span class="identifier">Sequence</span></tt></td>
<td>A
<a href="../concepts/forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a>
</td>
<td> </td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">Sequence1</span></tt></td>
<td>A
<a href="../concepts/forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a>
</td>
<td> </td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">Sequence2</span></tt></td>
<td>A
<a href="../concepts/forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a>
</td>
<td> </td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">F</span></tt></td>
<td>A
<a href="../../algorithms/concepts/polymorphic_function_object.html" title="Polymorphic
Function Object">Polymorphic
Function Object</a>
</td>
<td> </td>
</tr>
</tbody>
</table></div>
<a name="fusion.sequences.views.transform_view.model_of"></a><h5>
<a name="id497243"></a>
<a href="transform_view.html#fusion.sequences.views.transform_view.model_of">Model of</a>
</h5>
<div class="itemizedlist"><ul type="disc"><li>
<a href="../concepts/forward_sequence.html" title="Forward
Sequence">Forward Sequence</a>,
<a href="../concepts/bidirectional_sequence.html" title="Bidirectional
Sequence">Bidirectional
Sequence</a> or <a href="../concepts/random_access_sequence.html" title="Random
Access Sequence">Random
Access Sequence</a> depending on the traversal characteristics (see
<a href="../concepts.html#fusion.sequences.concepts.traversal">Sequence Traversal
Concept</a>) of its underlying sequence.
</li></ul></div>
<div class="variablelist">
<p class="title"><b>Notation</b></p>
<dl>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">TV</span></tt></span></dt>
<dd>
A <tt class="computeroutput"><span class="identifier">transform_view</span></tt> type
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">BTV</span></tt></span></dt>
<dd>
A binary <tt class="computeroutput"><span class="identifier">transform_view</span></tt>
type
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">UTV</span></tt></span></dt>
<dd>
A unary <tt class="computeroutput"><span class="identifier">transform_view</span></tt>
type
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">f</span></tt></span></dt>
<dd>
An instance of <tt class="computeroutput"><span class="identifier">F</span></tt>
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">s</span></tt></span></dt>
<dd>
An instance of <tt class="computeroutput"><span class="identifier">Sequence</span></tt>
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">s1</span></tt></span></dt>
<dd>
An instance of <tt class="computeroutput"><span class="identifier">Sequence1</span></tt>
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">s2</span></tt></span></dt>
<dd>
An instance of <tt class="computeroutput"><span class="identifier">Sequence2</span></tt>
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">tv</span></tt>,
<tt class="computeroutput"><span class="identifier">tv2</span></tt></span></dt>
<dd>
Instances of <tt class="computeroutput"><span class="identifier">transform_view</span></tt>
</dd>
</dl>
</div>
<a name="fusion.sequences.views.transform_view.expression_semantics"></a><h5>
<a name="id497557"></a>
<a href="transform_view.html#fusion.sequences.views.transform_view.expression_semantics">Expression
Semantics</a>
</h5>
<p>
Semantics of an expression is defined only where it differs from, or is
not defined in <a href="../concepts/forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a>, <a href="../concepts/bidirectional_sequence.html" title="Bidirectional
Sequence">Bidirectional
Sequence</a> or <a href="../concepts/random_access_sequence.html" title="Random
Access Sequence">Random
Access Sequence</a> depending on the traversal characteristics (see
<a href="../concepts.html#fusion.sequences.concepts.traversal">Sequence Traversal
Concept</a>) of its underlying sequence.
</p>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>Expression</th>
<th>Semantics</th>
</tr></thead>
<tbody>
<tr>
<td><tt class="computeroutput"><span class="identifier">UTV</span><span class="special">(</span><span class="identifier">s</span><span class="special">,</span> <span class="identifier">f</span><span class="special">)</span></tt></td>
<td>Creates
a unary <tt class="computeroutput"><span class="identifier">transform_view</span></tt>
given sequence, <tt class="computeroutput"><span class="identifier">s</span></tt>
and unary <a href="../../algorithms/concepts/polymorphic_function_object.html" title="Polymorphic
Function Object">Polymorphic
Function Object</a>, <tt class="computeroutput"><span class="identifier">f</span></tt>.</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">BTV</span><span class="special">(</span><span class="identifier">s1</span><span class="special">,</span> <span class="identifier">s2</span><span class="special">,</span> <span class="identifier">f</span><span class="special">)</span></tt></td>
<td>Creates
a binary <tt class="computeroutput"><span class="identifier">transform_view</span></tt>
given sequences, <tt class="computeroutput"><span class="identifier">s1</span></tt>
and <tt class="computeroutput"><span class="identifier">s2</span></tt> and unary
<a href="../../algorithms/concepts/polymorphic_function_object.html" title="Polymorphic
Function Object">Polymorphic
Function Object</a>, <tt class="computeroutput"><span class="identifier">f</span></tt>.</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">TV</span><span class="special">(</span><span class="identifier">tv</span><span class="special">)</span></tt></td>
<td>Copy
constructs a <tt class="computeroutput"><span class="identifier">transform_view</span></tt>
from another <tt class="computeroutput"><span class="identifier">transform_view</span></tt>,
<tt class="computeroutput"><span class="identifier">tv</span></tt>.</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">tv</span> <span class="special">=</span> <span class="identifier">tv2</span></tt></td>
<td>Assigns to a
<tt class="computeroutput"><span class="identifier">transform_view</span></tt>,
<tt class="computeroutput"><span class="identifier">tv</span></tt>, from another
<tt class="computeroutput"><span class="identifier">transform_view</span></tt>,
<tt class="computeroutput"><span class="identifier">tv2</span></tt>.</td>
</tr>
</tbody>
</table></div>
<a name="fusion.sequences.views.transform_view.example"></a><h5>
<a name="id497985"></a>
<a href="transform_view.html#fusion.sequences.views.transform_view.example">Example</a>
</h5>
<pre class="programlisting">
<span class="keyword">struct</span> <span class="identifier">square</span>
<span class="special">{</span>
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">T</span><span class="special">&gt;</span>
<span class="keyword">struct</span> <span class="identifier">result</span>
<span class="special">{</span>
<span class="keyword">typedef</span> <span class="identifier">T</span> <span class="identifier">type</span><span class="special">;</span>
<span class="special">};</span>
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">T</span><span class="special">&gt;</span>
<span class="identifier">T</span> <span class="keyword">operator</span><span class="special">()(</span><span class="identifier">T</span> <span class="identifier">x</span><span class="special">)</span> <span class="keyword">const</span>
<span class="special">{</span>
<span class="keyword">return</span> <span class="identifier">x</span> <span class="special">*</span> <span class="identifier">x</span><span class="special">;</span>
<span class="special">}</span>
<span class="special">};</span>
<span class="keyword">typedef</span> <a href="../containers/vector.html" title="vector"><tt class="computeroutput"><span class="identifier">vector</span></tt></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">short</span><span class="special">,</span> <span class="keyword">double</span><span class="special">&gt;</span> <span class="identifier">vector_type</span><span class="special">;</span>
<span class="identifier">vector_type</span> <span class="identifier">vec</span><span class="special">(</span><span class="number">2</span><span class="special">,</span> <span class="number">5</span><span class="special">,</span> <span class="number">3.3</span><span class="special">);</span>
<span class="identifier">transform_view</span><span class="special">&lt;</span><span class="identifier">vector_type</span><span class="special">,</span> <span class="identifier">square</span><span class="special">&gt;</span> <span class="identifier">transform</span><span class="special">(</span><span class="identifier">vec</span><span class="special">,</span> <span class="identifier">square</span><span class="special">());</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="identifier">transform</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
</pre>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><small>Copyright © 2001-2005 Joel de Guzman, Dan Marsden</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="zip_view.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../views.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="reverse_view.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
</body>
</html>