Changeset 3153

Timestamp:

Jan 3, 2014, 7:39:09 AM (10 years ago)

Author:

Peter

Message:

document OstreamIterator? closes #770

File:

• trunk/yat/utility/OstreamIterator.h (modified) (3 diffs)

trunk/yat/utility/OstreamIterator.h

@@ -27 +27 @@
 #include <boost/function_output_iterator.hpp>
 
-#include <iterator>
+#include <functional>
 #include <ostream>
 #include <string>
@@ -73 +73 @@
 
   /**
+     OstreamIterator is an \output_iterator. Just like <a
+     href="http://www.sgi.com/tech/stl/ostream_iterator.html">
+     std::ostream_iterator</a> it uses \c operator<<(ostream&, T) to
+     send formatted output to a particular ostream. While <a
+     href="http://www.sgi.com/tech/stl/ostream_iterator.html">
+     std::ostream_iterator</a> inserts a string \a delimited after
+     each element, OstreamIterator only inserts \a delimiter between
+     elements.
+
+     \code
+     vector<int> x(3);
+     x[0] = 2;
+     x[1] = 3;
+     x[2] = 5;
+     copy(x.begin(), x.end(), OstreamIterator<int>(cout, ", "));
+     \endcode
+     which will give output: 2, 3, 5
+
      \since New in yat 0.12
   */
@@ -89 +107 @@
     /**
        \brief Constructor
-       \param os istream to extract string elements from.
-       \param delimiter the delimiting character.
+
+       Creates an OstreamIterator such that assignment of `t` through
+       it is equivalent to os << delimiter << t just like
+       std::ostream_iterator. The exception is that first time
+       OstreamIterator is derefenced the delimiter is excluded in
+       order to get the desired behaviour that delimiter only occurs
+       between elements.
+
+       \param os ostream to send output
+       \param delimiter the delimiting string
     */
     explicit OstreamIterator(std::ostream& os, const std::string& delimiter="")