STK_ReshapeOperators.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
 * created on: 17 oct. 2012
 * Author:   iovleff, S..._Dot_I..._At_stkpp_Dot_org (see copyright for ...)
 **/
 
#ifndef STK_RESHAPEOPERATORS_H
#define STK_RESHAPEOPERATORS_H
 
 
#define EGAL(arg1, arg2) ((arg1::structure_ == int(Arrays::arg2)))
 
namespace STK
{
// forward declaration
template< typename Lhs> class DiagonalizeOperator;
template< typename Lhs> class DiagonalGetterOperator;
template< typename Lhs> class UpperTriangularizeOperator;
template< typename Lhs> class LowerTriangularizeOperator;
template< typename Lhs> class SymmetrizeOperator;
template< typename Lhs> class UpperSymmetrizeOperator;
template< typename Lhs> class LowerSymmetrizeOperator;
 
namespace hidden
{
template<typename Lhs>
struct Traits< DiagonalizeOperator <Lhs> >
{
  enum
  {
    structure_ = Arrays::diagonal_,
    orient_    = Lhs::orient_,
    sizeRows_  = (Lhs::structure_== int(Arrays::diagonal_) )
                 ? Lhs::sizeRows_ != UnknownSize ? Lhs::sizeRows_ : Lhs::sizeCols_
                 : Lhs::structure_== int(Arrays::point_) ? int(Lhs::sizeCols_) : int(Lhs::sizeRows_),
    sizeCols_  = (Lhs::structure_== int(Arrays::diagonal_) )
                 ? Lhs::sizeRows_ != UnknownSize ? Lhs::sizeRows_ : Lhs::sizeCols_
                 : Lhs::structure_== int(Arrays::point_) ?  Lhs::sizeCols_ : Lhs::sizeRows_,
    storage_   = Lhs::storage_
  };
  typedef RowOperator<DiagonalizeOperator < Lhs> > Row;
  typedef ColOperator<DiagonalizeOperator < Lhs> > Col;
  typedef typename Lhs::Type Type;
  typedef typename Lhs::TypeConst TypeConst;
};
} // namespace hidden
 
template< typename Lhs>
class DiagonalizeOperator: public ExprBase< DiagonalizeOperator< Lhs> >, public TRef<1>
{
  public:
    typedef ExprBase< DiagonalizeOperator< Lhs> > Base;
    typedef typename hidden::Traits< DiagonalizeOperator<Lhs> >::Type Type;
    typedef typename hidden::Traits< DiagonalizeOperator<Lhs> >::TypeConst TypeConst;
    enum
    {
        structure_ = hidden::Traits< DiagonalizeOperator<Lhs> >::structure_,
        orient_    = hidden::Traits< DiagonalizeOperator<Lhs> >::orient_,
        sizeRows_  = hidden::Traits< DiagonalizeOperator<Lhs> >::sizeRows_,
        sizeCols_  = hidden::Traits< DiagonalizeOperator<Lhs> >::sizeCols_,
        storage_   = hidden::Traits< DiagonalizeOperator<Lhs> >::storage_,
        // this is safe as we can use DiagonalizeOperator only on 1D container
        size_      = (sizeRows_ != UnknownSize) ? sizeRows_ : sizeCols_
    };
    typedef TRange<size_> RowRange;
    typedef TRange<size_> ColRange;
    inline DiagonalizeOperator( Lhs const& lhs): Base(), lhs_(lhs)
    {
      STK_STATIC_ASSERT_ONE_DIMENSION_ONLY(Lhs);
    }
    inline RowRange const& rowsImpl() const { return lhs().range();}
    inline ColRange const& colsImpl() const { return lhs().range();}
    inline Lhs const& lhs() const { return lhs_; }
 
    inline TypeConst elt2Impl(int i, int j) const
    {
#ifdef STK_BOUNDS_CHECK
      if (i != j) { STKOUT_OF_RANGE_2ARG(DiagonalizeOperator::elt, i, j, i != j);}
#endif
      return (lhs_.elt(i));
    }
    inline TypeConst elt1Impl(int i) const { return (lhs_.elt(i));}
    inline TypeConst elt0Impl() const { return (lhs_.elt());}
 
  protected:
    Lhs const& lhs_;
};
 
 
namespace hidden
{
template<typename Lhs>
struct Traits< DiagonalGetterOperator <Lhs> >
{
  enum
  {
    structure_ = Arrays::diagonal_,
    orient_    = Lhs::orient_,
    sizeRows_  = ((Lhs::sizeRows_ < Lhs::sizeCols_)) ?  Lhs::sizeRows_ : Lhs::sizeCols_,
    sizeCols_  = sizeRows_,
    storage_   = Lhs::storage_,
    isValid_   = ( hidden::Traits<Lhs>::structure_==(int)Arrays::array2D_)
                ||(hidden::Traits<Lhs>::structure_==(int)Arrays::square_)
                ||(hidden::Traits<Lhs>::structure_==(int)Arrays::diagonal_)
                ||(hidden::Traits<Lhs>::structure_==(int)Arrays::lower_triangular_)
                ||(hidden::Traits<Lhs>::structure_==(int)Arrays::upper_triangular_)
                ||(hidden::Traits<Lhs>::structure_==(int)Arrays::symmetric_)
                ||(hidden::Traits<Lhs>::structure_==(int)Arrays::lower_symmetric_)
                ||(hidden::Traits<Lhs>::structure_==(int)Arrays::upper_symmetric_)
                ||(hidden::Traits<Lhs>::structure_==(int)Arrays::number_),
    use_       = (sizeRows_ != UnknownSize) ? Arrays::useLhsSize_ : Arrays::useLhsOtherSize_,
    size_      = (sizeRows_ != UnknownSize) ? sizeRows_ : sizeCols_
  };
  typedef RowOperator<DiagonalGetterOperator < Lhs> > Row;
  typedef ColOperator<DiagonalGetterOperator < Lhs> > Col;
  typedef typename Lhs::Type Type;
  typedef typename Lhs::TypeConst TypeConst;
};
 
} // namespace hidden
 
 
template< typename Lhs>
class DiagonalGetterOperator: public ExprBase< DiagonalGetterOperator< Lhs> >, public TRef<1>
{
  public:
    typedef ExprBase< DiagonalGetterOperator< Lhs> > Base;
    typedef typename hidden::Traits< DiagonalGetterOperator<Lhs> >::Type Type;
    typedef typename hidden::Traits< DiagonalGetterOperator<Lhs> >::TypeConst TypeConst;
 
    enum
    {
        structure_ = hidden::Traits< DiagonalGetterOperator<Lhs> >::structure_,
        orient_    = hidden::Traits< DiagonalGetterOperator<Lhs> >::orient_,
        sizeRows_  = hidden::Traits< DiagonalGetterOperator<Lhs> >::sizeRows_,
        sizeCols_  = hidden::Traits< DiagonalGetterOperator<Lhs> >::sizeCols_,
        storage_   = hidden::Traits< DiagonalGetterOperator<Lhs> >::storage_,
        isValid_   = hidden::Traits< DiagonalGetterOperator<Lhs> >::isValid_,
        use_       = hidden::Traits< DiagonalGetterOperator<Lhs> >::use_,
        size_      = hidden::Traits< DiagonalGetterOperator<Lhs> >::size_
    };
    typedef hidden::DiagonalRangeImpl<Lhs, size_, use_> RangeImpl;
    typedef TRange<size_> RowRange;
    typedef TRange<size_> ColRange;
 
    inline DiagonalGetterOperator( Lhs const& lhs): Base(), lhs_(lhs)
    {
      STK_STATIC_ASSERT(isValid_,YOU_TRIED_CALLING_A_MATRIX_METHOD_ON_A_VECTOR);
#ifdef STK_BOUNDS_CHECK
      if (lhs.rows()!=lhs.cols())
        STKRUNTIME_ERROR_NO_ARG(DiagonalGetterOperatorBase,lhs.rows()!=lhs.cols());
#endif
    }
    inline Lhs const& lhs() const { return lhs_; }
    inline RowRange const& rowsImpl() const { return RangeImpl::rangeImpl(lhs_);}
    inline ColRange const& colsImpl() const { return RangeImpl::rangeImpl(lhs_);}
 
    inline TypeConst elt2Impl(int i, int j) const { return (lhs_.elt(i, j));}
    inline TypeConst elt1Impl(int i) const { return (lhs_.elt(i,i));}
    inline TypeConst elt0Impl() const { return (lhs_.elt());}
 
  protected:
    Lhs const& lhs_;
};
 
 
namespace hidden
{
template<typename Lhs>
struct Traits< UpperTriangularizeOperator<Lhs> >
{
  enum
  {
    structure_ = Arrays::upper_triangular_,
    orient_    = Lhs::orient_,
    sizeRows_  = Lhs::sizeRows_,
    sizeCols_  = Lhs::sizeCols_,
    storage_   = Lhs::storage_
  };
  typedef RowOperator< UpperTriangularizeOperator< Lhs> > Row;
  typedef ColOperator< UpperTriangularizeOperator< Lhs> > Col;
  typedef typename Lhs::Type Type;
  typedef typename Lhs::TypeConst TypeConst;
};
 
} // namespace hidden
 
template< typename Lhs>
class UpperTriangularizeOperator: public ExprBase< UpperTriangularizeOperator< Lhs> >, public TRef<1>
{
  public:
    typedef ExprBase< UpperTriangularizeOperator< Lhs> > Base;
    typedef typename hidden::Traits< UpperTriangularizeOperator<Lhs> >::Type Type;
    typedef typename hidden::Traits< UpperTriangularizeOperator<Lhs> >::TypeConst TypeConst;
 
    enum
    {
        structure_ = hidden::Traits< UpperTriangularizeOperator<Lhs> >::structure_,
        orient_    = hidden::Traits< UpperTriangularizeOperator<Lhs> >::orient_,
        sizeRows_  = hidden::Traits< UpperTriangularizeOperator<Lhs> >::sizeRows_,
        sizeCols_  = hidden::Traits< UpperTriangularizeOperator<Lhs> >::sizeCols_,
        storage_   = hidden::Traits< UpperTriangularizeOperator<Lhs> >::storage_
    };
    typedef TRange<sizeRows_> RowRange;
    typedef TRange<sizeCols_> ColRange;
 
    inline UpperTriangularizeOperator( Lhs const& lhs): Base(), lhs_(lhs) {}
    inline Lhs const& lhs() const { return lhs_; }
    inline RowRange const& rowsImpl() const { return lhs().rows();}
    inline ColRange const& colsImpl() const { return lhs().cols();}
 
    inline TypeConst elt2Impl(int i, int j) const
    {
#ifdef STK_BOUNDS_CHECK
      if (j<i)
        STKRUNTIME_ERROR_2ARG(UpperTriangularizeOperator::elt2Impl,i,j,use of the lower part);
#endif
      return (lhs_.elt(i, j));
    }
 
  protected:
    Lhs const& lhs_;
};
 
 
namespace hidden
{
template<typename Lhs>
struct Traits< LowerTriangularizeOperator<Lhs> >
{
  enum
  {
    structure_ = Arrays::lower_triangular_,
    orient_    = Lhs::orient_,
    sizeRows_  = Lhs::sizeRows_,
    sizeCols_  = Lhs::sizeCols_,
    storage_   = Lhs::storage_
  };
  typedef RowOperator< LowerTriangularizeOperator< Lhs> > Row;
  typedef ColOperator< LowerTriangularizeOperator< Lhs> > Col;
  typedef typename Lhs::Type Type;
  typedef typename Lhs::TypeConst TypeConst;
};
} // namespace hidden
 
template< typename Lhs>
class LowerTriangularizeOperator: public ExprBase< LowerTriangularizeOperator< Lhs> >, public TRef<1>
{
  public:
    typedef ExprBase< LowerTriangularizeOperator< Lhs> > Base;
    typedef typename hidden::Traits< LowerTriangularizeOperator<Lhs> >::Type Type;
    typedef typename hidden::Traits< LowerTriangularizeOperator<Lhs> >::TypeConst TypeConst;
 
    enum
    {
        structure_ = hidden::Traits< LowerTriangularizeOperator<Lhs> >::structure_,
        orient_    = hidden::Traits< LowerTriangularizeOperator<Lhs> >::orient_,
        sizeRows_  = hidden::Traits< LowerTriangularizeOperator<Lhs> >::sizeRows_,
        sizeCols_  = hidden::Traits< LowerTriangularizeOperator<Lhs> >::sizeCols_,
        storage_   = hidden::Traits< LowerTriangularizeOperator<Lhs> >::storage_
    };
    typedef TRange<sizeRows_> RowRange;
    typedef TRange<sizeCols_> ColRange;
 
    inline LowerTriangularizeOperator( Lhs const& lhs): Base(), lhs_(lhs) {}
    inline Lhs const& lhs() const { return lhs_; }
    inline RowRange const& rowsImpl() const { return lhs().rows();}
    inline ColRange const& colsImpl() const { return lhs().cols();}
 
    inline TypeConst elt2Impl(int i, int j) const
    {
#ifdef STK_BOUNDS_CHECK
      if (j>i)
        STKRUNTIME_ERROR_2ARG(LowerTriangularizeOperator::elt2Impl,i,j,use of the upper part);
#endif
      return (lhs_.elt(i, j));
    }
 
  protected:
    Lhs const& lhs_;
};
 
namespace hidden
{
template<typename Lhs>
struct Traits< SymmetrizeOperator<Lhs> >
{
  enum
  {
    structure_ = Arrays::symmetric_,
    orient_    = Lhs::orient_,
    sizeRows_  = Lhs::sizeRows_,
    sizeCols_  = Lhs::sizeCols_,
    storage_   = Lhs::storage_
  };
  typedef RowOperator< SymmetrizeOperator< Lhs> > Row;
  typedef ColOperator< SymmetrizeOperator< Lhs> > Col;
  typedef typename Lhs::Type Type;
  typedef typename Lhs::TypeConst TypeConst;
};
 
} // namespace hidden
 
template< typename Lhs>
class SymmetrizeOperator: public ExprBase< SymmetrizeOperator< Lhs> >, public TRef<1>
{
  public:
    typedef ExprBase< SymmetrizeOperator< Lhs> > Base;
    typedef typename hidden::Traits< SymmetrizeOperator<Lhs> >::Type Type;
    typedef typename hidden::Traits< SymmetrizeOperator<Lhs> >::TypeConst TypeConst;
 
    enum
    {
        structure_ = hidden::Traits< SymmetrizeOperator<Lhs> >::structure_,
        orient_    = hidden::Traits< SymmetrizeOperator<Lhs> >::orient_,
        sizeRows_  = hidden::Traits< SymmetrizeOperator<Lhs> >::sizeRows_,
        sizeCols_  = hidden::Traits< SymmetrizeOperator<Lhs> >::sizeCols_,
        storage_   = hidden::Traits< SymmetrizeOperator<Lhs> >::storage_
    };
    typedef TRange<sizeRows_> RowRange;
    typedef TRange<sizeCols_> ColRange;
 
    inline SymmetrizeOperator( Lhs const& lhs): Base(), lhs_(lhs)
    { STK_STATIC_ASSERT_TWO_DIMENSIONS_ONLY(Lhs);}
    inline Lhs const& lhs() const { return lhs_; }
    inline RowRange const& rowsImpl() const { return lhs().rows();}
    inline ColRange const& colsImpl() const { return lhs().cols();}
 
    inline TypeConst elt2Impl(int i, int j) const
    { return (lhs_.elt(i, j));}
 
  protected:
    Lhs const& lhs_;
};
 
 
namespace hidden
{
template<typename Lhs>
struct Traits< UpperSymmetrizeOperator<Lhs> >
{
  enum
  {
    structure_ = Arrays::upper_symmetric_,
    orient_    = Lhs::orient_,
    sizeRows_  = Lhs::sizeRows_,
    sizeCols_  = Lhs::sizeCols_,
    storage_   = Lhs::storage_
  };
  typedef RowOperator< UpperSymmetrizeOperator< Lhs> > Row;
  typedef ColOperator< UpperSymmetrizeOperator< Lhs> > Col;
  typedef typename Lhs::Type Type;
  typedef typename Lhs::TypeConst TypeConst;
};
 
} // namespace hidden
 
template< typename Lhs>
class UpperSymmetrizeOperator: public ExprBase< UpperSymmetrizeOperator< Lhs> >, public TRef<1>
{
  public:
    typedef ExprBase< UpperSymmetrizeOperator< Lhs> > Base;
    typedef typename hidden::Traits< UpperSymmetrizeOperator<Lhs> >::Type Type;
    typedef typename hidden::Traits< UpperSymmetrizeOperator<Lhs> >::TypeConst TypeConst;
 
    enum
    {
        structure_ = hidden::Traits< UpperSymmetrizeOperator<Lhs> >::structure_,
        orient_    = hidden::Traits< UpperSymmetrizeOperator<Lhs> >::orient_,
        sizeRows_  = hidden::Traits< UpperSymmetrizeOperator<Lhs> >::sizeRows_,
        sizeCols_  = hidden::Traits< UpperSymmetrizeOperator<Lhs> >::sizeCols_,
        storage_   = hidden::Traits< UpperSymmetrizeOperator<Lhs> >::storage_
    };
    typedef TRange<sizeRows_> RowRange;
    typedef TRange<sizeCols_> ColRange;
 
    inline UpperSymmetrizeOperator( Lhs const& lhs): Base(), lhs_(lhs)
    { STK_STATIC_ASSERT_TWO_DIMENSIONS_ONLY(Lhs);}
    inline Lhs const& lhs() const { return lhs_; }
    inline RowRange const& rowsImpl() const { return lhs().rows();}
    inline ColRange const& colsImpl() const { return lhs().cols();}
 
    inline TypeConst elt2Impl(int i, int j) const
    { return ((j<i) ? lhs_.elt(j, i) : lhs_.elt(i, j));}
 
  protected:
    Lhs const& lhs_;
};
 
namespace hidden
{
template<typename Lhs>
struct Traits< LowerSymmetrizeOperator<Lhs> >
{
  enum
  {
    structure_ = Arrays::lower_symmetric_,
    orient_    = Lhs::orient_,
    sizeRows_  = Lhs::sizeRows_,
    sizeCols_  = Lhs::sizeCols_,
    storage_   = Lhs::storage_
  };
  typedef RowOperator< LowerSymmetrizeOperator< Lhs> > Row;
  typedef ColOperator< LowerSymmetrizeOperator< Lhs> > Col;
  typedef typename Lhs::Type Type;
  typedef typename Lhs::TypeConst TypeConst;
};
 
} // end namespace hidden
 
template< typename Lhs>
class LowerSymmetrizeOperator: public ExprBase< LowerSymmetrizeOperator< Lhs> >, public TRef<1>
{
  public:
    typedef ExprBase< LowerSymmetrizeOperator< Lhs> > Base;
    typedef typename hidden::Traits< LowerSymmetrizeOperator<Lhs> >::Type Type;
    typedef typename hidden::Traits< LowerSymmetrizeOperator<Lhs> >::TypeConst TypeConst;
 
    enum
    {
        structure_ = hidden::Traits< LowerSymmetrizeOperator<Lhs> >::structure_,
        orient_    = hidden::Traits< LowerSymmetrizeOperator<Lhs> >::orient_,
        sizeRows_  = hidden::Traits< LowerSymmetrizeOperator<Lhs> >::sizeRows_,
        sizeCols_  = hidden::Traits< LowerSymmetrizeOperator<Lhs> >::sizeCols_,
        storage_   = hidden::Traits< LowerSymmetrizeOperator<Lhs> >::storage_
    };
    typedef TRange<sizeRows_> RowRange;
    typedef TRange<sizeCols_> ColRange;
 
    inline LowerSymmetrizeOperator( Lhs const& lhs): Base(), lhs_(lhs)
    { STK_STATIC_ASSERT_TWO_DIMENSIONS_ONLY(Lhs);}
    inline Lhs const& lhs() const { return lhs_; }
    inline RowRange const& rowsImpl() const { return lhs().rows();}
    inline ColRange const& colsImpl() const { return lhs().cols();}
 
    inline TypeConst elt2Impl(int i, int j) const
    { return ((j>i) ? lhs_.elt(j, i) : lhs_.elt(i, j));}
 
  protected:
    Lhs const& lhs_;
};
 
} // namespace STK
 
 
#undef EGAL
 
#endif /* STK_RESHAPEOPERATORS_H */