elementColumnIterator.h

Go to the documentation of this file.

#ifndef BALL_LINALG_ELEMENTCOLUMNITERATOR_H
#define BALL_LINALG_ELEMENTCOLUMNITERATOR_H

#ifndef BALL_LINALG_MATRIX_IH
# include <BALL/MATHS/LINALG/matrix.ih>
#endif

#ifndef BALL_CONCEPT_RANDOMACCESSITERATOR_H
#include <BALL/CONCEPT/randomAccessIterator.h>
#endif

namespace BALL {

  // forward declaration
  template <class valuetype, class mtraits>
  class Matrix;

  
  template <class valuetype, class mtraits=StandardTraits>
  class ElementColumnIteratorTraits
  {

    typedef valuetype ValueType;

    typedef valuetype* PointerType;

    typedef int IteratorPosition;

    typedef int Distance;

    typedef int Index;

      friend class Matrix<valuetype, mtraits>;
    public:

      virtual ~ElementColumnIteratorTraits()
      {
      }

      ElementColumnIteratorTraits()
        : bound_(0),
          position_(0)
      {
      }
      
      ElementColumnIteratorTraits(const Matrix<valuetype, mtraits>& matrix)
        : bound_(const_cast<Matrix<valuetype, mtraits>*>(&matrix)),
          position_(0)
      {
      }
      
      ElementColumnIteratorTraits(const ElementColumnIteratorTraits& traits)
        : bound_(traits.bound_),
          position_(traits.position_)
      {
      }
      
      ElementColumnIteratorTraits& operator = (const ElementColumnIteratorTraits& traits)
      {
        bound_ = traits.bound_;
        position_ = traits.position_;
    
        return *this;
      }

      Matrix<valuetype, mtraits>* getContainer()
      {
        return bound_;
      }
      
      const Matrix<valuetype, mtraits>* getContainer() const
      {
        return bound_;
      }
      
      bool isSingular() const
      {
        return (bound_ == 0);
      }
      
      IteratorPosition& getPosition()
      {
        return position_;
      }

      const IteratorPosition& getPosition() const
      {
        return position_;
      }

      bool operator == (const ElementColumnIteratorTraits& traits) const
      {
        return (position_ == traits.position_);
      }

      bool operator != (const ElementColumnIteratorTraits& traits) const
      {
        return (position_ != traits.position_);
      }
        
      bool operator < (const ElementColumnIteratorTraits& traits) const
      {
        return (position_ < traits.position_);
      }

      Distance getDistance(const ElementColumnIteratorTraits& traits) const
      {
        return (Distance)(position_ - traits.position_);
      }
      
      bool isValid() const
      {
        return ((bound_ != 0) && (position_ >= 0) && (position_ < (int)bound_->data_.size()));
      }

      void invalidate()
      {
        bound_ = 0;
        position_ = -1;
      }
      
      void toBegin()
      {
        position_ = 0;
      }

      bool isBegin() const
      {
        return ( position_ == 0 );
      }

      void toEnd()
      {
        position_ = bound_->data_.size();
      }
      
      bool isEnd() const
      {
        return ( position_ == (int)bound_->data_.size());
      }
      
      ValueType& getData()
      {
        return (*bound_)[position_];
      }

      const ValueType& getData() const
      {
        return (*bound_)[position_];
      }

      void forward()
      {
        if (bound_->row_major_)
        {
          if ((uint)(position_+1) == bound_->data_.size())
          {
            position_++;
            return;
          }
          position_ += bound_->m_;
          if ((uint)position_ >= bound_->data_.size())
            position_ = (position_ % bound_->n_) + 1;
        }
        else
        {
          position_++;
        }
      }

      friend std::ostream& operator << (std::ostream& s, const ElementColumnIteratorTraits& traits)
      {
        return (s << traits.position_ << ' ');
      }
      
      void dump(std::ostream& s) const
      {
        s << position_ << std::endl;
      }
      
      void toRBegin()
      {
        position_ = bound_->data_.size() - 1;
      }
      
      bool isRBegin() const
      {
        return (position_ == bound_->data_.size() - 1);
      }
      
      void toREnd()
      {
        position_ = -1;
      }

      bool isREnd() const
      {
        return (position_ <= -1);
      }
      
      void backward()
      {
        if (bound_->row_major_)
        {
          if (position_ == 0)
          {
            position_--;
            return;
          }
          position_ -= bound_->m_;
          if (position_ < 0)
            position_ = (int)(bound_->data_.size()) - 1 + position_;
        }
        else
        {
          position_--;
        }
      }

      void backward(Distance distance)
      {
        if (bound_->row_major_)
        {
          for (int i=0; i<distance; i++)
          {
            if (position_ == 0)
            {
        position_--;
        return;
            }
            position_ -= bound_->m_;
            if (position_ < 0)
        position_ = (int)(bound_->data_.size()) - 1 + position_;
          }
        }
        else
        {
          position_ -= distance;
        }
      }

      void forward(Distance distance)
      {
        if (bound_->row_major_)
        {
          for (int i=0; i<distance; i++)
          {
            if ((uint)(position_+1) == bound_->data_.size())
            {
        position_++;
        return;
            }
            position_ += bound_->m_;
            if ((uint)position_ >= bound_->data_.size())
        position_ = (position_ % bound_->n_) + 1;
          }
        }
        else
        {
          position_ += distance;
        }
      }
      
      ValueType& getData(Index index)
      {
        return (*bound_)[index];
      }
      
      const ValueType& getData(Index index) const
      {
        return (*bound_)[index];
      }
      

      protected:

      Matrix<valuetype, mtraits>*   bound_;
      IteratorPosition    position_;
    };


} // namespace BALL

#endif