STK_ProductOperators.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: 20 oct. 2012
 * Author:   iovleff, S..._Dot_I..._At_stkpp_Dot_org (see copyright for ...)
 **/
 
#ifndef STK_PRODUCTOPERATORS_H
#define STK_PRODUCTOPERATORS_H
 
// forward declaration
namespace STK
{
  template<class Derived> class ExprBase;
  template<typename Type, int SizeRows_, int SizeCols_, bool Orient_> class CAllocator;
}
 
#define EGAL(arg1, arg2) ((arg1::structure_ == int(Arrays::arg2)))
 
namespace STK
{
template<typename Lhs, typename Rhs> class ArrayByDiagonalProduct;
 
template<typename Lhs, typename Rhs> class DiagonalByArrayProduct;
 
template<typename Lhs, typename Rhs> class VectorByPointProduct;
 
template<typename Lhs, typename Rhs> class PointByArrayProduct;
 
template<typename Lhs, typename Rhs> class ArrayByVectorProduct;
 
template<typename Lhs, typename Rhs> class ArrayByArrayProduct;
 
namespace hidden
{
template< typename Lhs, typename Rhs>
struct Traits< ArrayByDiagonalProduct < Lhs, Rhs> >
{
  enum
  {
    structure_ = Lhs::structure_,
    sizeRows_  = Lhs::sizeRows_ ,
    sizeCols_  = Rhs::sizeCols_,
    orient_    = Lhs::orient_,
    storage_   = Lhs::storage_
  };
  typedef typename Promote<typename Lhs::Type, typename Rhs::Type>::result_type Type;
  typedef typename RemoveConst<Type>::Type TypeConst;
};
 
} // namespace hidden
 
template<typename Lhs, typename Rhs>
class ArrayByDiagonalProduct: public ExprBase< ArrayByDiagonalProduct<Lhs, Rhs> >
                            , public TRef<1>
{
  public:
    typedef ExprBase< ArrayByDiagonalProduct<Lhs, Rhs> > Base;
    typedef typename hidden::Traits<ArrayByDiagonalProduct>::Type Type;
    typedef typename hidden::Traits<ArrayByDiagonalProduct>::TypeConst TypeConst;
 
    enum
    {
      structure_ = hidden::Traits<ArrayByDiagonalProduct>::structure_,
      orient_    = hidden::Traits<ArrayByDiagonalProduct>::orient_,
      sizeRows_  = hidden::Traits<ArrayByDiagonalProduct>::sizeRows_,
      sizeCols_  = hidden::Traits<ArrayByDiagonalProduct>::sizeCols_,
      storage_   = hidden::Traits<ArrayByDiagonalProduct>::storage_
    };
    typedef TRange<sizeRows_> RowRange;
    typedef TRange<sizeCols_> ColRange;
 
    inline ArrayByDiagonalProduct( const Lhs& lhs, const Rhs& rhs)
                                 : Base(), lhs_(lhs), rhs_(rhs)
    {
      if (lhs.cols() != rhs.rows())
      { STKRUNTIME_ERROR_NO_ARG(ArrayByDiagonalProduct, sizes mismatch);}
    }
    inline RowRange const& rowsImpl() const { return lhs_.rows();}
    inline ColRange const& colsImpl() const { return rhs_.cols();}
 
    inline TypeConst elt2Impl(int i, int j) const { return lhs_.elt(i,j)*rhs_.elt(j);}
    inline TypeConst elt1Impl(int i) const { return lhs_.elt(i)*rhs_.elt(i);}
 
    inline Lhs const& lhs() const { return lhs_; }
    inline Rhs const& rhs() const { return rhs_; }
 
  protected:
    Lhs const& lhs_;
    Rhs const& rhs_;
};
 
namespace hidden
{
template< typename Lhs, typename Rhs>
struct Traits< DiagonalByArrayProduct < Lhs, Rhs> >
{
  enum
  {
    structure_ = Rhs::structure_,
    sizeRows_  = Lhs::sizeRows_,
    sizeCols_  = Rhs::sizeCols_,
    orient_    = Rhs::orient_,
    storage_   = Rhs::storage_
  };
  typedef typename Promote<typename Lhs::Type, typename Rhs::Type>::result_type Type;
  typedef typename RemoveConst<Type>::Type TypeConst;  // not a reference as it is a temporary
};
 
} // namespace hidden
 
template<typename Lhs, typename Rhs>
class DiagonalByArrayProduct: public ExprBase< DiagonalByArrayProduct<Lhs, Rhs> >
                            , public TRef<1>
{
  public:
    typedef ExprBase< DiagonalByArrayProduct<Lhs, Rhs> > Base;
    typedef typename hidden::Traits<DiagonalByArrayProduct>::Type Type;
    typedef typename hidden::Traits<DiagonalByArrayProduct>::TypeConst TypeConst;
 
    enum
    {
      structure_ = hidden::Traits<DiagonalByArrayProduct>::structure_,
      orient_    = hidden::Traits<DiagonalByArrayProduct>::orient_,
      sizeRows_  = hidden::Traits<DiagonalByArrayProduct>::sizeRows_,
      sizeCols_  = hidden::Traits<DiagonalByArrayProduct>::sizeCols_,
      storage_   = hidden::Traits<DiagonalByArrayProduct>::storage_
    };
    typedef TRange<sizeRows_> RowRange;
    typedef TRange<sizeCols_> ColRange;
 
    inline DiagonalByArrayProduct( const Lhs& lhs, const Rhs& rhs)
                                : Base(), lhs_(lhs), rhs_(rhs)
    {
      if (lhs.cols() != rhs.rows())
      { STKRUNTIME_ERROR_NO_ARG(DiagonalByArrayProduct, sizes mismatch);}
    }
    inline RowRange const& rowsImpl() const { return lhs_.rows();}
    inline ColRange const& colsImpl() const { return rhs_.cols();}
 
    inline TypeConst elt2Impl(int i, int j) const { return lhs_.elt(i)*rhs_.elt(i,j);}
    inline TypeConst elt1Impl(int i) const { return lhs_.elt(i)*rhs_.elt(i);}
 
    inline Lhs const& lhs() const { return lhs_; }
    inline Rhs const& rhs() const { return rhs_; }
 
  protected:
    Lhs const& lhs_;
    Rhs const& rhs_;
};
 
 
namespace hidden
{
template< typename Lhs, typename Rhs>
struct Traits< VectorByPointProduct < Lhs, Rhs> >
{
  enum
  {
    structure_ = Arrays::array2D_,
    sizeRows_  = Traits<Lhs>::sizeRows_,
    sizeCols_  = Traits<Rhs>::sizeCols_,
    orient_    = Arrays::by_col_,
    storage_   = ( Traits<Lhs>::storage_ == int(Arrays::dense_)) || (Traits<Rhs>::storage_ == int(Arrays::dense_))
                 ? int(Arrays::dense_) : int(Arrays::sparse_)
  };
  typedef typename Promote<typename Lhs::Type, typename Rhs::Type>::result_type Type;
  typedef typename RemoveConst<Type>::Type TypeConst; // not a reference
};
 
} // namespace hidden
 
template<typename Lhs, typename Rhs>
 
class VectorByPointProduct: public ExprBase< VectorByPointProduct<Lhs, Rhs> >
                          , public TRef<1>
{
  public:
    typedef ExprBase< VectorByPointProduct<Lhs, Rhs> > Base;
    typedef typename hidden::Traits<VectorByPointProduct>::Type Type;
    typedef typename hidden::Traits<VectorByPointProduct>::TypeConst TypeConst;
 
    enum
    {
      structure_ = hidden::Traits<VectorByPointProduct>::structure_,
      orient_    = hidden::Traits<VectorByPointProduct>::orient_,
      sizeRows_  = hidden::Traits<VectorByPointProduct>::sizeRows_,
      sizeCols_  = hidden::Traits<VectorByPointProduct>::sizeCols_,
      storage_   = hidden::Traits<VectorByPointProduct>::storage_
    };
    typedef TRange<sizeRows_> RowRange;
    typedef TRange<sizeCols_> ColRange;
 
    VectorByPointProduct( const Lhs& lhs, const Rhs& rhs): Base(), lhs_(lhs), rhs_(rhs){}
    inline RowRange const& rowsImpl() const { return lhs_.rows();}
    inline ColRange const& colsImpl() const { return rhs_.cols();}
 
    inline TypeConst elt2Impl(int i, int j) const { return lhs_.elt(i)*rhs_.elt(j);}
    inline TypeConst elt0Impl() const { return lhs_.elt()*rhs_.elt();}
 
    inline Lhs const& lhs() const { return lhs_; }
    inline Rhs const& rhs() const { return rhs_; }
 
  protected:
    Lhs const& lhs_;
    Rhs const& rhs_;
};
 
 
 
namespace hidden
{
template< typename Lhs, typename Rhs>
struct Traits< PointByArrayProduct < Lhs, Rhs> >
{
  enum
   {
     structure_ = Arrays::point_,
     sizeRows_  = 1,
     sizeCols_  = Traits<Rhs>::sizeCols_,
     orient_    = Arrays::by_row_,
     storage_   = ( Traits<Lhs>::storage_ == int(Arrays::dense_)) || (Traits<Rhs>::storage_ == int(Arrays::dense_))
                  ? int(Arrays::dense_) : int(Arrays::sparse_)
   };
 
  typedef typename hidden::Promote< typename Lhs::Type, typename Rhs::Type>::result_type Type;
  typedef typename RemoveConst<Type>::Type const& TypeConst;
 
  typedef CAllocator<Type, sizeRows_, sizeCols_, orient_> Allocator;
};
 
} // namespace hidden
 
template<typename Lhs, typename Rhs>
class PointByArrayProduct: public ExprBase< PointByArrayProduct<Lhs, Rhs> >
                         , public TRef<1>
{
  public:
    typedef ExprBase< PointByArrayProduct<Lhs, Rhs> > Base;
    typedef typename hidden::Traits<PointByArrayProduct>::Type Type;
    typedef typename hidden::Traits<PointByArrayProduct>::TypeConst TypeConst;
    typedef typename hidden::Traits<PointByArrayProduct>::Allocator Allocator;
 
    enum
    {
      structure_ = hidden::Traits<PointByArrayProduct>::structure_,
      orient_    = hidden::Traits<PointByArrayProduct>::orient_,
      sizeRows_  = hidden::Traits<PointByArrayProduct>::sizeRows_,
      sizeCols_  = hidden::Traits<PointByArrayProduct>::sizeCols_,
      storage_   = hidden::Traits<PointByArrayProduct>::storage_
    };
    typedef TRange<sizeRows_> RowRange;
    typedef TRange<sizeCols_> ColRange;
 
    inline PointByArrayProduct( const Lhs& lhs, const Rhs& rhs)
                             : Base(), lhs_(lhs), rhs_(rhs)
                             , result_(1, rhs.sizeCols(), Type(0))
    {
      if (lhs.range() != rhs.rows())
      { STKRUNTIME_ERROR_2ARG(PointByArrayProduct, lhs.range(), rhs.rows(), sizes mismatch);}
      result_.shift(lhs_.beginRows(), rhs_.beginCols());
      hidden::ProductDispatcher<Lhs, Rhs, Allocator>::run(lhs, rhs, result_);
    }
    inline RowRange const& rowsImpl() const { return result_.rows();}
    inline ColRange const& colsImpl() const { return result_.cols();}
 
    inline TypeConst elt2Impl(int i, int j) const { return result_.elt(i, j);}
    inline TypeConst elt1Impl(int i) const { return result_.elt(i);}
    inline TypeConst elt0Impl() const { return result_.elt();}
 
    inline Lhs const& lhs() const { return lhs_; }
    inline Rhs const& rhs() const { return rhs_; }
    Allocator const& result() const { return result_; }
 
  protected:
    Lhs const& lhs_;
    Rhs const& rhs_;
 
  private:
    Allocator result_;
};
 
namespace hidden
{
template< typename Lhs, typename Rhs>
struct Traits< ArrayByVectorProduct < Lhs, Rhs> >
{
  enum
   {
     structure_ = Arrays::vector_,
     orient_    = Arrays::by_col_,
     sizeRows_  = Traits<Lhs>::sizeRows_,
     sizeCols_  = 1,
     storage_   = ( Traits<Lhs>::storage_ == int(Arrays::dense_)) || (Traits<Rhs>::storage_ == int(Arrays::dense_))
                  ? int(Arrays::dense_) : int(Arrays::sparse_)
   };
 
  typedef typename hidden::Promote< typename Lhs::Type, typename Rhs::Type>::result_type Type;
  typedef typename RemoveConst<Type>::Type const& TypeConst;
 
  typedef CAllocator<Type, sizeRows_, sizeCols_, orient_> Allocator;
};
 
} // nmaespace hidden
 
template<typename Lhs, typename Rhs>
class ArrayByVectorProduct: public ExprBase< ArrayByVectorProduct<Lhs, Rhs> >
                           , public TRef<1>
{
  public:
    typedef ExprBase< ArrayByVectorProduct<Lhs, Rhs> > Base;
    typedef typename hidden::Traits<ArrayByVectorProduct>::Type Type;
    typedef typename hidden::Traits<ArrayByVectorProduct>::TypeConst TypeConst;
    typedef typename hidden::Traits<ArrayByVectorProduct>::Allocator Allocator;
    enum
    {
      structure_ = hidden::Traits<ArrayByVectorProduct>::structure_,
      orient_    = hidden::Traits<ArrayByVectorProduct>::orient_,
      sizeRows_  = hidden::Traits<ArrayByVectorProduct>::sizeRows_,
      sizeCols_  = hidden::Traits<ArrayByVectorProduct>::sizeCols_,
      storage_   = hidden::Traits<ArrayByVectorProduct>::storage_
    };
    typedef TRange<sizeRows_> RowRange;
    typedef TRange<sizeCols_> ColRange;
 
    ArrayByVectorProduct( const Lhs& lhs, const Rhs& rhs)
                        : Base(), lhs_(lhs), rhs_(rhs)
                        , result_(lhs.sizeRows(), 1, Type(0)) // create result
    {
      if (lhs.cols() != rhs.range())
      { STKRUNTIME_ERROR_NO_ARG(ArrayByVectorProduct, sizes mismatch);}
      result_.shift(lhs_.beginRows(), rhs_.beginCols());
      hidden::ProductDispatcher<Lhs, Rhs, Allocator>::run(lhs, rhs, result_);
    }
    inline RowRange const& rowsImpl() const { return result_.rows();}
    inline ColRange const& colsImpl() const { return result_.cols();}
 
    inline TypeConst elt2Impl(int i, int j) const { return result_.elt(i, j);}
    inline TypeConst elt1Impl(int i) const { return result_.elt(i);}
    inline TypeConst elt0Impl() const { return result_.elt();}
 
    inline Lhs const& lhs() const { return lhs_; }
    inline Rhs const& rhs() const { return rhs_; }
    inline Allocator const& result() const { return result_; }
 
  protected:
    Lhs const& lhs_;
    Rhs const& rhs_;
 
  private:
    Allocator result_;
};
 
 
namespace hidden
{
template< typename Lhs, typename Rhs>
struct Traits< ArrayByArrayProduct<Lhs, Rhs> >
{
  // delegate to ProductTraits all the stuff
  typedef ProductTraits<Lhs, Rhs, Traits<Lhs>::structure_, Traits<Rhs>::structure_> Base;
 
  enum
  {
    lhs_structure_  = Traits<Lhs>::structure_,
    rhs_structure_  = Traits<Rhs>::structure_,
    structure_      = Base::structure_,
    sizeRows_       = Base::sizeRows_,
    sizeCols_       = Base::sizeCols_,
    orient_         = Base::orient_,
    storage_        = Base::storage_,
    useForRows_     = Base::useForRows_,
    useForCols_     = Base::useForCols_
  };
 
  typedef typename Base::Type Type;
  typedef typename Base::TypeConst TypeConst;
  typedef typename Base::Allocator Allocator;
};
 
} // namespace hidden
 
template<typename Lhs, typename Rhs>
class ArrayByArrayProduct: public ExprBase< ArrayByArrayProduct<Lhs, Rhs> >, public TRef<1>
{
  public:
    enum
    {
      // All the valid cases for ArrayByArray operator
      isValid_ = (  EGAL(Lhs,array2D_)||EGAL(Lhs,square_)
                  ||EGAL(Lhs,lower_triangular_)||EGAL(Lhs,upper_triangular_)
                  ||EGAL(Lhs,symmetric_)||EGAL(Lhs,lower_symmetric_)||EGAL(Lhs,upper_symmetric_)
                 )
                 &&
                 (  EGAL(Rhs,array2D_)||EGAL(Rhs,square_)
                  ||EGAL(Rhs,lower_triangular_)||EGAL(Rhs,upper_triangular_)
                  ||EGAL(Rhs,symmetric_)||EGAL(Rhs,lower_symmetric_)||EGAL(Rhs,upper_symmetric_)
                 ),
      lhs_structure_ = hidden::Traits< ArrayByArrayProduct >::lhs_structure_,
      rhs_structure_ = hidden::Traits< ArrayByArrayProduct >::rhs_structure_,
      structure_     = hidden::Traits< ArrayByArrayProduct >::structure_,
      orient_        = hidden::Traits< ArrayByArrayProduct >::orient_,
      sizeRows_      = hidden::Traits< ArrayByArrayProduct >::sizeRows_,
      sizeCols_      = hidden::Traits< ArrayByArrayProduct >::sizeCols_,
      storage_       = hidden::Traits< ArrayByArrayProduct >::storage_,
      useForRows_    = hidden::Traits< ArrayByArrayProduct >::useForRows_,
      useForCols_    = hidden::Traits< ArrayByArrayProduct >::useForCols_
    };
 
    typedef ExprBase< ArrayByArrayProduct<Lhs, Rhs> > Base;
    typedef typename hidden::Traits< ArrayByArrayProduct>::Type Type;
    typedef typename hidden::Traits< ArrayByArrayProduct>::TypeConst TypeConst;
 
    typedef typename hidden::Traits< ArrayByArrayProduct < Lhs, Rhs> >::Allocator Allocator;
    typedef hidden::ProductDispatcher<Lhs, Rhs, Allocator, lhs_structure_, rhs_structure_> Dispatcher;
 
    typedef hidden::BinaryRowsImpl< Lhs, Rhs, sizeRows_, useForRows_ > RowsImpl;
    typedef hidden::BinaryColsImpl< Lhs, Rhs, sizeCols_, useForCols_ > ColsImpl;
 
    typedef TRange<sizeRows_> RowRange;
    typedef TRange<sizeCols_> ColRange;
    ArrayByArrayProduct( Lhs const& lhs, Rhs const& rhs);
 
    inline RowRange const& rowsImpl() const { return RowsImpl::rowsImpl(lhs_, rhs_);}
    inline ColRange const& colsImpl() const { return ColsImpl::colsImpl(lhs_, rhs_);}
 
    inline Lhs const& lhs() const { return lhs_; }
    inline Rhs const& rhs() const { return rhs_; }
    inline Allocator const& result() const { return result_; }
 
    inline TypeConst elt2Impl(int i, int j) const { return result_.elt(i,j);}
    inline TypeConst elt1Impl(int i) const  { return result_.elt(i);}
    inline TypeConst elt0Impl() const { return result_.elt();}
 
  protected:
    Lhs const& lhs_;
    Rhs const& rhs_;
 
  private:
    Allocator result_;
};
 
template<typename Lhs, typename Rhs>
ArrayByArrayProduct<Lhs,Rhs>::ArrayByArrayProduct( Lhs const& lhs, Rhs const& rhs)
                                                 : Base(), lhs_(lhs), rhs_(rhs)
                                                 , result_(lhs.sizeRows(), rhs.sizeCols(), Type(0))
{
  STK_STATIC_ASSERT_PRODUCT_OPERATOR_MISMATCH( isValid_ );
  if (lhs.cols() != rhs.rows())
  { STKRUNTIME_ERROR_NO_ARG(ArrayByArrayProduct,sizes mismatch for 2D array);}
  result_.shift(lhs_.beginRows(), rhs_.beginCols());
  // general sizes
  Dispatcher::run(lhs, rhs, result_);
}
 
}  // namespace STK
 
#undef EGAL
 
#endif /* STK_PRODUCTOPERATORS_H */