iterator3d_plane.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_ITERATOR3D_PLANE_HPP
#define SLIP_ITERATOR3D_PLANE_HPP

#include <iterator>
#include <cassert>
#include "DPoint.hpp"
#include "Point2d.hpp"
#include "DPoint2d.hpp"
#include "Box2d.hpp"
#include "Box3d.hpp"
#include "iterator_types.hpp"

namespace slip
{
  enum PLANE_ORIENTATION
    {
      IJ_PLANE = 0, 
      KJ_PLANE, 
      KI_PLANE
    };

  template <class Container3D>
  class iterator3d_plane  
  {
  private:
    
    void pos_calc()
    {
      if(zerodim_ == 0)
                {
                  this->pos_ = cont3d_->begin() + 
                    (this->xp_ * int(cont3d_->rows() * int(cont3d_->cols()))) + 
                    (this->x1_* int(cont3d_->cols())) + this->x2_;
                }
      else if(zerodim_ == 1)
                {
                  this->pos_ = cont3d_->begin() + 
                    (this->x1_ * int(cont3d_->rows() * int(cont3d_->cols()))) + 
                    (this->xp_* int(cont3d_->cols())) + this->x2_;
                }
      else
                {
                  this->pos_ = cont3d_->begin() + 
                    (this->x1_ * int(cont3d_->rows() * int(cont3d_->cols()))) + 
                    (this->x2_* int(cont3d_->cols())) + this->xp_;
                }
    }

  public:
    //typedef std::random_access_iterator_tag iterator_category;
    typedef std::random_access_iterator2d_tag iterator_category;
    typedef typename Container3D::value_type value_type;
    typedef DPoint2d<int> difference_type;
    typedef typename Container3D::pointer pointer;
    typedef typename Container3D::reference reference;

    typedef iterator3d_plane self;

    typedef typename Container3D::size_type size_type;
  
    iterator3d_plane():
      cont3d_(0),pos_(0),zerodim_(0),xp_(0),x1_(0),x2_(0),box_(0,0,0,0)
    {}

    iterator3d_plane(Container3D* c, PLANE_ORIENTATION P, const int plane_coordinate, const Box2d<int>& b):
      cont3d_(c),pos_(0),zerodim_(P),xp_(plane_coordinate),x1_(b.upper_left()[0]),x2_(b.upper_left()[1]),box_(b)
    {
      assert((P == IJ_PLANE) || (P == KJ_PLANE) || (P == KI_PLANE));
      this->pos_calc();
    }

    iterator3d_plane(Container3D* c,
                                   const Box3d<int>& b):
      cont3d_(c),pos_(0),zerodim_(0),xp_(0),x1_(0),x2_(0),box_(0,0,0,0)
    {
      DPoint<int,3> dim = b.back_bottom_right() - b.front_upper_left();
      zerodim_ = ((dim[0] == 0)?0:((dim[1] == 0)?1:((dim[2] == 0)?2:-1)));
      assert(zerodim_ != -1);
      xp_ = b.back_bottom_right()[zerodim_];
      if (zerodim_ == 0)
                {
                  x1_ = b.front_upper_left()[1];
                  x2_ = b.front_upper_left()[2];
                  box_ = slip::Box2d<int>(x1_,x2_,b.back_bottom_right()[1],b.back_bottom_right()[2]);
                }
      else if (zerodim_ == 1)
                {
                  x1_ = b.front_upper_left()[0];
                  x2_ = b.front_upper_left()[2];
                  box_ = slip::Box2d<int>(x1_,x2_,b.back_bottom_right()[0],b.back_bottom_right()[2]);
                }
      else
                {
                  x1_ = b.front_upper_left()[0];
                  x2_ = b.front_upper_left()[1];
                  box_ = slip::Box2d<int>(x1_,x2_,b.back_bottom_right()[0],b.back_bottom_right()[1]);
                }
      this->pos_calc();
    }

    iterator3d_plane(const self& o):
      cont3d_(o.cont3d_),pos_(o.pos_),zerodim_(o.zerodim_),xp_(o.xp_),x1_(o.x1_),x2_(o.x2_),box_(o.box_)
    {}

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

 

    inline
    const reference operator*() const
    {
      return *pos_;
    }


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

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

  
    inline
    self& operator++()
    {
      if(x2_ < (box_.bottom_right())[1])
                {
                  this->x2_++;
                  this->pos_calc();
                }
      else if(x1_ < (box_.bottom_right())[0])
                {
                  this->x1_++;
                  this->x2_ = (box_.upper_left())[1];
                  this->pos_calc();
                }
      else
                {
                  this->x1_ = (box_.bottom_right())[0] + 1;
                  this->x2_ = (box_.bottom_right())[1] + 1;
                  this->pos_calc();
                }
      return *this;
    }

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

    inline
    self& operator--()
    {
      if(x2_ > (box_.upper_left())[1])
                {
                  this->x2_--;
                  this->pos_calc();
                }
      else if (x1_ > (box_.upper_left())[0])
                {
                  this->x1_--;
                  this->x2_ = (box_.bottom_right())[1];
                  this->pos_calc();
                }
      else
                {
                  this->x1_ = (box_.upper_left())[0] - 1;
                  this->x2_ = (box_.upper_left())[1] - 1;
                  this->pos_calc();
                }
      
      return *this;
    }
    
    inline
    self operator--(int)
    {
      self tmp = *this;
      --(*this);
      return tmp;
    }

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

    inline
    friend bool operator!=(const self& i1,
                                                   const self& i2)
    {
      return ( (i1.cont3d_ != i2.cont3d_) || (i1.pos_ != i2.pos_)
                       || (i1.zerodim_ != i2.zerodim_) || (i1.xp_ != i2.xp_) 
                       || (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_calc();
      return *this;
    }

 
  
    inline
    self& operator-=(const difference_type& d)
    {
      this->x1_ -= d.dx1();
      this->x2_ -= d.dx2();
      this->pos_calc();
      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)
    {
      if(zerodim_ == 0)
                return (*cont3d_)[this->xp_][this->x1_+d.dx1()][this->x2_+d.dx2()];
      if(zerodim_ == 1)
                return (*cont3d_)[this->x1_+d.dx1()][this->xp_][this->x2_+d.dx2()];
      return (*cont3d_)[this->x1_+d.dx1()][this->x2_+d.dx2()][this->xp_];
    }

    inline
    pointer* operator[](int n)
    {
      if(zerodim_ == 0)
                return (*cont3d_)[this->xp_+ n];
      return (*cont3d_)[this->x1_+ n];
    }


    inline
    int x1() const
    {
      return this->x1_;
    }
    
    inline
    int x2() const
    {
      return this->x2_;
    }
    
    inline
    int xp() const
    {
      return this->xp_;
    }
    inline
    int zerodim() const
    {
      return this->zerodim_;
    }
  
  private: 
    Container3D* cont3d_; // pointer to the 3d container
    pointer pos_;         // linear position within the container
    int zerodim_;         // index of the plane axe (0->k,1->i,2->j)
    int xp_;              // position of the plane
    int x1_;              // first subscript position (within the plane)
    int x2_;              // second subscript position (within the plane)
    Box2d<int> box_;      // plane to iterate 

 };

  
  template <class Container3D>
  class const_iterator3d_plane  
  {
   private:
   
    inline
    void pos_calc()
    {
      if(zerodim_ == 0)
                {
                  this->pos_ = cont3d_->begin() + 
                    (this->xp_ * int(cont3d_->rows() * int(cont3d_->cols()))) + 
                    (this->x1_* int(cont3d_->cols())) + this->x2_;
                }
      else if(zerodim_ == 1)
                {
                  this->pos_ = cont3d_->begin() + 
                    (this->x1_ * int(cont3d_->rows() * int(cont3d_->cols()))) + 
                    (this->xp_* int(cont3d_->cols())) + this->x2_;
                }
      else
                {
                  this->pos_ = cont3d_->begin() + 
                    (this->x1_ * int(cont3d_->rows() * int(cont3d_->cols()))) + 
                    (this->x2_* int(cont3d_->cols())) + this->xp_;
                }
    }
    
  public:
    //typedef std::random_access_iterator_tag iterator_category;
    typedef std::random_access_iterator2d_tag iterator_category;
    typedef typename Container3D::value_type value_type;
    typedef DPoint2d<int> difference_type;
    typedef typename Container3D::pointer pointer;
    typedef typename Container3D::const_pointer const_pointer;
    typedef typename Container3D::const_reference reference;

    typedef const_iterator3d_plane self;

    typedef typename Container3D::size_type size_type;
  
    const_iterator3d_plane():
      cont3d_(0),pos_(0),zerodim_(0),xp_(0),x1_(0),x2_(0),box_(0,0,0,0)
    {}

  
    const_iterator3d_plane(Container3D* c, PLANE_ORIENTATION P, const int plane_coordinate, const Box2d<int>& b):
      cont3d_(c),pos_(0),zerodim_(P),xp_(plane_coordinate),x1_(b.upper_left()[0]),x2_(b.upper_left()[1]),box_(b)
    {
      assert((P == IJ_PLANE) || (P == KJ_PLANE) || (P == KI_PLANE));
      this->pos_calc();
    }

    const_iterator3d_plane(Container3D* c,
                                   const Box3d<int>& b):
      cont3d_(c),pos_(0),zerodim_(0),xp_(0),x1_(0),x2_(0),box_(0,0,0,0)
    {
      DPoint<int,3> dim = b.back_bottom_right() - b.front_upper_left();
      zerodim_ = ((dim[0] == 0)?0:((dim[1] == 0)?1:((dim[2] == 0)?2:-1)));
      assert(zerodim_ != -1);
      xp_ = b.back_bottom_right()[zerodim_];
      if (zerodim_ == 0)
                {
                  x1_ = b.front_upper_left()[1];
                  x2_ = b.front_upper_left()[2];
                  box_ = slip::Box2d<int>(x1_,x2_,b.back_bottom_right()[1],b.back_bottom_right()[2]);
                }
      else if (zerodim_ == 1)
                {
                  x1_ = b.front_upper_left()[0];
                  x2_ = b.front_upper_left()[2];
                  box_ = slip::Box2d<int>(x1_,x2_,b.back_bottom_right()[0],b.back_bottom_right()[2]);
                }
      else
                {
                  x1_ = b.front_upper_left()[0];
                  x2_ = b.front_upper_left()[1];
                  box_ = slip::Box2d<int>(x1_,x2_,b.back_bottom_right()[0],b.back_bottom_right()[1]);
                }
      this->pos_calc();
    }

    const_iterator3d_plane(const self& o):
      cont3d_(o.cont3d_),pos_(o.pos_),zerodim_(o.zerodim_),xp_(o.xp_),x1_(o.x1_),x2_(o.x2_),box_(o.box_)
    {}

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


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

    
    inline
    self& operator++()
    {
      if(x2_ < (box_.bottom_right())[1])
                {
                  this->x2_++;
                  this->pos_calc();
                }
      else if(x1_ < (box_.bottom_right())[0])
                {
                  this->x1_++;
                  this->x2_ = (box_.upper_left())[1];
                  this->pos_calc();
                }
      else
                {
                  this->x1_ = (box_.bottom_right())[0] + 1;
                  this->x2_ = (box_.bottom_right())[1] + 1;
                  this->pos_calc();
                }
      return *this;
    }

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

    inline
    self& operator--()
    {
      if(x2_ > (box_.upper_left())[1])
                {
                  this->x2_--;
                  this->pos_calc();
                }
      else if (x1_ > (box_.upper_left())[0])
                {
                  this->x1_--;
                  this->x2_ = (box_.bottom_right())[1];
                  this->pos_calc();
                }
      else
                {
                  this->x1_ = (box_.upper_left())[0] - 1;
                  this->x2_ = (box_.upper_left())[1] - 1;
                  this->pos_calc();
                }
      
      return *this;
    }
  
    inline
    self operator--(int)
    {
      self tmp = *this;
      --(*this);
      return tmp;
    }

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

    inline
    friend bool operator!=(const self& i1,
                                                   const self& i2)
    {
      return ( (i1.cont3d_ != i2.cont3d_) || (i1.pos_ != i2.pos_)
                       || (i1.zerodim_ != i2.zerodim_) || (i1.xp_ != i2.xp_) 
                       || (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_calc();
      return *this;
    }
  
    inline
    self& operator-=(const difference_type& d)
    {
      this->x1_ -= d.dx1();
      this->x2_ -= d.dx2();
      this->pos_calc();
      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
    {
      if(zerodim_ == 0)
                return (*cont3d_)[this->xp_][this->x1_+d.dx1()][this->x2_+d.dx2()];
      if(zerodim_ == 1)
                return (*cont3d_)[this->x1_+d.dx1()][this->xp_][this->x2_+d.dx2()];
      return (*cont3d_)[this->x1_+d.dx1()][this->x2_+d.dx2()][this->xp_]; 
    }

    inline
    const_pointer* operator[](int n) const
    {
      if(zerodim_ == 0)
                return (*cont3d_)[this->xp_+ n];
      return (*cont3d_)[this->x1_+ n];
    }

 
 
  
    inline
    int x1() const
    {
      return this->x1_;
    }

    inline
    int x2() const
    {
      return this->x2_;
    }

    inline
    int xp() const
    {
      return this->xp_;
    }
    inline
    int zerodim() const
    {
      return this->zerodim_;
    }
    
  private: 
    Container3D* cont3d_; // pointer to the 3d container
    const_pointer pos_;         // linear position within the container
    int zerodim_;         // index of the plane axe (0->k,1->i,2->j)
    int xp_;              // position of the plane
    int x1_;              // first subscript position (within the plane)
    int x2_;              // second subscript position (within the plane)
    Box2d<int> box_;      // plane to iterate 
  };

 
}//slip::

#endif //SLIP_ITERATOR3D_PLANE_HPP