STK_DenseIteratorBase.h

Go to the documentation of this file.

 
/*--------------------------------------------------------------------*/
/*     Copyright (C) 2004-2016  Serge Iovleff, Université Lille 1, Inria
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as
    published by the Free Software Foundation; either version 2 of the
    License, or (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.
 
    You should have received a copy of the GNU Lesser General Public
    License along with this program; if not, write to the
    Free Software Foundation, Inc.,
    59 Temple Place,
    Suite 330,
    Boston, MA 02111-1307
    USA
 
    Contact : S..._Dot_I..._At_stkpp_Dot_org (see copyright for ...)
*/
 
/*
 * Project:  stkpp::Arrays
 * created on: 28 marsh 2017
 * Author:   iovleff, S..._Dot_I..._At_stkpp_Dot_org (see copyright for ...)
 **/
 
#ifndef STK_DENSEITERATORBASE_H
#define STK_DENSEITERATORBASE_H
 
namespace STK
{
namespace hidden
{
template <typename Derived> struct IteratorTraits;
 
} // namespace hidden
 
template<class Derived>
struct DenseIteratorBase: public IRecursiveTemplate<Derived>
{
    typedef typename hidden::IteratorTraits<Derived>::Index Index;
 
    typedef typename hidden::IteratorTraits<Derived>::iterator_category iterator_category;
    typedef typename hidden::IteratorTraits<Derived>::value_type value_type;
    typedef typename hidden::IteratorTraits<Derived>::reference reference;
    typedef typename hidden::IteratorTraits<Derived>::pointer pointer;
    typedef typename hidden::IteratorTraits<Derived>::difference_type difference_type;
 
  protected:
    DenseIteratorBase(): pos_(baseIdx) {}
    DenseIteratorBase( Index pos): pos_(pos) {}
    DenseIteratorBase( DenseIteratorBase const& it):  pos_(it.pos_) {}
    ~DenseIteratorBase() {}
 
  public:
    inline Index pos() const  { return pos_;}
 
    // moving
    Derived& operator++()         { ++pos_; return this->asDerived(); }
    Derived& operator++(int junk) { ++pos_; return this->asDerived(); }
    Derived& operator--()         { --pos_; return this->asDerived(); }
    Derived& operator--(int)      { --pos_; return this->asDerived(); }
    Derived& operator+=(Index n)    { pos_+=n; return this->asDerived(); }
    Derived& operator-=(Index n)    { pos_-=n; return this->asDerived(); }
 
    friend DenseIteratorBase operator+( DenseIteratorBase const& it, int n)
    { DenseIteratorBase r(it); r+=n ; return r; }
    friend DenseIteratorBase operator+(int n, DenseIteratorBase const& it)
    { DenseIteratorBase r(it); r+=n ; return r; }
    friend DenseIteratorBase operator-( DenseIteratorBase const& it, int n)
    { DenseIteratorBase r(it); r-=n ; return r; }
    friend DenseIteratorBase operator-(int n, DenseIteratorBase const& it)
    { DenseIteratorBase r(it); r-=n ; return r; }
 
    friend bool operator<(DenseIteratorBase const& lhs, DenseIteratorBase const& rhs)
    { return lhs.pos_ < rhs.pos_; };
    friend bool operator>(DenseIteratorBase const& lhs, DenseIteratorBase const& rhs)
    { return lhs.pos_ > rhs.pos_; };
    friend bool operator<=(DenseIteratorBase const& lhs, DenseIteratorBase const& rhs)
    { return lhs.pos_ <= rhs.pos_; };
    friend bool operator>=(DenseIteratorBase const& lhs, DenseIteratorBase const& rhs)
    { return lhs.pos_ >= rhs.pos_; };
 
    // misc
    friend void swap(DenseIteratorBase& lhs, DenseIteratorBase& rhs)
    { std::swap(lhs.pos_, rhs.pos_);}
    friend difference_type operator-(DenseIteratorBase it1, DenseIteratorBase it2)
    { return it1.pos_ - it2.pos_;}
 
 
  protected:
    Index pos_;
};
 
 
} // namespace STK
 
#endif /* STK_DENSEITERATORBASE_H */