STK_ITContainer2D.h

Go to the documentation of this file.

/*--------------------------------------------------------------------*/
/*     Copyright (C) 2004-2011  Serge Iovleff

    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 : Serge.Iovleff@stkpp.org
*/

/*
 * Project:  stkpp::Sdk::TContainer
 * created on: 26 nov. 2011
 * Author:   Serge Iovleff, serge.iovleff@stkpp.org
 **/

#ifndef STK_ITCONTAINER2D_H
#define STK_ITCONTAINER2D_H

#include "STK_IContainer2D.h"
#include "STK_ITContainer1D.h"
#include "../../STKernel/include/STK_Exceptions.h"

namespace STK
{
template <class TYPE, class TContainer2D>
class ContainerTraits;

template <class TYPE, class TContainer2D>
class ITContainer2D : public IContainerBase<TContainer2D>, public IContainer2D
{
  protected:
    ITContainer2D( Range const& I = Range(), Range const& J = Range())
                 : IContainerBase<TContainer2D>(IContainerBase<TContainer2D>::_2D_)
                 , IContainer2D(I, J)
    { this->ranges_.push_back(&rangeVe_); this->ranges_.push_back(&rangeHo_);}

    ITContainer2D( const ITContainer2D &T)
                 : IContainerBase<TContainer2D>(IContainerBase<TContainer2D>::_2D_)
                 , IContainer2D(T)
    { this->ranges_.push_back(&rangeVe_); this->ranges_.push_back(&rangeHo_);}

  public:
    typedef TYPE Type;
    typedef typename ContainerTraits<TYPE, TContainer2D>::TContainerVe TContainerVe;
    typedef typename ContainerTraits<TYPE, TContainer2D>::TContainerHo TContainerHo;

    virtual ~ITContainer2D() { ;}

    inline TYPE& elt(Integer const& i, Integer const& j)
    { return this->asLeaf().elt(i,j);}

    inline TYPE const& elt(Integer const& i, Integer const& j) const
    { return this->asLeaf().elt(i,j);}

    inline TYPE& operator()(Integer const& i, Integer const& j)
    { return this->asLeaf().elt(i,j);}

    inline TYPE const& operator()(Integer const& i, Integer const& j) const
    { return this->asLeaf().elt(i,j);}

    inline TContainerVe operator[](Integer const& j) const
    { return this->asLeaf().col(j);}

    inline TContainerVe col(Integer const& j) const
    { return this->asLeaf().col(j);}

    inline TContainerVe operator()(Range const& I, Integer const& j) const
    { return this->asLeaf().col(I, j);}

    inline TContainerHo operator()(Integer const& i) const
    { return this->asLeaf().row(i);}

    inline TContainerHo row(Integer const& i) const
    { return this->asLeaf().row(i);}

    inline TContainerHo operator()(Integer const& i, Range const& J) const
    { return this->asLeaf().row(i, J);}

    inline TContainer2D operator()(Range const& I, Range const& J) const
    { return this->asLeaf().sub(I, J);}

    inline TContainer2D operator()(Range const& I) const
    { return this->asLeaf().sub(I, this->rangeHo());}

    inline TContainer2D operator[](Range const& J) const
    { return this->asLeaf().sub(this->rangeVe(), J);}

    TYPE& at(Integer const& i, Integer const& j)
    {
      if (this->firstRow() > i)
      { throw out_of_range("ITContainer2DBase::at(i, j) "
                                "this->firstRow() > i");
      }
      if (this->lastRow() < i)
      { throw out_of_range("ITContainer2DBase::at(i, j) "
                                "this->lastRow() < i");
      }
      if (this->firstCol() > j)
      { throw out_of_range("ITContainer2DBase::at(i, j) "
                                "this->firstCol() > j");
      }
      if (this->lastCol() < j)
      { throw out_of_range("ITContainer2DBase::at(i, j) "
                                "this->lastCol() < j");
      }
      return this->asLeaf().elt(i, j);
    }

    TYPE const& at(Integer const& i, Integer const& j) const
    {
      // check bounds
      if (this->firstRow() > i)
      { throw out_of_range("ITContainer2DBase::at(i, j) "
                                "this->firstRow() > i");
      }
      if (this->lastRow() < i)
      { throw out_of_range("ITContainer2DBase::at(i, j) "
                                "this->lastRow() < i");
      }
      if (this->firstCol() > j)
      { throw out_of_range("ITContainer2DBase::at(i, j) "
                                "this->firstCol() > j");
      }
      if (this->lastCol() < j)
      { throw out_of_range("ITContainer2DBase::at(i, j) "
                                "this->lastCol() < j");
      }
      // return element
      return this->asLeaf().elt(i, j);
    }

    inline TContainer2D at(Range const& I, Range const& J) const
    {
      if (this->firstRow() > I.first())
      { throw out_of_range("ITContainer2D::at(I, J) "
                                "this->firstRow() > I.first()");
      }
      if (this->lastRow() < I.last())
      { throw out_of_range("ITContainer2D::at(I, J) "
                                "this->lastRow() < I.last()");
      }
      if (this->firstCol() > J.first())
      { throw out_of_range("ITContainer2D::at(I, J) "
                                "this->firstCol() > J.first()");
      }
      if (this->lastCol() < J.last())
      { throw out_of_range("ITContainer2D::at(I, J) "
                                "this->lastCol() < J.last()");
      }
      return this->asLeaf().sub(I, J);
    }

    inline TContainerVe at(Range const& I, Integer const& j) const
    {
      if (this->firstRow() > I.first())
      { throw out_of_range("TContainer2D::at(I, j) "
                           "this->firstRow() > I.first()");
      }
      if (this->lastRow() < I.last())
      { throw out_of_range("TContainer2D::at(I, j) "
                           "this->lastRow() < I.last()");
      }
      if (this->firstCol() > j)
      { throw out_of_range("TContainer2D::at(I, j) "
                           "this->firstCol() > j");
      }
      if (this->lastCol() < j)
      { throw out_of_range("TContainer2D::at(I, j) "
                           "this->lastCol() < j");
      }
      return this->asLeaf().col(I, j);
    }

    inline TContainerHo at(Integer const& i, Range const& J) const
    {
      if (this->firstRow() > i)
      { throw out_of_range("TContainer2D::at(i, J) "
                                "this->firstRow() > i");
      }
      if (this->lastRow() < i)
      { throw out_of_range("TContainer2D::at(i, J) "
                                "this->lastRow() < i");
      }
      if (this->firstCol() > J.first())
      { throw out_of_range("TContainer2D::at(i, J) "
                                "this->firstCol() > J.first()");
      }
      if (this->lastCol() < J.last())
      { throw out_of_range("TContainer2D::at(i, J) "
                                "this->lastCol() < J.last()");
      }
      return this->asLeaf().row(J, i);
    }

    inline TContainerVe atCol(Integer const& j) const
    {
      if (this->firstCol() > j)
      { throw out_of_range("TContainer2D::atCol(j) "
                                "this->firstCol() > j");
      }
      if (this->lastCol() < j)
      { throw out_of_range("TContainer2D::atCol(j) "
                                "this->lastCol() < j");
      }
      return this->asLeaf().col(this->rangeVe(), j);
    }

    inline TContainer2D atCol(Range const& J) const
    {
      if (this->firstCol() > J.first())
      { throw out_of_range("TContainer2D::atCol(J) "
                                "this->firstCol() > J.first()");
      }
      if (this->lastCol() < J.last())
      { throw out_of_range("TContainer2D::atCol(J) "
                                "this->lastCol() < J.last()");
      }
      return this->asLeaf().sub(this->rangeVe(), J);
    }

    inline TContainerHo atRow(Integer const& i) const
    {
      if (this->firstRow() > i)
      { throw out_of_range("TContainer2D::atRow(i) "
                                "this->firstRow() > i");
      }
      if (this->lastRow() < i)
      { throw out_of_range("TContainer2D::atRow(i) "
                                "this->lastRow() < i");
      }
      return this->asLeaf().row(i, this->rangeHo());
    }

    inline TContainer2D atRow(Range const& I) const
    {
      if (this->firstRow() > I.first())
      { throw out_of_range("TContainer2D::atRow(I) "
                                "this->firstRow() > I.first()");
      }
      if (this->lastRow() < I.last())
      { throw out_of_range("TContainer2D::atRow(I) "
                                "this->lastRow() < I.last()");
      }
      return this->asLeaf().sub(I, this->rangeHo());
    }

    template<class Container1D>
    inline void pushBackCol(ITContainer1D<TYPE, Container1D> const& V)
    {
      const Integer firstRow = V.first(), lastRow = V.last();
      // check if the container is empty
      if (this->empty())
      {
        this->resize(V.range(), Range(1));
        for (Integer i=firstRow; i<=lastRow; i++)
          (*this)(i, 1) = V[i];
        return;
      }
#ifdef STK_BOUNDS_CHECK
      if (V.range() != this->rangeVe())
      { throw runtime_error("TContainer2D::pushBackCol(V) "
                                 "V.range() != this->rangeVe()");
      }
#endif
      // if the container is not empty we add a column and copy V inside
      this->asLeaf().pushBackCols();
      const Integer lastCol = this->lastCol();
      for (Integer i=firstRow; i<=lastRow; i++)
        (*this)(i, lastCol) = V[i];
    }
};

} // namespace STK

#endif
// STK_ITCONTAINER2D_H