STK_SArray2DUpperTriangular.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 Upper Triangular Array class.
 * Author:   Serge Iovleff, S..._Dot_I..._At_stkpp_Dot_org (see copyright for ...)
 *
 **/
 
#ifndef STK_SARRAY2DUPPERTRIANGULAR_H
#define STK_SARRAY2DUPPERTRIANGULAR_H
 
#include "STK_SArray1D.h"
 
#include "STK_IArray2D.h"
#include "STK_IArray2DSlicers.h"
#include "STK_IArray2DModifiers.h"
 
namespace STK
{
// forward declaration
template<typename> class SArray2DUpperTriangular;
template<typename> class SArray2DPoint;
template<typename> class SArray2DVector;
 
typedef SArray2DUpperTriangular<Real>   SArrayUpperTriangularXX;
typedef SArray2DUpperTriangular<double> SArrayUpperTriangularXXd;
typedef SArray2DUpperTriangular<int>    SArrayUpperTriangularXXi;
 
namespace hidden
{
template<typename Type_>
struct Traits< SArray2DUpperTriangular<Type_> >
{
  private:
    class Void {};
  public:
    typedef SArray2DPoint<Type_>           Row;
    typedef SArray2DVector<Type_>          Col;
    typedef SArray2DPoint<Type_>           SubRow;
    typedef SArray2DVector<Type_>          SubCol;
    typedef SArray2DUpperTriangular<Type_> SubArray;
    typedef Void                          SubVector;
 
    typedef Type_                Type;
    typedef typename RemoveConst<Type>::Type const& TypeConst;
 
    enum
    {
      structure_ = Arrays::upper_triangular_,
      orient_    = Arrays::by_col_,
      sizeRows_  = UnknownSize,
      sizeCols_  = UnknownSize,
      storage_   = Arrays::sparse_
    };
    typedef SArray1D<Type, UnknownSize, UnknownSize> ColVector;
};
 
} // namespace hidden
 
template<typename Type_>
class SArray2DUpperTriangular: public IArray2D< SArray2DUpperTriangular<Type_> >
{
  public:
    typedef IArray2D< SArray2DUpperTriangular > Base;
    typedef ArrayBase < SArray2DUpperTriangular > LowBase;
 
    typedef typename hidden::Traits<SArray2DUpperTriangular >::Row Row;
    typedef typename hidden::Traits<SArray2DUpperTriangular >::Col Col;
    typedef typename hidden::Traits<SArray2DUpperTriangular >::SubRow SubRow;
    typedef typename hidden::Traits<SArray2DUpperTriangular >::SubCol SubCol;
    typedef typename hidden::Traits<SArray2DUpperTriangular >::SubVector SubVector;
    typedef typename hidden::Traits<SArray2DUpperTriangular >::SubArray SubArray;
 
    typedef typename hidden::Traits<SArray2DUpperTriangular >::Type Type;
    typedef typename hidden::Traits<SArray2DUpperTriangular >::TypeConst TypeConst;
 
    enum
    {
      structure_ = Arrays::upper_triangular_,
      orient_    = Arrays::by_col_,
      sizeRows_  = UnknownSize,
      sizeCols_  = UnknownSize,
      storage_ = Arrays::dense_ // always dense
    };
    SArray2DUpperTriangular(): Base() {}
    SArray2DUpperTriangular( Range const& I, Range const& J): Base(I, J) {}
    SArray2DUpperTriangular( Range const& I, Range const& J, Type const& v)
                           : Base(I, J)
    { LowBase::setValue(v);}
    SArray2DUpperTriangular( SArray2DUpperTriangular const& T, bool ref=false)
                         : Base(T, ref) {}
    SArray2DUpperTriangular( Base const& T, Range const& I, Range const& J)
                         : Base(T, I, J) {}
    SArray2DUpperTriangular( Type** q, Range const& I, Range const& J)
                         : Base(q, I, J) {}
    template<class OtherDerived>
    SArray2DUpperTriangular( ExprBase<OtherDerived> const& T): Base()
    { LowBase::operator=(T);}
    ~SArray2DUpperTriangular() {}
    template<class Rhs>
    SArray2DUpperTriangular& operator=(ExprBase<Rhs> const& T)
    { return LowBase::operator=(T);}
    SArray2DUpperTriangular& operator=(const SArray2DUpperTriangular &T)
    { return LowBase::assign(T);}
    SArray2DUpperTriangular& operator=(Type const& v) { return LowBase::setValue(v);}
    void shift1D(int beg)
    { Base::shift(beg, beg);}
    SArray2DUpperTriangular& resize1D( Range const& I)
    { Base::resize(I, I); return *this;}
};
 
} // namespace STK
 
#endif
// STK_SARRAY2DUPPERTRIANGULAR_H