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" / >
2006-09-11 22:27:29 +00:00
< meta name = "generator" content = "Docutils 0.4: http://docutils.sourceforge.net/" / >
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" / >
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." / >
2006-09-11 22:27:29 +00:00
< style type = "text/css" >
/*
:Author: David Goodger
:Contact: goodger@users.sourceforge.net
:Date: $Date$
:Revision: $Revision$
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/
/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
border: 0 }
table.borderless td, table.borderless th {
/* Override padding for "table.docutils td" with "! important".
The right padding separates the table cells. */
padding: 0 0.5em 0 0 ! important }
.first {
/* Override more specific margin styles with "! important". */
margin-top: 0 ! important }
.last, .with-subtitle {
margin-bottom: 0 ! important }
.hidden {
display: none }
a.toc-backref {
text-decoration: none ;
color: black }
blockquote.epigraph {
margin: 2em 5em ; }
dl.docutils dd {
margin-bottom: 0.5em }
/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
font-weight: bold }
*/
div.abstract {
margin: 2em 5em }
div.abstract p.topic-title {
font-weight: bold ;
text-align: center }
div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
margin: 2em ;
border: medium outset ;
padding: 1em }
div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
font-weight: bold ;
font-family: sans-serif }
div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title {
color: red ;
font-weight: bold ;
font-family: sans-serif }
/* Uncomment (and remove this text!) to get reduced vertical space in
compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
margin-bottom: 0.5em }
div.compound .compound-last, div.compound .compound-middle {
margin-top: 0.5em }
*/
div.dedication {
margin: 2em 5em ;
text-align: center ;
font-style: italic }
div.dedication p.topic-title {
font-weight: bold ;
font-style: normal }
div.figure {
margin-left: 2em ;
margin-right: 2em }
div.footer, div.header {
clear: both;
font-size: smaller }
div.line-block {
display: block ;
margin-top: 1em ;
margin-bottom: 1em }
div.line-block div.line-block {
margin-top: 0 ;
margin-bottom: 0 ;
margin-left: 1.5em }
div.sidebar {
margin-left: 1em ;
border: medium outset ;
padding: 1em ;
background-color: #ffffee ;
width: 40% ;
float: right ;
clear: right }
div.sidebar p.rubric {
font-family: sans-serif ;
font-size: medium }
div.system-messages {
margin: 5em }
div.system-messages h1 {
color: red }
div.system-message {
border: medium outset ;
padding: 1em }
div.system-message p.system-message-title {
color: red ;
font-weight: bold }
div.topic {
margin: 2em }
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
margin-top: 0.4em }
h1.title {
text-align: center }
h2.subtitle {
text-align: center }
hr.docutils {
width: 75% }
img.align-left {
clear: left }
img.align-right {
clear: right }
ol.simple, ul.simple {
margin-bottom: 1em }
ol.arabic {
list-style: decimal }
ol.loweralpha {
list-style: lower-alpha }
ol.upperalpha {
list-style: upper-alpha }
ol.lowerroman {
list-style: lower-roman }
ol.upperroman {
list-style: upper-roman }
p.attribution {
text-align: right ;
margin-left: 50% }
p.caption {
font-style: italic }
p.credits {
font-style: italic ;
font-size: smaller }
p.label {
white-space: nowrap }
p.rubric {
font-weight: bold ;
font-size: larger ;
color: maroon ;
text-align: center }
p.sidebar-title {
font-family: sans-serif ;
font-weight: bold ;
font-size: larger }
p.sidebar-subtitle {
font-family: sans-serif ;
font-weight: bold }
p.topic-title {
font-weight: bold }
pre.address {
margin-bottom: 0 ;
margin-top: 0 ;
font-family: serif ;
font-size: 100% }
pre.literal-block, pre.doctest-block {
margin-left: 2em ;
margin-right: 2em ;
background-color: #eeeeee }
span.classifier {
font-family: sans-serif ;
font-style: oblique }
span.classifier-delimiter {
font-family: sans-serif ;
font-weight: bold }
span.interpreted {
font-family: sans-serif }
span.option {
white-space: nowrap }
span.pre {
white-space: pre }
span.problematic {
color: red }
span.section-subtitle {
/* font-size relative to parent (h1..h6 element) */
font-size: 80% }
table.citation {
border-left: solid 1px gray;
margin-left: 1px }
table.docinfo {
margin: 2em 4em }
table.docutils {
margin-top: 0.5em ;
margin-bottom: 0.5em }
table.footnote {
border-left: solid 1px black;
margin-left: 1px }
table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
padding-left: 0.5em ;
padding-right: 0.5em ;
vertical-align: top }
table.docutils th.field-name, table.docinfo th.docinfo-name {
font-weight: bold ;
text-align: left ;
white-space: nowrap ;
padding-left: 0 }
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
font-size: 100% }
tt.docutils {
background-color: #eeeeee }
ul.auto-toc {
list-style-type: none }
< / style >
2003-08-05 19:48:41 +00:00
< / head >
< body >
2005-05-20 15:32:55 +00:00
< div class = "document" id = "function-output-iterator" >
2003-08-05 19:48:41 +00:00
< 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@boost-consulting.com" > dave@ boost-consulting.com< / a > , < a class = "reference" href = "mailto:jsiek@osl.iu.edu" > jsiek@ osl.iu.edu< / a > , < a class = "last reference" href = "mailto:witt@ive.uni-hannover.de" > witt@ 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 >
2004-11-02 14:31:27 +00:00
< td > 2004-11-01< / td > < / tr >
2003-08-05 19:48:41 +00:00
< tr > < th class = "docinfo-name" > Copyright:< / th >
2004-11-02 14:31:27 +00:00
< td > Copyright David Abrahams, Jeremy Siek, and Thomas Witt 2003.< / td > < / tr >
2003-08-05 19:48:41 +00:00
< / tbody >
< / table >
2006-09-11 22:27:29 +00:00
<!-- Distributed under the Boost -->
<!-- Software License, Version 1.0. (See accompanying -->
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
2005-05-20 15:32:55 +00:00
< table class = "docutils field-list" frame = "void" rules = "none" >
2003-08-05 19:48:41 +00:00
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
2006-09-11 22:27:29 +00:00
< tr class = "field" > < th class = "field-name" > abstract:< / th > < td class = "field-body" > <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
<!-- Software License, Version 1.0. (See accompanying -->
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
The function output iterator adaptor makes it easier to create custom
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
2004-01-13 02:58:21 +00:00
proxy object.< / td >
< / tr >
< / tbody >
< / table >
2006-09-11 22:27:29 +00:00
< div class = "contents topic" >
< p class = "topic-title first" > < a id = "table-of-contents" name = "table-of-contents" > Table of Contents< / a > < / p >
2003-08-05 19:48:41 +00:00
< ul class = "simple" >
2006-02-01 23:33:32 +00:00
< li > < a class = "reference" href = "#header" id = "id1" name = "id1" > Header< / a > < / li >
< li > < a class = "reference" href = "#function-output-iterator-requirements" id = "id2" name = "id2" > < tt class = "docutils literal" > < span class = "pre" > function_output_iterator< / span > < / tt > requirements< / a > < / li >
< li > < a class = "reference" href = "#function-output-iterator-models" id = "id3" name = "id3" > < tt class = "docutils literal" > < span class = "pre" > function_output_iterator< / span > < / tt > models< / a > < / li >
< li > < a class = "reference" href = "#function-output-iterator-operations" id = "id4" name = "id4" > < tt class = "docutils literal" > < span class = "pre" > function_output_iterator< / span > < / tt > operations< / a > < / li >
< li > < a class = "reference" href = "#example" id = "id5" name = "id5" > Example< / a > < / li >
2003-08-05 19:48:41 +00:00
< / ul >
< / div >
2006-09-11 22:27:29 +00:00
<!-- Copyright David Abrahams 2006. Distributed under the Boost -->
<!-- Software License, Version 1.0. (See accompanying -->
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
< div class = "section" >
< h1 > < a class = "toc-backref" href = "#id1" id = "header" name = "header" > Header< / a > < / h1 >
2006-02-01 23:33:32 +00:00
< pre class = "literal-block" >
#include < boost/function_output_iterator.hpp>
< / pre >
2003-08-05 19:48:41 +00:00
< pre class = "literal-block" >
template < class UnaryFunction>
class function_output_iterator {
public:
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;
2003-08-05 19:48:41 +00:00
2004-01-27 04:13:36 +00:00
explicit function_output_iterator();
explicit function_output_iterator(const UnaryFunction& f);
2003-08-05 19:48:41 +00:00
2004-01-13 13:51:28 +00:00
/* see below */ operator*();
2003-08-05 19:48:41 +00:00
function_output_iterator& operator++();
function_output_iterator& operator++(int);
2004-01-12 19:30:48 +00:00
private:
UnaryFunction m_f; // exposition only
2003-08-05 19:48:41 +00:00
};
< / pre >
2006-02-01 23:33:32 +00:00
< / div >
2006-09-11 22:27:29 +00:00
< div class = "section" >
< h1 > < a class = "toc-backref" href = "#id2" id = "function-output-iterator-requirements" name = "function-output-iterator-requirements" > < tt class = "docutils literal" > < span class = "pre" > function_output_iterator< / span > < / tt > requirements< / a > < / h1 >
2005-05-20 15:32:55 +00:00
< p > < tt class = "docutils literal" > < span class = "pre" > UnaryFunction< / span > < / tt > must be Assignable and Copy Constructible.< / p >
2004-01-12 19:30:48 +00:00
< / div >
2006-09-11 22:27:29 +00:00
< div class = "section" >
< h1 > < a class = "toc-backref" href = "#id3" id = "function-output-iterator-models" name = "function-output-iterator-models" > < tt class = "docutils literal" > < span class = "pre" > function_output_iterator< / span > < / tt > models< / a > < / h1 >
2005-05-20 15:32:55 +00:00
< p > < tt class = "docutils literal" > < span class = "pre" > function_output_iterator< / span > < / tt > is a model of the Writable and
2004-01-12 19:30:48 +00:00
Incrementable Iterator concepts.< / p >
2003-08-05 19:48:41 +00:00
< / div >
2006-09-11 22:27:29 +00:00
< div class = "section" >
< h1 > < a class = "toc-backref" href = "#id4" id = "function-output-iterator-operations" name = "function-output-iterator-operations" > < tt class = "docutils literal" > < span class = "pre" > function_output_iterator< / span > < / tt > operations< / a > < / h1 >
2005-05-20 15:32:55 +00:00
< p > < tt class = "docutils literal" > < span class = "pre" > explicit< / span > < span class = "pre" > function_output_iterator(const< / span > < span class = "pre" > UnaryFunction& < / span > < span class = "pre" > f< / span > < span class = "pre" > =< / span > < span class = "pre" > UnaryFunction());< / span > < / tt > < / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
2003-08-05 19:48:41 +00:00
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
2006-09-11 22:27:29 +00:00
< tr class = "field" > < th class = "field-name" > Effects:< / th > < td class = "field-body" > Constructs an instance of < tt class = "docutils literal" > < span class = "pre" > function_output_iterator< / span > < / tt >
2005-05-20 15:32:55 +00:00
with < tt class = "docutils literal" > < span class = "pre" > m_f< / span > < / tt > constructed from < tt class = "docutils literal" > < span class = "pre" > f< / span > < / tt > .< / td >
2003-08-05 19:48:41 +00:00
< / tr >
< / tbody >
< / table >
2005-05-20 15:32:55 +00:00
< p > < tt class = "docutils literal" > < span class = "pre" > operator*();< / span > < / tt > < / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
2003-08-05 19:48:41 +00:00
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
2005-05-20 15:32:55 +00:00
< tr class = "field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > An object < tt class = "docutils literal" > < span class = "pre" > r< / span > < / tt > of unspecified type such that < tt class = "docutils literal" > < span class = "pre" > r< / span > < span class = "pre" > =< / span > < span class = "pre" > t< / span > < / tt >
is equivalent to < tt class = "docutils literal" > < span class = "pre" > m_f(t)< / span > < / tt > for all < tt class = "docutils literal" > < span class = "pre" > t< / span > < / tt > .< / td >
2003-08-05 19:48:41 +00:00
< / tr >
< / tbody >
< / table >
2005-05-20 15:32:55 +00:00
< p > < tt class = "docutils literal" > < span class = "pre" > function_output_iterator& < / span > < span class = "pre" > operator++();< / span > < / tt > < / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
2003-08-05 19:48:41 +00:00
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
2005-05-20 15:32:55 +00:00
< tr class = "field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > < tt class = "docutils literal" > < span class = "pre" > *this< / span > < / tt > < / td >
2003-08-05 19:48:41 +00:00
< / tr >
< / tbody >
< / table >
2005-05-20 15:32:55 +00:00
< p > < tt class = "docutils literal" > < span class = "pre" > function_output_iterator& < / span > < span class = "pre" > operator++(int);< / span > < / tt > < / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
2003-08-05 19:48:41 +00:00
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
2005-05-20 15:32:55 +00:00
< tr class = "field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > < tt class = "docutils literal" > < span class = "pre" > *this< / span > < / tt > < / td >
2003-08-05 19:48:41 +00:00
< / tr >
< / tbody >
< / table >
2006-09-11 22:27:29 +00:00
<!-- Copyright David Abrahams 2006. Distributed under the Boost -->
<!-- Software License, Version 1.0. (See accompanying -->
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
2003-08-05 19:48:41 +00:00
< / div >
2006-09-11 22:27:29 +00:00
< div class = "section" >
< h1 > < a class = "toc-backref" href = "#id5" id = "example" name = "example" > Example< / a > < / h1 >
2004-01-12 04:17:26 +00:00
< pre class = "literal-block" >
struct string_appender
{
string_appender(std::string& s)
: m_str(& s)
{}
void operator()(const std::string& x) const
{
*m_str += x;
}
std::string* m_str;
};
int main(int, char*[])
{
std::vector< std::string> x;
x.push_back(" hello" );
x.push_back(" " );
x.push_back(" world" );
x.push_back(" !" );
std::string s = " " ;
2006-09-11 22:27:29 +00:00
std::copy(x.begin(), x.end(),
2004-01-12 04:17:26 +00:00
boost::make_function_output_iterator(string_appender(s)));
std::cout < < s < < std::endl;
return 0;
}
< / pre >
2003-08-05 19:48:41 +00:00
< / div >
2004-01-12 02:49:55 +00:00
< / div >
2003-08-05 19:48:41 +00:00
< / body >
< / html >
