iterator2d_box.hpp

Go to the documentation of this file.

/*
 * Copyright(c):
 * Signal Image and Communications (SIC) Department 
 * http://www.sic.sp2mi.univ-poitiers.fr/ 
 *  - University of Poitiers, France http://www.univ-poitiers.fr 
 *  - XLIM  Institute UMR CNRS 7252  http://www.xlim.fr/ 
 * 
 * and 
 * 
 * D2 Fluid, Thermic and Combustion 
 *  - University of Poitiers, France http://www.univ-poitiers.fr 
 *  - PPRIME Institute -  UPR CNRS 3346  http://www.pprime.fr
 *  - ISAE-ENSMA http://www.ensma.fr
 *
 * Contributor(s):
 * The SLIP team,
 * Benoit Tremblais <tremblais_AT_sic.univ-poitiers.fr>,
 * Laurent David <laurent.david_AT_lea.univ-poitiers.fr>, 
 * Ludovic Chatellier <ludovic.chatellier_AT_univ-poitiers.fr>, 
 * Lionel Thomas <lionel.thomas_AT_univ-poitiers.fr>, 
 * Denis Arrivault <arrivault_AT_sic.univ-poitiers.fr>, 
 * Julien Dombre <julien.dombre_AT_univ-poitiers.fr>.
 *
 * Description:
 * The Simple Library of Image Processing (SLIP) is a new image processing 
 * library. It is written in the C++ language following as much as possible 
 * the ISO/ANSI C++ standard. It is consequently compatible with any system  
 * satisfying the ANSI C++ complience. It works on different Unix , Linux ,  
 * Mircrosoft Windows and Mac OS X plateforms. SLIP is a research library that  
 * was created by the Signal, Image and Communications (SIC) departement of  
 * the XLIM, UMR 7252 CNRS Institute in collaboration with the Fluids, Thermic  
 * and Combustion departement of the P', UPR 3346 CNRS Institute of the  
 * University of Poitiers.
 * 
 * The SLIP Library source code has been registered to the APP (French Agency 
 * for the Protection of Programs) by the University of Poitiers and CNRS, 
 * under  registration number IDDN.FR.001.300034.000.S.P.2010.000.21000.

 * http://www.sic.sp2mi.univ-poitiers.fr/slip/
 *
 * This software is governed by the CeCILL-C license under French law and
 * abiding by the rules of distribution of free software.  You can  use, 
 * modify and/ or redistribute the software under the terms of the CeCILL-C 
 * license as circulated by CEA, CNRS and INRIA at the following URL 
 * http://www.cecill.info.
 * As a counterpart to the access to the source code and  rights to copy,
 * modify and redistribute granted by the license, users are provided only
 * with a limited warranty  and the software's author,  the holder of the
 * economic rights,  and the successive licensors  have only  limited
 * liability.
 * 
 * In this respect, the user's attention is drawn to the risks associated
 * with loading,  using,  modifying and/or developing or reproducing the
 * software by the user in light of its specific status of free software,
 * that may mean  that it is complicated to manipulate,  and  that  also
 * therefore means  that it is reserved for developers  and  experienced
 * professionals having in-depth computer knowledge. Users are therefore
 * encouraged to load and test the software's suitability as regards their
 * requirements in conditions enabling the security of their systems and/or
 * data to be ensured and,  more generally, to use and operate it in the 
 * same conditions as regards security. 
 *
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL-C license and that you accept its terms.
 */


#ifndef SLIP_ITERATOR2D_BOX_HPP
#define SLIP_ITERATOR2D_BOX_HPP

#include <iterator>
#include <cassert>

#include "Point2d.hpp"
#include "DPoint2d.hpp"
#include "Box2d.hpp"
#include "Range.hpp"

#include "iterator_types.hpp"

namespace slip
{
template <class Container2D>
class iterator2d_box  
{
public:
  //typedef std::random_access_iterator_tag iterator_category;
  typedef std::random_access_iterator2d_tag iterator_category;
  typedef typename Container2D::value_type value_type;
  typedef DPoint2d<int> difference_type;
  typedef typename Container2D::pointer pointer;
  typedef typename Container2D::reference reference;

  typedef iterator2d_box self;

  typedef typename Container2D::size_type size_type;
  
  iterator2d_box():
    cont2d_(0),pos_(0),x1_(0),x2_(0),box_(0,0,0,0)
  {}

  iterator2d_box(Container2D* c,
                                 const Box2d<int>& b):
    cont2d_(c),pos_((*c)[(b.upper_left())[0]] + (b.upper_left())[1]),x1_((b.upper_left())[0]),x2_((b.upper_left())[1]),box_(b)
  {}

  iterator2d_box(const self& o):
    cont2d_(o.cont2d_),pos_(o.pos_),x1_(o.x1_),x2_(o.x2_),box_(o.box_)
  {}

  self& operator=(const self& o)
  {
    if(this != &o)
      {
                this->cont2d_ = o.cont2d_;
                this->pos_ = o.pos_;
                this->x1_ = o.x1_;
                this->x2_ = o.x2_;
                this->box_ = o.box_;
      }
    return *this;
  }
  inline
  reference operator*()
  {
    return *pos_;
  }

  inline
  pointer operator->()
  { 
    return &(operator*()); 
  }

  
  inline
  self& operator++()
  {
    if( (x1_ != (box_.bottom_right())[0]) || (x2_ != (box_.bottom_right())[1]) )
      {
                if( (x2_ < (box_.bottom_right())[1]) || (x1_ == (box_.bottom_right())[0]))
                  {
                    this->x2_++;
                    this->pos_++;
                  }
                else
                  {
                    this->x1_++;
                    this->x2_ = (box_.upper_left())[1];
                    this->pos_ = cont2d_->begin() + (this->x1_ * int(cont2d_->cols())) + this->x2_; 
                  }
      }
    else
      {
                this->x1_ = (box_.bottom_right())[0] + 1;
                this->x2_ = (box_.bottom_right())[1] + 1;
                this->pos_ = cont2d_->begin() + (this->x1_ * int(cont2d_->cols())) + this->x2_; 
      }

    return *this;
  }

  inline
  self operator++(int)
  {
    self tmp = *this;
    ++(*this);
    return tmp;
  }

  inline
  self& operator--()
  {
    if( (x1_ != (box_.upper_left())[0]) || (x2_ != (box_.upper_left())[1]) )
      {
                if( (x2_ > (box_.upper_left())[1])|| (x1_ == (box_.upper_left())[0]))
                  {
                    this->x2_--;
                    this->pos_--;
                  }
                else
                  {
                    this->x1_--;
                    this->x2_ = (box_.bottom_right())[1];
                    this->pos_ = cont2d_->begin() + (this->x1_ * int(cont2d_->cols())) + this->x2_; 
                  }
      }
     else
       {
                 this->x1_ = (box_.upper_left())[0] - 1;
                 this->x2_ = (box_.upper_left())[1] - 1;
                 this->pos_ = cont2d_->begin() + (this->x1_ * int(cont2d_->cols())) + this->x2_; 
       }

    return *this;
  }
  
  inline
  self operator--(int)
  {
    self tmp = *this;
    --(*this);
    return tmp;
  }

  inline
  friend bool operator==(const self& i1,
                                                 const self& i2)
  {
    
    return ( (i1.cont2d_ == i2.cont2d_) && (i1.pos_ == i2.pos_) 
                     && (i1.x1_ == i2.x1_) && (i1.x2_ == i2.x2_) );
  }

  inline
  friend bool operator!=(const self& i1,
                                                 const self& i2)
  {
    return ( (i1.cont2d_ != i2.cont2d_) || (i1.pos_ != i2.pos_)
    || (i1.x1_ != i2.x1_) || (i1.x2_ != i2.x2_) );
  }
  inline
  friend bool operator<(const self& i1,
                                                const self& i2)
  {
    
    return ( i1.pos_ < i2.pos_);
  }

  inline
  friend bool operator>(const self& i1,
                                                const self& i2)
  {
    
    return (i2 < i1);
  }
  
  inline
  friend bool operator<=(const self& i1,
                                                 const self& i2)
  {
    
    return  !(i2 < i1);
  }

  inline
  friend bool operator>=(const self& i1,
                                                 const self& i2)
  {
    
    return  !(i1 < i2);
  }
  inline
  self& operator+=(const difference_type& d)
  {
    this->x1_ += d.dx1();
    this->x2_ += d.dx2();
    this->pos_ = cont2d_->begin() + (this->x1_ * int(cont2d_->cols())) + this->x2_; 
    return *this;
  }

 
  
  inline
  self& operator-=(const difference_type& d)
  {
    this->x1_ -= d.dx1();
    this->x2_ -= d.dx2();
    this->pos_ = cont2d_->begin() + (this->x1_ * int(cont2d_->cols())) + this->x2_; 
    return *this;
  }
  

   
  inline
  self operator+(const difference_type& d)
  {
    self tmp = *this;
    tmp += d;
    return tmp;
  }

 
  
  inline
  self operator-(const difference_type& d)
  {
    self tmp = *this;
    tmp -= d;
    return tmp;
  }

  
  

  inline
  friend difference_type operator-(const self& i1,
                                                                   const self& i2)
  {
    return difference_type(int(i1.x1_ - i2.x1_),int(i1.x2_ - i2.x2_));
  }
  
  
  inline
  reference operator[](difference_type d)
  {
    assert( (int(this->x1_)+d.dx1()) < int(cont2d_->dim1()) );
    assert( (int(this->x2_)+d.dx2()) < int(cont2d_->dim2()) );
    return (*cont2d_)[this->x1_+d.dx1()][this->x2_+d.dx2()];
  }



  inline
  typename Container2D::row_iterator row_begin(size_type row)
  {
    return cont2d_->row_begin(this->box_.upper_left()[0] + row) + this->box_.upper_left()[1];
  }


  inline
  typename Container2D::row_iterator row_end(size_type row)
  {
    return this->row_begin(row) + this->box_.width();
  }


  inline
  typename Container2D::reverse_row_iterator row_rbegin(size_type row)
  {
    return  typename Container2D::reverse_row_iterator(this->row_end(row));
  }
  
  inline
  typename Container2D::reverse_row_iterator row_rend(size_type row)
  {
    return  typename Container2D::reverse_row_iterator(this->row_begin(row));
  }
 

  inline
  typename Container2D::col_iterator col_begin(size_type col)
  {
     return cont2d_->col_begin(this->box_.upper_left()[1] + col) +  this->box_.upper_left()[0];
  }



  inline
  typename Container2D::col_iterator col_end(size_type col)
  {
    return this->col_begin(col) + this->box_.height();
  }


  inline
  typename Container2D::reverse_col_iterator col_rbegin(size_type col)
  {
    return  typename Container2D::reverse_col_iterator(this->col_end(col));
  }
  
  inline
  typename Container2D::reverse_col_iterator col_rend(size_type col)
  {
    return  typename Container2D::reverse_col_iterator(this->col_begin(col));
  }
 

  inline
  typename Container2D::row_range_iterator row_begin(size_type row, const slip::Range<int>& range)
  {
    return slip::stride_iterator<typename Container2D::row_iterator>(cont2d_->row_begin(this->box_.upper_left()[0] + row) + this->box_.upper_left()[1] + range.start(),range.stride());
  }


  inline
  typename Container2D::row_range_iterator row_end(size_type row, const slip::Range<int>& range)
  {
    return ++(this->row_begin(row,range)+ range.iterations());
  }

  inline
  typename Container2D::col_range_iterator col_begin(size_type col, const slip::Range<int>& range)
  {
    return slip::stride_iterator<typename Container2D::col_iterator>(cont2d_->col_begin(this->box_.upper_left()[1] + col) + this->box_.upper_left()[0] + range.start(),range.stride());
  }



  inline
  typename Container2D::col_range_iterator col_end(size_type col, const slip::Range<int>& range)
  {
    return ++(this->col_begin(col,range)+ range.iterations());
  }

  inline
  int x1() const
  {
    return this->x1_;
  }
  inline
  int i() const
  {
    return this->x1_;
  }
  inline
  int x2() const
  {
    return this->x2_;
  }
  inline
  int j() const
  {
    return this->x2_;
  }
  
private: 
  Container2D* cont2d_; // pointer to the 2d container
  pointer pos_;         // linear position within the container
  int x1_;              // first index position 
  int x2_;              // second index position
  Box2d<int> box_;      // box to iterate 
};


template <class Container2D>
class const_iterator2d_box  
{
public:
  //typedef std::random_access_iterator_tag iterator_category;
  typedef std::random_access_iterator2d_tag iterator_category;
  typedef typename Container2D::value_type value_type;
  typedef DPoint2d<int> difference_type;
  typedef typename Container2D::const_pointer pointer;
  typedef typename Container2D::const_reference reference;

  typedef const_iterator2d_box self;

  typedef typename Container2D::size_type size_type;
  
  const_iterator2d_box():
    cont2d_(0),pos_(0),x1_(0),x2_(0),box_(0,0,0,0)
  {}

  const_iterator2d_box(Container2D* c,
                                 const Box2d<int>& b):
    cont2d_(c),pos_((*c)[(b.upper_left())[0]] + (b.upper_left())[1]),x1_((b.upper_left())[0]),x2_((b.upper_left())[1]),box_(b)
  {}

  const_iterator2d_box(const self& o):
    cont2d_(o.cont2d_),pos_(o.pos_),x1_(o.x1_),x2_(o.x2_),box_(o.box_)
  {}

  self& operator=(const self& o)
  {
    if(this != &o)
      {
                this->cont2d_ = o.cont2d_;
                this->pos_ = o.pos_;
                this->x1_ = o.x1_;
                this->x2_ = o.x2_;
                this->box_ = o.box_;
      }
    return *this;
  }
  inline
  reference operator*() const
  {
    return *pos_;
  }


  inline
  pointer operator->() const
  { 
    return &(operator*()); 
  }

  
  inline
  self& operator++()
  {
    if( (x1_ != (box_.bottom_right())[0]) || (x2_ != (box_.bottom_right())[1]) )
      {
                if( (x2_ < (box_.bottom_right())[1]) || (x1_ == (box_.bottom_right())[0]))
                  {
                    this->x2_++;
                    this->pos_++;
                  }
                else
                  {
                    this->x1_++;
                    this->x2_ = (box_.upper_left())[1];
                    this->pos_ = cont2d_->begin() + (this->x1_ * int(cont2d_->cols())) + this->x2_; 
                  }
      }
    else
       {
                 this->x1_ = (box_.bottom_right())[0] + 1;
                 this->x2_ = (box_.bottom_right())[1] + 1;
                 this->pos_ = cont2d_->begin() + (this->x1_ * int(cont2d_->cols())) + this->x2_; 
       }
    return *this;
  }

  inline
  self operator++(int)
  {
    self tmp = *this;
    ++(*this);
    return tmp;
  }

  inline
  self& operator--()
  {
      if( (x1_ != (box_.upper_left())[0]) || (x2_ != (box_.upper_left())[1]) )
      {
                if( (x2_ > (box_.upper_left())[1])|| (x1_ == (box_.upper_left())[0]))
                  {
                    this->x2_--;
                    this->pos_--;
                  }
                else
                  {
                    this->x1_--;
                    this->x2_ = (box_.bottom_right())[1];
                    this->pos_ = cont2d_->begin() + (this->x1_ * int(cont2d_->cols())) + this->x2_; 
                  }
      }
     else
       {
                 this->x1_ = (box_.upper_left())[0] - 1;
                 this->x2_ = (box_.upper_left())[1] - 1;
                 this->pos_ = cont2d_->begin() + (this->x1_ * int(cont2d_->cols())) + this->x2_; 
       }

    return *this;
  }
  
  inline
  self operator--(int)
  {
    self tmp = *this;
    --(*this);
    return tmp;
  }

  inline
  friend bool operator==(const self& i1,
                                                 const self& i2)
  {
    
    return ( (i1.cont2d_ == i2.cont2d_) && (i1.pos_ == i2.pos_) 
                     && (i1.x1_ == i2.x1_) && (i1.x2_ == i2.x2_) );
  }

  inline
  friend bool operator!=(const self& i1,
                                                 const self& i2)
  {
    return ( (i1.cont2d_ != i2.cont2d_) || (i1.pos_ != i2.pos_)
    || (i1.x1_ != i2.x1_) || (i1.x2_ != i2.x2_) );
  }
  inline
  friend bool operator<(const self& i1,
                                                const self& i2)
  {
    
    return ( i1.pos_ < i2.pos_);
  }

  inline
  friend bool operator>(const self& i1,
                                                const self& i2)
  {
    
    return (i2 < i1);
  }
  
  inline
  friend bool operator<=(const self& i1,
                                                 const self& i2)
  {
    
    return  !(i2 < i1);
  }

  inline
  friend bool operator>=(const self& i1,
                                                 const self& i2)
  {
    
    return  !(i1 < i2);
  }
  inline
  self& operator+=(const difference_type& d)
  {
    this->x1_ += d.dx1();
    this->x2_ += d.dx2();
    this->pos_ = cont2d_->begin() + (this->x1_ * int(cont2d_->cols())) + this->x2_; 
    return *this;
  }

 
  
  inline
  self& operator-=(const difference_type& d)
  {
    this->x1_ -= d.dx1();
    this->x2_ -= d.dx2();
    this->pos_ = cont2d_->begin() + (this->x1_ * int(cont2d_->cols())) + this->x2_; 
    return *this;
  }
  

   
  inline
  self operator+(const difference_type& d)
  {
    self tmp = *this;
    tmp += d;
    return tmp;
  }

 
  
  inline
  self operator-(const difference_type& d)
  {
    self tmp = *this;
    tmp -= d;
    return tmp;
  }

  
  

  inline
  friend difference_type operator-(const self& i1,
                                                                   const self& i2)
  {
    return difference_type(int(i1.x1_ - i2.x1_),int(i1.x2_ - i2.x2_));
  }
  
  
 
  inline
  reference operator[](difference_type d) const
  {
    assert( int(this->x1_+d.dx1()) < int(cont2d_->dim1()) );
    assert( int(this->x2_+d.dx2()) < int(cont2d_->dim2()) );
    return (*cont2d_)[this->x1_+d.dx1()][this->x2_+d.dx2()];
  }


 


  inline
  typename Container2D::const_row_iterator row_begin(size_type row) const
  {
    return cont2d_->row_begin(this->box_.upper_left()[0] + row) + this->box_.upper_left()[1];
  }

 
  inline
  typename Container2D::const_row_iterator row_end(size_type row) const
  {
    return this->row_begin(row) + this->box_.width();
  }

 
  inline
  typename Container2D::const_reverse_row_iterator row_rbegin(size_type row) const
  {
    return  typename Container2D::const_reverse_row_iterator(this->row_end(row));
  }
  

  
  inline
  typename Container2D::const_reverse_row_iterator row_rend(size_type row) const
  {
    return  typename Container2D::const_reverse_row_iterator(this->row_begin(row));
  }

  inline
  typename Container2D::const_col_iterator col_begin(size_type col) const
  {
    return cont2d_->col_begin(this->box_.upper_left()[1] + col) +  this->box_.upper_left()[0];
  }


  inline
  typename Container2D::const_col_iterator col_end(size_type col) const
  {
    return this->col_begin(col) + this->box_.height();
  }

  inline
  typename Container2D::const_reverse_col_iterator col_rbegin(size_type col) const
  {
    return  typename Container2D::const_reverse_col_iterator(this->col_end(col));
  }
  
  inline
  typename Container2D::const_reverse_col_iterator col_rend(size_type col) const
  {
    return  typename Container2D::const_reverse_col_iterator(this->col_begin(col));
  }
 

  inline
  int x1() const
  {
    return this->x1_;
  }
  inline
  int i() const
  {
    return this->x1_;
  }
  inline
  int x2() const
  {
    return this->x2_;
  }
  inline
  int j() const
  {
    return this->x2_;
  }
  
private: 
  Container2D* cont2d_; // pointer to the 2d container
  pointer pos_;         // linear position within the container
  int x1_;              // first index position 
  int x2_;              // second index position
  Box2d<int> box_;      // box to iterate 
};


 
}//slip::

#endif //SLIP_ITERATOR2D_BOX_HPP