STK_Array2DSquare.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 Array2DSquare class.
 * Author:   Serge Iovleff, S..._Dot_I..._At_stkpp_Dot_org (see copyright for ...)
 *
 **/
 
#ifndef STK_ARRAY2DSQUARE_H
#define STK_ARRAY2DSQUARE_H
 
#include "STK_IArray2D.h"
#include "STK_IArray2DSlicers.h"
#include "STK_IArray2DModifiers.h"
 
namespace STK
{
// forward declaration
template< typename Type> class Array2DSquare;
template< typename Type> class Array2D;
template< typename Type> class Array2DPoint;
template< typename Type> class Array2DVector;
 
typedef Array2DSquare<Real>   ArraySquareX;
typedef Array2DSquare<double> ArraySquareXd;
typedef Array2DSquare<int>    ArraySquareXi;
 
namespace hidden
{
template<class Type_>
struct Traits<Array2DSquare<Type_> >
{
  private:
    class Void {};
  public:
    typedef Array2DPoint<Type_>  Row;
    typedef Array2DVector<Type_> Col;
    typedef Array2DPoint<Type_>  SubRow;
    typedef Array2DVector<Type_> SubCol;
    typedef Array2D<Type_>       SubArray;
    typedef Void                 SubVector;
 
    typedef Type_                Type;
    typedef typename RemoveConst<Type>::Type const& TypeConst;
 
    enum
    {
      structure_ = Arrays::square_,
      orient_    = Arrays::by_col_,
      sizeRows_  = UnknownSize,
      sizeCols_  = UnknownSize,
      size_      = UnknownSize,
      storage_   = Arrays::dense_ // always dense
    };
    typedef Array1D<Type, UnknownSize> ColVector;
};
 
} // namespace hidden
 
template<class Type_>
class Array2DSquare: public IArray2D< Array2DSquare<Type_> >
{
  public:
    typedef IArray2D< Array2DSquare<Type_> > Base;
    typedef ArrayBase< Array2DSquare<Type_> > LowBase;
 
    typedef typename hidden::Traits< Array2DSquare<Type_> >::Row Row;
    typedef typename hidden::Traits< Array2DSquare<Type_> >::Col Col;
    typedef typename hidden::Traits< Array2DSquare<Type_> >::SubRow SubRow;
    typedef typename hidden::Traits< Array2DSquare<Type_> >::SubCol SubCol;
    typedef typename hidden::Traits< Array2DSquare<Type_> >::SubVector SubVector;
    typedef typename hidden::Traits< Array2DSquare<Type_> >::SubArray SubArray;
 
    typedef typename hidden::Traits< Array2DSquare<Type_> >::Type Type;
    typedef typename hidden::Traits< Array2DSquare<Type_> >::TypeConst TypeConst;
 
    enum
    {
      structure_ = hidden::Traits< Array2DSquare<Type_> >::structure_,
      orient_    = hidden::Traits< Array2DSquare<Type_> >::orient_,
      sizeCols_  = hidden::Traits< Array2DSquare<Type_> >::sizeCols_,
      sizeRows_  = hidden::Traits< Array2DSquare<Type_> >::sizeRows_,
      size_      = hidden::Traits< Array2DSquare<Type_> >::size_,
      storage_   = hidden::Traits< Array2DSquare<Type_> >::storage_
    };
 
    Array2DSquare(): Base() {}
    Array2DSquare( Range const& I): Base(I, I) {}
    Array2DSquare( Range const& I, Type const& v): Base(I, I)
    { LowBase::setValue(v);}
    Array2DSquare( Array2DSquare const&T, bool ref=false): Base(T, ref) {}
    Array2DSquare( Array2DSquare const& T, Range const& I): Base(T, I, I) {}
    template<class OtherDerived>
    Array2DSquare( ExprBase<OtherDerived> const& T): Base()
    { LowBase::operator=(T);}
    ~Array2DSquare() {}
    void shift1D(int beg)
    { Base::shift(beg, beg);}
    Array2DSquare& resize1D( Range const& I)
    { Base::resize(I, I); return *this;}
    void insert( int pos, int n =1)
    {
      Base::insertRows(pos, n);
      Base::insertCols(pos, n);
    }
    void erase( int pos, int n=1)
    {
      Base::eraseCols(pos, n);
      Base::eraseRows(pos, n);
    }
    void pushBack(int n=1)
    {
      Base::pushBackRows(n);
      Base::pushBackCols(n);
    }
    void popBack(int n=1)
    {
      Base::popBackCols(n);
      Base::popBackRows(n);
    }
    template<class Rhs>
    Array2DSquare& operator=(ExprBase<Rhs> const& T) { return LowBase::operator=(T);}
    Array2DSquare& operator=( Array2DSquare const& T) { return LowBase::assign(T);}
    Array2DSquare& operator=(Type const& v) { return LowBase::setValue(v);}
};
 
} // namespace STK
 
 
#endif
// STK_ARRAY2DSQUARE_H