fix doc example typo
[boost.git] / boost / generator_iterator.hpp
blobebf478b25b773724b270cd6805f07ddea58f255f
1 // (C) Copyright Jens Maurer 2001.
2 // Distributed under the Boost Software License, Version 1.0. (See
3 // accompanying file LICENSE_1_0.txt or copy at
4 // http://www.boost.org/LICENSE_1_0.txt)
5 //
6 // Revision History:
8 // 15 Nov 2001 Jens Maurer
9 // created.
11 // See http://www.boost.org/libs/utility/iterator_adaptors.htm for documentation.
13 #ifndef BOOST_ITERATOR_ADAPTOR_GENERATOR_ITERATOR_HPP
14 #define BOOST_ITERATOR_ADAPTOR_GENERATOR_ITERATOR_HPP
16 #include <boost/iterator/iterator_facade.hpp>
17 #include <boost/ref.hpp>
19 namespace boost {
21 template<class Generator>
22 class generator_iterator
23 : public iterator_facade<
24 generator_iterator<Generator>
25 , typename Generator::result_type
26 , single_pass_traversal_tag
27 , typename Generator::result_type const&
30 typedef iterator_facade<
31 generator_iterator<Generator>
32 , typename Generator::result_type
33 , single_pass_traversal_tag
34 , typename Generator::result_type const&
35 > super_t;
37 public:
38 generator_iterator() {}
39 generator_iterator(Generator* g) : m_g(g), m_value((*m_g)()) {}
41 void increment()
43 m_value = (*m_g)();
46 const typename Generator::result_type&
47 dereference() const
49 return m_value;
52 bool equal(generator_iterator const& y) const
54 return this->m_g == y.m_g && this->m_value == y.m_value;
57 private:
58 Generator* m_g;
59 typename Generator::result_type m_value;
62 template<class Generator>
63 struct generator_iterator_generator
65 typedef generator_iterator<Generator> type;
68 template <class Generator>
69 inline generator_iterator<Generator>
70 make_generator_iterator(Generator & gen)
72 typedef generator_iterator<Generator> result_t;
73 return result_t(&gen);
76 } // namespace boost
79 #endif // BOOST_ITERATOR_ADAPTOR_GENERATOR_ITERATOR_HPP