boostorg/iterator
1
0
Fork 1
mirror of https://github.com/boostorg/iterator.git synced 2026-07-05 08:00:59 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
3b60f75bc6d3593f51287bb3dab4eeea027f986d
iterator/doc/function_output_iterator.html
T

172 lines
8.4 KiB
HTML
Raw Normal View History

generated output
2003-08-05 19:48:41 +00:00
<?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" />
Fix >31 character filenames
2004-09-13 14:39:59 +00:00
<meta name="generator" content="Docutils 0.3.6: http://docutils.sourceforge.net/" />
generated output
2003-08-05 19:48:41 +00:00
<title>Function Output Iterator</title>
<meta name="author" content="David Abrahams, Jeremy Siek, Thomas Witt" />
<meta name="organization" content="Boost Consulting, Indiana University Open Systems Lab, University of Hanover Institute for Transport Railway Operation and Construction" />
Stop reserving rights.
2004-11-02 14:31:27 +00:00
<meta name="date" content="2004-11-01" />
<meta name="copyright" content="Copyright David Abrahams, Jeremy Siek, and Thomas Witt 2003." />
added base() function to the interface of the specialized adaptors
2004-01-12 04:17:26 +00:00
<link rel="stylesheet" href="default.css" type="text/css" />
generated output
2003-08-05 19:48:41 +00:00
</head>
<body>
<h1 class="title">Function Output Iterator</h1>
<table class="docinfo" frame="void" rules="none">
<col class="docinfo-name" />
<col class="docinfo-content" />
<tbody valign="top">
<tr><th class="docinfo-name">Author:</th>
<td>David Abrahams, Jeremy Siek, Thomas Witt</td></tr>
<tr><th class="docinfo-name">Contact:</th>
<td><a class="first reference" href="mailto:dave&#64;boost-consulting.com">dave&#64;boost-consulting.com</a>, <a class="reference" href="mailto:jsiek&#64;osl.iu.edu">jsiek&#64;osl.iu.edu</a>, <a class="last reference" href="mailto:witt&#64;ive.uni-hannover.de">witt&#64;ive.uni-hannover.de</a></td></tr>
<tr><th class="docinfo-name">Organization:</th>
<td><a class="first reference" href="http://www.boost-consulting.com">Boost Consulting</a>, Indiana University <a class="reference" href="http://www.osl.iu.edu">Open Systems
Lab</a>, University of Hanover <a class="last reference" href="http://www.ive.uni-hannover.de">Institute for Transport
Railway Operation and Construction</a></td></tr>
<tr><th class="docinfo-name">Date:</th>
Stop reserving rights.
2004-11-02 14:31:27 +00:00
<td>2004-11-01</td></tr>
generated output
2003-08-05 19:48:41 +00:00
<tr><th class="docinfo-name">Copyright:</th>
Stop reserving rights.
2004-11-02 14:31:27 +00:00
<td>Copyright David Abrahams, Jeremy Siek, and Thomas Witt 2003.</td></tr>
generated output
2003-08-05 19:48:41 +00:00
</tbody>
</table>
Fix >31 character filenames
2004-09-13 14:39:59 +00:00
<div class="document" id="function-output-iterator">
generated output
2003-08-05 19:48:41 +00:00
<table class="field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
regen the html
2004-01-13 02:58:21 +00:00
<tr class="field"><th class="field-name">abstract:</th><td class="field-body">The function output iterator adaptor makes it easier to create custom
generated output
2003-08-05 19:48:41 +00:00
output iterators. The adaptor takes a unary function and creates a
model of Output Iterator. Each item assigned to the output iterator is
passed as an argument to the unary function. The motivation for this
iterator is that creating a conforming output iterator is non-trivial,
particularly because the proper implementation usually requires a
regen the html
2004-01-13 02:58:21 +00:00
proxy object.</td>
</tr>
</tbody>
</table>
generated output
2003-08-05 19:48:41 +00:00
<div class="contents topic" id="table-of-contents">
Fix >31 character filenames
2004-09-13 14:39:59 +00:00
<p class="topic-title first"><a name="table-of-contents">Table of Contents</a></p>
generated output
2003-08-05 19:48:41 +00:00
<ul class="simple">
<li><a class="reference" href="#function-output-iterator-requirements" id="id1" name="id1"><tt class="literal"><span class="pre">function_output_iterator</span></tt> requirements</a></li>
updated some issues for indirect_iterator
2004-01-12 19:30:48 +00:00
<li><a class="reference" href="#function-output-iterator-models" id="id2" name="id2"><tt class="literal"><span class="pre">function_output_iterator</span></tt> models</a></li>
<li><a class="reference" href="#function-output-iterator-operations" id="id3" name="id3"><tt class="literal"><span class="pre">function_output_iterator</span></tt> operations</a></li>
added base() function to the interface of the specialized adaptors
2004-01-12 04:17:26 +00:00
<li><a class="reference" href="#example" id="id4" name="id4">Example</a></li>
generated output
2003-08-05 19:48:41 +00:00
</ul>
</div>
<pre class="literal-block">
template &lt;class UnaryFunction&gt;
class function_output_iterator {
public:
updated some issues for indirect_iterator
2004-01-12 19:30:48 +00:00
typedef std::output_iterator_tag iterator_category;
typedef void value_type;
typedef void difference_type;
typedef void pointer;
typedef void reference;
generated output
2003-08-05 19:48:41 +00:00
HTML updates
2004-01-27 04:13:36 +00:00
explicit function_output_iterator();
explicit function_output_iterator(const UnaryFunction&amp; f);
generated output
2003-08-05 19:48:41 +00:00
unspecified instead of implementation defined
2004-01-13 13:51:28 +00:00
/* see below */ operator*();
generated output
2003-08-05 19:48:41 +00:00
function_output_iterator&amp; operator++();
function_output_iterator&amp; operator++(int);
updated some issues for indirect_iterator
2004-01-12 19:30:48 +00:00
private:
UnaryFunction m_f; // exposition only
generated output
2003-08-05 19:48:41 +00:00
};
</pre>
<div class="section" id="function-output-iterator-requirements">
<h1><a class="toc-backref" href="#id1" name="function-output-iterator-requirements"><tt class="literal"><span class="pre">function_output_iterator</span></tt> requirements</a></h1>
unspecified instead of implementation defined
2004-01-13 13:51:28 +00:00
<p><tt class="literal"><span class="pre">UnaryFunction</span></tt> must be Assignable and Copy Constructible.</p>
updated some issues for indirect_iterator
2004-01-12 19:30:48 +00:00
</div>
<div class="section" id="function-output-iterator-models">
<h1><a class="toc-backref" href="#id2" name="function-output-iterator-models"><tt class="literal"><span class="pre">function_output_iterator</span></tt> models</a></h1>
<p><tt class="literal"><span class="pre">function_output_iterator</span></tt> is a model of the Writable and
Incrementable Iterator concepts.</p>
generated output
2003-08-05 19:48:41 +00:00
</div>
<div class="section" id="function-output-iterator-operations">
updated some issues for indirect_iterator
2004-01-12 19:30:48 +00:00
<h1><a class="toc-backref" href="#id3" name="function-output-iterator-operations"><tt class="literal"><span class="pre">function_output_iterator</span></tt> operations</a></h1>
generated output
2003-08-05 19:48:41 +00:00
<p><tt class="literal"><span class="pre">explicit</span> <span class="pre">function_output_iterator(const</span> <span class="pre">UnaryFunction&amp;</span> <span class="pre">f</span> <span class="pre">=</span> <span class="pre">UnaryFunction());</span></tt></p>
<table class="field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
last nights intense scramble to get a revision ready for the C++ std committee
2004-01-19 18:52:48 +00:00
<tr class="field"><th class="field-name">Effects:</th><td class="field-body">Constructs an instance of <tt class="literal"><span class="pre">function_output_iterator</span></tt>
with <tt class="literal"><span class="pre">m_f</span></tt> constructed from <tt class="literal"><span class="pre">f</span></tt>.</td>
generated output
2003-08-05 19:48:41 +00:00
</tr>
</tbody>
</table>
unspecified instead of implementation defined
2004-01-13 13:51:28 +00:00
<p><tt class="literal"><span class="pre">operator*();</span></tt></p>
generated output
2003-08-05 19:48:41 +00:00
<table class="field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
unspecified instead of implementation defined
2004-01-13 13:51:28 +00:00
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">An object <tt class="literal"><span class="pre">r</span></tt> of unspecified type such that <tt class="literal"><span class="pre">r</span> <span class="pre">=</span> <span class="pre">t</span></tt>
is equivalent to <tt class="literal"><span class="pre">m_f(t)</span></tt> for all <tt class="literal"><span class="pre">t</span></tt>.</td>
generated output
2003-08-05 19:48:41 +00:00
</tr>
</tbody>
</table>
<p><tt class="literal"><span class="pre">function_output_iterator&amp;</span> <span class="pre">operator++();</span></tt></p>
<table class="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="literal"><span class="pre">*this</span></tt></td>
</tr>
</tbody>
</table>
<p><tt class="literal"><span class="pre">function_output_iterator&amp;</span> <span class="pre">operator++(int);</span></tt></p>
<table class="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="literal"><span class="pre">*this</span></tt></td>
</tr>
</tbody>
</table>
</div>
added base() function to the interface of the specialized adaptors
2004-01-12 04:17:26 +00:00
<div class="section" id="example">
<h1><a class="toc-backref" href="#id4" name="example">Example</a></h1>
<pre class="literal-block">
struct string_appender
{
string_appender(std::string&amp; s)
: m_str(&amp;s)
{}
void operator()(const std::string&amp; x) const
{
*m_str += x;
}
std::string* m_str;
};
int main(int, char*[])
{
std::vector&lt;std::string&gt; x;
x.push_back(&quot;hello&quot;);
x.push_back(&quot; &quot;);
x.push_back(&quot;world&quot;);
x.push_back(&quot;!&quot;);
std::string s = &quot;&quot;;
std::copy(x.begin(), x.end(),
boost::make_function_output_iterator(string_appender(s)));
std::cout &lt;&lt; s &lt;&lt; std::endl;
return 0;
}
</pre>
generated output
2003-08-05 19:48:41 +00:00
</div>
tutorial updates
2004-01-12 02:49:55 +00:00
</div>
HTML updates
2004-01-27 04:13:36 +00:00
<hr class="footer" />
<div class="footer">
<a class="reference" href="function_output_iterator.rst">View document source</a>.
Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
</div>
generated output
2003-08-05 19:48:41 +00:00
</body>
</html>
Reference in New Issue Copy Permalink