component_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_COMPONENT_ITERATOR2D_BOX_HPP
#define SLIP_COMPONENT_ITERATOR2D_BOX_HPP

#include <iterator>
#include <cassert>

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

namespace slip
{
  template <class MultiComponentContainer2D, std::size_t N>
  class component_iterator2d_box  
  {
    
  public:
    
    //typedef std::random_access_iterator_tag iterator_category;
    typedef std::random_access_iterator2d_tag iterator_category;
    typedef typename MultiComponentContainer2D::value_type Block;
    typedef typename Block::value_type value_type;
    typedef DPoint2d<int> difference_type;
    typedef value_type* pointer;
    typedef value_type& reference;
    
    typedef component_iterator2d_box self;
    
    typedef typename MultiComponentContainer2D::size_type size_type;
    
    component_iterator2d_box():
      cont2d_(0),pos_(0),x1_(0),x2_(0),cp_(0),box_(0,0,0,0)
    {}
    
    component_iterator2d_box(MultiComponentContainer2D* c, std::size_t cp,
                                                     const Box2d<int>& b):
      cont2d_(c),pos_(&(*c)[0][0][cp] + ((b.upper_left())[0] * int(c->cols()) * N) + ((b.upper_left())[1] * N)),x1_((b.upper_left())[0]),x2_((b.upper_left())[1]),cp_(cp),box_(b)
    {}
    
    component_iterator2d_box(const self& o):
      cont2d_(o.cont2d_),pos_(o.pos_),x1_(o.x1_),x2_(o.x2_),cp_(o.cp_),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->cp_ = o.cp_;
                  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_+=N;
                    }
                  else
                    {
                      this->x1_++;
                      this->x2_ = (box_.upper_left())[1];
                      this->pos_ = &(*cont2d_)[0][0][this->cp_] + (this->x1_ * int(cont2d_->cols()) * N) + this->x2_ * N; 
                    }
                }
      else
                {
                  this->x1_ = (box_.bottom_right())[0] + 1;
                  this->x2_ = (box_.bottom_right())[1] + 1;
                  this->pos_ = &(*cont2d_)[0][0][this->cp_] + (this->x1_ * int(cont2d_->cols()) * N) + this->x2_ * N;
                }
      
      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_-=N;
                    }
                  else
                    {
                      this->x1_--;
                      this->x2_ = (box_.bottom_right())[1];
                      this->pos_ = &(*cont2d_)[0][0][this->cp_] + (this->x1_ * int(cont2d_->cols()) * N) + this->x2_ * N; 
                    }
                }
      else
                {
                  this->x1_ = (box_.upper_left())[0] - 1;
                  this->x2_ = (box_.upper_left())[1] - 1;
                  this->pos_ = &(*cont2d_)[0][0][this->cp_] + (this->x1_ * int(cont2d_->cols()) * N) + this->x2_ * N;
                }
      
      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_) 
                       && (i1.cp_ == i2.cp_));
    }
    
    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_) 
                       || (i1.cp_ != i2.cp_));
    }
    
    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_)[0][0][this->cp_] + (this->x1_ * int(cont2d_->cols()) * N) + this->x2_ * N;
      return *this;
    }
    
    
    
    inline
    self& operator-=(const difference_type& d)
    {
      this->x1_ -= d.dx1();
      this->x2_ -= d.dx2();
      this->pos_ = &(*cont2d_)[0][0][this->cp_] + (this->x1_ * int(cont2d_->cols()) * N) + this->x2_ * N; 
      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( (this->x1_+d.dx1()) < cont2d_->dim1() );
      assert( (this->x2_+d.dx2()) < cont2d_->dim2() );
      return (*cont2d_)[this->x1_+d.dx1()][this->x2_+d.dx2()][cp_];
    }
    
    
    inline
    typename MultiComponentContainer2D::component_row_iterator row_begin(size_type row)
    {
      return cont2d_->row_begin(this->cp_,this->box_.upper_left()[0] + row)+ this->box_.upper_left()[1];
    }
    
    
    inline
    typename MultiComponentContainer2D::component_row_iterator row_end(size_type row)
    {
      return this->row_begin(row) + this->box_.width();
    }
    
    
    inline
    typename MultiComponentContainer2D::component_col_iterator col_begin(size_type col)
    {
      return cont2d_->col_begin(this->cp_,this->box_.upper_left()[1] + col) + this->box_.upper_left()[0];
    }
    
    
     inline
    typename MultiComponentContainer2D::component_col_iterator col_end(size_type col)
    {
      return this->col_begin(col) + this->box_.height();
    }
    

    inline
    typename MultiComponentContainer2D::reverse_component_row_iterator row_rbegin(size_type row)
    {
      return typename MultiComponentContainer2D::reverse_component_row_iterator( typename MultiComponentContainer2D::component_row_iterator(cont2d_->row_begin(this->cp_,this->box_.upper_left()[0] + row)+ this->box_.upper_left()[1])+ this->box_.width());
    }
    
    
    inline
    typename   MultiComponentContainer2D::reverse_component_row_iterator row_rend(size_type row)
    {
      return typename MultiComponentContainer2D::reverse_component_row_iterator(cont2d_->row_begin(this->cp_,this->box_.upper_left()[0] + row)+ this->box_.upper_left()[1]);
     }

    inline
    typename MultiComponentContainer2D::reverse_component_col_iterator col_rbegin(size_type col)
    {
      return typename MultiComponentContainer2D::reverse_component_col_iterator( typename MultiComponentContainer2D::component_col_iterator(cont2d_->col_begin(this->cp_,this->box_.upper_left()[1] + col) + this->box_.upper_left()[0]) +  this->box_.height());
    }

    inline
    typename MultiComponentContainer2D::reverse_component_col_iterator col_rend(size_type col)
    {
      return typename MultiComponentContainer2D::reverse_component_col_iterator( typename MultiComponentContainer2D::component_col_iterator(cont2d_->col_begin(this->cp_,this->box_.upper_left()[1] + col) + this->box_.upper_left()[0]));
    }
    
    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_;
    }

    inline
    size_type cp() const
    {
      return this->cp_;
    }
    
    
  private: 
    MultiComponentContainer2D* cont2d_; // pointer to the 2d container
    pointer pos_;         // linear position within the container
    int x1_;              // first index position 
    int x2_;              // second index position
    size_type cp_;              // component index number
    Box2d<int> box_;      // box to iterate 
  };
  
 
  template <class MultiComponentContainer2D, std::size_t N>
  class const_component_iterator2d_box  
  {
    
  public:
    
    //typedef std::random_access_iterator_tag iterator_category;
    typedef std::random_access_iterator2d_tag iterator_category;
    typedef typename MultiComponentContainer2D::value_type Block;
    typedef typename Block::value_type value_type;
    typedef DPoint2d<int> difference_type;
    typedef value_type const * pointer;
    typedef value_type const & reference;
    
    typedef const_component_iterator2d_box self;
    
    typedef typename MultiComponentContainer2D::size_type size_type;
    
    const_component_iterator2d_box():
      cont2d_(0),pos_(0),x1_(0),x2_(0),cp_(0),box_(0,0,0,0)
    {}
    
    const_component_iterator2d_box(MultiComponentContainer2D* c, std::size_t cp,
                                                     const Box2d<int>& b):
      cont2d_(c),pos_(&(*c)[0][0][cp] + ((b.upper_left())[0] * int(c->cols()) * N) + ((b.upper_left())[1] * N)),x1_((b.upper_left())[0]),x2_((b.upper_left())[1]),cp_(cp),box_(b)
    {}
    
    const_component_iterator2d_box(const self& o):
      cont2d_(o.cont2d_),pos_(o.pos_),x1_(o.x1_),x2_(o.x2_),cp_(o.cp_),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->cp_ = o.cp_;
                  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_+=N;
                    }
                  else
                    {
                      this->x1_++;
                      this->x2_ = (box_.upper_left())[1];
                      this->pos_ = &(*cont2d_)[0][0][this->cp_] + (this->x1_ * int(cont2d_->cols()) * N) + this->x2_ * N; 
                    }
                }
      else
                {
                  this->x1_ = (box_.bottom_right())[0] + 1;
                  this->x2_ = (box_.bottom_right())[1] + 1;
                  this->pos_ = &(*cont2d_)[0][0][this->cp_] + (this->x1_ * int(cont2d_->cols()) * N) + this->x2_ * N;
                }
      
      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_-=N;
                    }
                  else
                    {
                      this->x1_--;
                      this->x2_ = (box_.bottom_right())[1];
                      this->pos_ = &(*cont2d_)[0][0][this->cp_] + (this->x1_ * int(cont2d_->cols()) * N) + this->x2_ * N; 
                    }
                }
      else
                {
                  this->x1_ = (box_.upper_left())[0] - 1;
                  this->x2_ = (box_.upper_left())[1] - 1;
                  this->pos_ = &(*cont2d_)[0][0][this->cp_] + (this->x1_ * int(cont2d_->cols()) * N) + this->x2_ * N;
                }
      
      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_) 
                       && (i1.cp_ == i2.cp_));
    }
    
    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_) 
                       || (i1.cp_ != i2.cp_));
    }
    
    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_)[0][0][this->cp_] + (this->x1_ * int(cont2d_->cols()) * N) + this->x2_ * N;
      return *this;
    }
    
    
    
    inline
    self& operator-=(const difference_type& d)
    {
      this->x1_ -= d.dx1();
      this->x2_ -= d.dx2();
      this->pos_ = &(*cont2d_)[0][0][this->cp_] + (this->x1_ * int(cont2d_->cols()) * N) + this->x2_ * N; 
      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( (this->x1_+d.dx1()) < cont2d_->dim1() );
      assert( (this->x2_+d.dx2()) < cont2d_->dim2() );
      return (*cont2d_)[this->x1_+d.dx1()][this->x2_+d.dx2()][cp_];
    }
    
    
    inline
    typename MultiComponentContainer2D::const_component_row_iterator row_begin(size_type row) const
    {
      return cont2d_->row_begin(this->cp_,this->box_.upper_left()[0] + row)+ this->box_.upper_left()[1];
    }
    
    
    inline
    typename MultiComponentContainer2D::const_component_row_iterator row_end(size_type row) const
    {
      return this->row_begin(row) + this->box_.width(); 
    }
    
    
    inline
    typename MultiComponentContainer2D::const_component_col_iterator col_begin(size_type col) const
    {
      return cont2d_->col_begin(this->cp_,this->box_.upper_left()[1] + col) + this->box_.upper_left()[0];
    }
    
    
    inline
    typename MultiComponentContainer2D::const_component_col_iterator col_end(size_type col) const
    {
      return this->col_begin(col) + this->box_.height();
    }
    
    inline
    typename MultiComponentContainer2D::const_reverse_component_row_iterator row_rbegin(size_type row) const
    {
      return typename MultiComponentContainer2D::const_reverse_component_row_iterator( typename MultiComponentContainer2D::const_component_row_iterator(cont2d_->row_begin(this->cp_,this->box_.upper_left()[0] + row)+ this->box_.upper_left()[1])+ this->box_.width());
    }
    
    
    inline
    typename   MultiComponentContainer2D::const_reverse_component_row_iterator row_rend(size_type row) const
    {
      return typename MultiComponentContainer2D::const_reverse_component_row_iterator(cont2d_->row_begin(this->cp_,this->box_.upper_left()[0] + row)+ this->box_.upper_left()[1]);
     }
   
    inline
    typename MultiComponentContainer2D::const_reverse_component_col_iterator col_rbegin(size_type col) const
    {
      return typename MultiComponentContainer2D::reverse_component_col_iterator( typename MultiComponentContainer2D::const_component_col_iterator(cont2d_->col_begin(this->cp_,this->box_.upper_left()[1] + col) + this->box_.upper_left()[0]) +  this->box_.height());
    }

    inline
    typename MultiComponentContainer2D::const_reverse_component_col_iterator col_rend(size_type col) const
    {
      return typename MultiComponentContainer2D::reverse_component_col_iterator( typename MultiComponentContainer2D::const_component_col_iterator(cont2d_->col_begin(this->cp_,this->box_.upper_left()[1] + col) + this->box_.upper_left()[0]));
    }

    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_;
    }

    inline
    size_type cp() const
    {
      return this->cp_;
    }
    
    
  private: 
    MultiComponentContainer2D* cont2d_; // pointer to the 2d container
    pointer pos_;         // linear position within the container
    int x1_;              // first index position 
    int x2_;              // second index position
    size_type cp_;              // component index number
    Box2d<int> box_;      // box to iterate 
  };
 
}//slip::

#endif //SLIP_COMPONENT_ITERATOR_HPP