STK_ITContainer1D.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
 * Purpose:  Define the Interface 1D template Container class.
 * Author:   Serge Iovleff, S..._Dot_I..._At_stkpp_Dot_org (see copyright for ...)
 *
 **/
 
#ifndef STK_ITCONTAINER1D_H
#define STK_ITCONTAINER1D_H
 
 
namespace STK
{
template <class Derived>
class ITContainer1D: public IRecursiveTemplate<Derived>
{
  public:
    enum
    {
      size_ = hidden::Traits<Derived>::size_
    };
 
    typedef typename hidden::Traits<Derived>::Type Type;
    typedef typename hidden::Traits<Derived>::TypeConst TypeConst;
 
    typedef typename hidden::Traits< Derived >::RowRange RowRange;
    typedef typename hidden::Traits< Derived >::ColRange ColRange;
 
    typedef typename hidden::Traits<Derived>::Row Row;
    typedef typename hidden::Traits<Derived>::Col Col;
    typedef typename hidden::Traits<Derived>::SubVector SubVector;
 
 
    typedef typename hidden::Traits<Derived>::Iterator Iterator;
    typedef typename hidden::Traits<Derived>::ConstIterator ConstIterator;
    typedef typename hidden::Traits<Derived>::ReverseIterator ReverseIterator;
    typedef typename hidden::Traits<Derived>::ConstReverseIterator ConstReverseIterator;
 
  protected:
    ITContainer1D(): range_() {}
    ITContainer1D( RowRange const& I): range_(I) {}
    ~ITContainer1D() {}
 
  public:
    inline RowRange const& range() const  { return range_;}
    inline int begin() const { return range_.begin();}
    inline int end() const { return range_.end();}
    inline int size() const { return range_.size();}
 
    inline int lastIdx() const { return range_.lastIdx();}
 
    Iterator beginIterator() { return Iterator(this->asDerived(), begin());}
    Iterator endIterator() { return Iterator(this->asDerived(), end());}
 
    ConstIterator beginConstIterator() const { return ConstIterator(this->asDerived(), begin());}
    ConstIterator endConstIterator() const { return ConstIterator(this->asDerived(), end());}
 
    ReverseIterator rbeginIterator() { return ReverseIterator(endIterator());}
    ReverseIterator rendIterator() { return ReverseIterator(beginIterator());}
 
    ConstReverseIterator rbeginConstIterator() const { return ConstReverseIterator(endConstIterator());}
    ConstReverseIterator rendConstIterator() const { return ConstReverseIterator(beginConstIterator());}
 
    bool empty() const { return range_.empty();}
 
    inline Type& elt(int i)
    {
#ifdef STK_BOUNDS_CHECK
      if (begin() > i) { STKOUT_OF_RANGE_1ARG(ITContainer1D::elt, i, begin() > i);}
      if (end() <= i)  { STKOUT_OF_RANGE_1ARG(ITContainer1D::elt, i, end() <= i);}
#endif
      return this->asDerived().elt1Impl(i);
    }
    inline TypeConst elt(int i) const
    {
#ifdef STK_BOUNDS_CHECK
      if (begin() > i) { STKOUT_OF_RANGE_1ARG(ITContainer1D::elt, i, begin() > i);}
      if (end() <= i)  { STKOUT_OF_RANGE_1ARG(ITContainer1D::elt, i, end() <= i);}
#endif
      return this->asDerived().elt1Impl(i);
    }
    inline Type& operator[](int i)
    {
#ifdef STK_BOUNDS_CHECK
      if (begin() > i) { STKOUT_OF_RANGE_1ARG(ITContainer1D::operator[], i, begin() > i);}
      if (end() <= i)  { STKOUT_OF_RANGE_1ARG(ITContainer1D::operator[], i, end() <= i);}
#endif
      return elt(i);
    }
    inline TypeConst operator[](int i) const
    {
#ifdef STK_BOUNDS_CHECK
      if (begin() > i) { STKOUT_OF_RANGE_1ARG(ITContainer1D::operator[], i, begin() > i);}
      if (end() <= i)  { STKOUT_OF_RANGE_1ARG(ITContainer1D::operator[], i, end() <= i);}
#endif
      return elt(i);
    }
    inline Type& at(int i)
    {
      if (begin() > i) { STKOUT_OF_RANGE_1ARG(ITContainer1D::at, i, begin() > i);}
      if (end() <= i)  { STKOUT_OF_RANGE_1ARG(ITContainer1D::at, i, end() <= i);}
      return elt(i);
    }
    TypeConst at(int i) const
    {
      if (begin() > i)
      { STKOUT_OF_RANGE_1ARG(ITContainer1D::at, i, begin() > i);}
      if (end() <= i)
      { STKOUT_OF_RANGE_1ARG(ITContainer1D::at, i, end() <= i);}
      return elt(i);
    }
    inline SubVector sub(Range const& I) const
    {
#ifdef STK_BOUNDS_CHECK
      if ((I.begin()<begin()))
      { STKOUT_OF_RANGE_1ARG(ITContainer1D::sub,I,I.begin()<begin());}
      if ((I.end()>end()))
      { STKOUT_OF_RANGE_1ARG(ITContainer1D::sub,I,I.end()>end());}
#endif
      return SubVector(this->asDerived(), I, true);
    }
 
    inline Type& front() { return elt(begin());}
    inline TypeConst front() const { return elt(begin());}
    inline Type& back() { return elt(lastIdx());}
    inline TypeConst back() const { return elt(lastIdx());}
 
    void shift(int beg)
    {
      this->asDerived().shiftImpl(beg);
      range_.shift(beg);
    }
    Derived& resize(Range const& I =RowRange())
    { return this->asDerived().resizeImpl(I);}
 
  protected:
     void exchange(ITContainer1D& T) { std::swap(T.range_, range_ );}
    void setRange(RowRange const& I = RowRange()) { range_ = I;}
    void incRange(int n =1) { range_.inc(n);}
    void incFirst(int n =1) { range_.incFirst(n);}
    void decFirst(int n =1) { range_.decFirst(n);}
    void incLast(int n =1) { range_.incLast(n);}
    void decLast(int n =1) { range_.decLast(n);}
 
  private:
    RowRange range_;
};
 
} // namespace STK
 
#endif // STK_ITCONTAINER1D_H