strided.hpp 12.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
// Boost.Range library
//
//  Copyright Neil Groves 2007. Use, modification and
//  distribution is subject to 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)
//
//
// For more information, see http://www.boost.org/libs/range/
//
#ifndef BOOST_RANGE_ADAPTOR_STRIDED_HPP_INCLUDED
#define BOOST_RANGE_ADAPTOR_STRIDED_HPP_INCLUDED

#include <boost/range/adaptor/argument_fwd.hpp>
#include <boost/range/iterator_range.hpp>
#include <boost/iterator/iterator_adaptor.hpp>
#include <iterator>

namespace boost
{
    namespace range_detail
    {
        // strided_iterator for wrapping a forward traversal iterator
        template<class BaseIterator, class Category>
        class strided_iterator
            : public iterator_adaptor<
                strided_iterator<BaseIterator, Category>
              , BaseIterator
              , use_default
              , boost::forward_traversal_tag
            >
        {
            friend class ::boost::iterator_core_access;

            typedef iterator_adaptor<
                        strided_iterator<BaseIterator, Category>
                      , BaseIterator
                      , use_default
                      , boost::forward_traversal_tag
                    > super_t;

        public:
            typedef BOOST_DEDUCED_TYPENAME std::iterator_traits<BaseIterator>::difference_type difference_type;
            typedef BaseIterator base_iterator;

            strided_iterator()
                : m_last()
                , m_stride()
            {
            }

            strided_iterator(base_iterator first, base_iterator it, base_iterator last, difference_type stride)
                : super_t(it)
                , m_last(last)
                , m_stride(stride)
            {
            }

            template<class OtherIterator>
            strided_iterator(const strided_iterator<OtherIterator, Category>& other,
                             BOOST_DEDUCED_TYPENAME enable_if_convertible<OtherIterator, base_iterator>::type* = 0)
                : super_t(other)
                , m_last(other.base_end())
                , m_stride(other.get_stride())
            {
            }

            base_iterator base_end() const { return m_last; }
            difference_type get_stride() const { return m_stride; }

        private:
            void increment()
            {
                base_iterator& it = this->base_reference();
                for (difference_type i = 0; (it != m_last) && (i < m_stride); ++i)
                    ++it;
            }

            base_iterator m_last;
            difference_type m_stride;
        };

        // strided_iterator for wrapping a bidirectional iterator
        template<class BaseIterator>
        class strided_iterator<BaseIterator, bidirectional_traversal_tag>
            : public iterator_adaptor<
                strided_iterator<BaseIterator, bidirectional_traversal_tag>
              , BaseIterator
              , use_default
              , bidirectional_traversal_tag
            >
        {
            friend class ::boost::iterator_core_access;

            typedef iterator_adaptor<
                        strided_iterator<BaseIterator, bidirectional_traversal_tag>
                      , BaseIterator
                      , use_default
                      , bidirectional_traversal_tag
                    > super_t;
        public:
            typedef BOOST_DEDUCED_TYPENAME std::iterator_traits<BaseIterator>::difference_type difference_type;
            typedef BaseIterator base_iterator;

            strided_iterator()
                : m_first()
                , m_last()
                , m_stride()
            {
            }

            strided_iterator(base_iterator first, base_iterator it, base_iterator last, difference_type stride)
                : super_t(it)
                , m_first(first)
                , m_last(last)
                , m_stride(stride)
            {
            }

            template<class OtherIterator>
            strided_iterator(const strided_iterator<OtherIterator, bidirectional_traversal_tag>& other,
                             BOOST_DEDUCED_TYPENAME enable_if_convertible<OtherIterator, base_iterator>::type* = 0)
                : super_t(other.base())
                , m_first(other.base_begin())
                , m_last(other.base_end())
                , m_stride(other.get_stride())
            {
            }

            base_iterator base_begin() const { return m_first; }
            base_iterator base_end() const { return m_last; }
            difference_type get_stride() const { return m_stride; }

        private:
            void increment()
            {
                base_iterator& it = this->base_reference();
                for (difference_type i = 0; (it != m_last) && (i < m_stride); ++i)
                    ++it;
            }

            void decrement()
            {
                base_iterator& it = this->base_reference();
                for (difference_type i = 0; (it != m_first) && (i < m_stride); ++i)
                    --it;
            }

            base_iterator m_first;
            base_iterator m_last;
            difference_type m_stride;
        };

        // strided_iterator implementation for wrapping a random access iterator
        template<class BaseIterator>
        class strided_iterator<BaseIterator, random_access_traversal_tag>
            : public iterator_adaptor<
                        strided_iterator<BaseIterator, random_access_traversal_tag>
                      , BaseIterator
                      , use_default
                      , random_access_traversal_tag
                    >
        {
            friend class ::boost::iterator_core_access;

            typedef iterator_adaptor<
                        strided_iterator<BaseIterator, random_access_traversal_tag>
                      , BaseIterator
                      , use_default
                      , random_access_traversal_tag
                    > super_t;
        public:
            typedef BOOST_DEDUCED_TYPENAME super_t::difference_type difference_type;
            typedef BaseIterator base_iterator;

            strided_iterator()
                : m_first()
                , m_last()
                , m_index(0)
                , m_stride()
            {
            }

            strided_iterator(BaseIterator first, BaseIterator it, BaseIterator last, difference_type stride)
                : super_t(it)
                , m_first(first)
                , m_last(last)
                , m_index(stride ? (it - first) / stride : 0)
                , m_stride(stride)
            {
            }

            template<class OtherIterator>
            strided_iterator(const strided_iterator<OtherIterator, random_access_traversal_tag>& other,
                             BOOST_DEDUCED_TYPENAME enable_if_convertible<OtherIterator, BaseIterator>::type* = 0)
                : super_t(other.base())
                , m_first(other.base_begin())
                , m_last(other.base_end())
                , m_index(other.get_index())
                , m_stride(other.get_stride())
            {
            }

            base_iterator base_begin() const { return m_first; }
            base_iterator base_end() const { return m_last; }
            difference_type get_stride() const { return m_stride; }
            difference_type get_index() const { return m_index; }

        private:
            void increment()
            {
                m_index += m_stride;
                if (m_index < (m_last - m_first))
                    this->base_reference() = m_first + m_index;
                else
                    this->base_reference() = m_last;
            }

            void decrement()
            {
                m_index -= m_stride;
                if (m_index >= 0)
                    this->base_reference() = m_first + m_index;
                else
                    this->base_reference() = m_first;
            }

            void advance(difference_type offset)
            {
                offset *= m_stride;
                m_index += offset;
                if (m_index < 0)
                    this->base_reference() = m_first;
                else if (m_index > (m_last - m_first))
                    this->base_reference() = m_last;
                else
                    this->base_reference() = m_first + m_index;
            }

            template<class OtherIterator>
            difference_type distance_to(const strided_iterator<OtherIterator, random_access_traversal_tag>& other,
                                        BOOST_DEDUCED_TYPENAME enable_if_convertible<OtherIterator, BaseIterator>::type* = 0) const
            {
                if (other.base() >= this->base())
                    return (other.base() - this->base() + (m_stride - 1)) / m_stride;
                return (other.base() - this->base() - (m_stride - 1)) / m_stride;
            }

            bool equal(const strided_iterator& other) const
            {
                return this->base() == other.base();
            }

        private:
            base_iterator m_first;
            base_iterator m_last;
            difference_type m_index;
            difference_type m_stride;
        };

        template<class BaseIterator, class Difference> inline
        strided_iterator<BaseIterator, BOOST_DEDUCED_TYPENAME iterator_traversal<BaseIterator>::type>
        make_strided_iterator(BaseIterator first, BaseIterator it,
                              BaseIterator last, Difference stride)
        {
            BOOST_ASSERT( stride >= 0 );
            typedef BOOST_DEDUCED_TYPENAME iterator_traversal<BaseIterator>::type traversal_tag;
            return strided_iterator<BaseIterator, traversal_tag>(first, it, last, stride);
        }

        template< class Rng
                , class Category = BOOST_DEDUCED_TYPENAME iterator_traversal<
                                    BOOST_DEDUCED_TYPENAME range_iterator<Rng>::type
                                   >::type
         >
        class strided_range
            : public iterator_range<
                        range_detail::strided_iterator<
                            BOOST_DEDUCED_TYPENAME range_iterator<Rng>::type,
                            Category
                        >
                     >
        {
            typedef range_detail::strided_iterator<
                        BOOST_DEDUCED_TYPENAME range_iterator<Rng>::type,
                        Category
                    > iter_type;
            typedef iterator_range<iter_type> super_t;
        public:
            template<class Difference>
            strided_range(Difference stride, Rng& rng)
                : super_t(make_strided_iterator(boost::begin(rng), boost::begin(rng), boost::end(rng), stride),
                          make_strided_iterator(boost::begin(rng), boost::end(rng), boost::end(rng), stride))
            {
                BOOST_ASSERT( stride >= 0 );
            }
        };

        template<class Difference>
        class strided_holder : public holder<Difference>
        {
        public:
            explicit strided_holder(Difference value) : holder<Difference>(value) {}
        };

        template<class Rng, class Difference>
        inline strided_range<Rng>
        operator|(Rng& rng, const strided_holder<Difference>& stride)
        {
            return strided_range<Rng>(stride.val, rng);
        }

        template<class Rng, class Difference>
        inline strided_range<const Rng>
        operator|(const Rng& rng, const strided_holder<Difference>& stride)
        {
            return strided_range<const Rng>(stride.val, rng);
        }

    } // namespace range_detail

    using range_detail::strided_range;

    namespace adaptors
    {

        namespace
        {
            const range_detail::forwarder<range_detail::strided_holder>
                strided = range_detail::forwarder<range_detail::strided_holder>();
        }

        template<class Range, class Difference>
        inline strided_range<Range>
        stride(Range& rng, Difference step)
        {
            return strided_range<Range>(step, rng);
        }

        template<class Range, class Difference>
        inline strided_range<const Range>
        stride(const Range& rng, Difference step)
        {
            return strided_range<const Range>(step, rng);
        }

    } // namespace 'adaptors'
} // namespace 'boost'

#endif