comparison armadillo-2.4.4/include/armadillo_bits/gemm.hpp @ 0:8b6102e2a9b0

Armadillo Library

+// Copyright (C) 2008-2011 NICTA (www.nicta.com.au)
+// Copyright (C) 2008-2011 Conrad Sanderson
+// 
+// This file is part of the Armadillo C++ library.
+// It is provided without any warranty of fitness
+// for any purpose. You can redistribute this file
+// and/or modify it under the terms of the GNU
+// Lesser General Public License (LGPL) as published
+// by the Free Software Foundation, either version 3
+// of the License or (at your option) any later version.
+// (see http://www.opensource.org/licenses for more info)
+
+
+//! \addtogroup gemm
+//! @{
+
+
+
+//! for tiny square matrices, size <= 4x4
+template<const bool do_trans_A=false, const bool use_alpha=false, const bool use_beta=false>
+class gemm_emul_tinysq
+  {
+  public:
+  
+  
+  template<typename eT>
+  arma_hot
+  inline
+  static
+  void
+  apply
+    (
+          Mat<eT>& C,
+    const Mat<eT>& A,
+    const Mat<eT>& B,
+    const eT alpha = eT(1),
+    const eT beta  = eT(0)
+    )
+    {
+    arma_extra_debug_sigprint();
+    
+    switch(A.n_rows)
+      {
+      case 4:
+        gemv_emul_tinysq<do_trans_A, use_alpha, use_beta>::apply( C.colptr(3), A, B.colptr(3), alpha, beta );
+        
+      case 3:
+        gemv_emul_tinysq<do_trans_A, use_alpha, use_beta>::apply( C.colptr(2), A, B.colptr(2), alpha, beta );
+        
+      case 2:
+        gemv_emul_tinysq<do_trans_A, use_alpha, use_beta>::apply( C.colptr(1), A, B.colptr(1), alpha, beta );
+        
+      case 1:
+        gemv_emul_tinysq<do_trans_A, use_alpha, use_beta>::apply( C.colptr(0), A, B.colptr(0), alpha, beta );
+        
+      default:
+        ;
+      }
+    }
+  
+  };
+
+
+
+template<const bool do_trans_A=false, const bool do_trans_B=false, const bool use_alpha=false, const bool use_beta=false>
+class gemm_emul_large
+  {
+  public:
+  
+  template<typename eT>
+  arma_hot
+  inline
+  static
+  void
+  apply
+    (
+          Mat<eT>& C,
+    const Mat<eT>& A,
+    const Mat<eT>& B,
+    const eT alpha = eT(1),
+    const eT beta  = eT(0)
+    )
+    {
+    arma_extra_debug_sigprint();
+
+    const uword A_n_rows = A.n_rows;
+    const uword A_n_cols = A.n_cols;
+    
+    const uword B_n_rows = B.n_rows;
+    const uword B_n_cols = B.n_cols;
+    
+    if( (do_trans_A == false) && (do_trans_B == false) )
+      {
+      arma_aligned podarray<eT> tmp(A_n_cols);
+      eT* A_rowdata = tmp.memptr();
+      
+      for(uword row_A=0; row_A < A_n_rows; ++row_A)
+        {
+        tmp.copy_row(A, row_A);
+        
+        for(uword col_B=0; col_B < B_n_cols; ++col_B)
+          {
+          const eT acc = op_dot::direct_dot_arma(B_n_rows, A_rowdata, B.colptr(col_B));
+          
+          if( (use_alpha == false) && (use_beta == false) )
+            {
+            C.at(row_A,col_B) = acc;
+            }
+          else
+          if( (use_alpha == true) && (use_beta == false) )
+            {
+            C.at(row_A,col_B) = alpha * acc;
+            }
+          else
+          if( (use_alpha == false) && (use_beta == true) )
+            {
+            C.at(row_A,col_B) = acc + beta*C.at(row_A,col_B);
+            }
+          else
+          if( (use_alpha == true) && (use_beta == true) )
+            {
+            C.at(row_A,col_B) = alpha*acc + beta*C.at(row_A,col_B);
+            }
+          
+          }
+        }
+      }
+    else
+    if( (do_trans_A == true) && (do_trans_B == false) )
+      {
+      for(uword col_A=0; col_A < A_n_cols; ++col_A)
+        {
+        // col_A is interpreted as row_A when storing the results in matrix C
+        
+        const eT* A_coldata = A.colptr(col_A);
+        
+        for(uword col_B=0; col_B < B_n_cols; ++col_B)
+          {
+          const eT acc = op_dot::direct_dot_arma(B_n_rows, A_coldata, B.colptr(col_B));
+          
+          if( (use_alpha == false) && (use_beta == false) )
+            {
+            C.at(col_A,col_B) = acc;
+            }
+          else
+          if( (use_alpha == true) && (use_beta == false) )
+            {
+            C.at(col_A,col_B) = alpha * acc;
+            }
+          else
+          if( (use_alpha == false) && (use_beta == true) )
+            {
+            C.at(col_A,col_B) = acc + beta*C.at(col_A,col_B);
+            }
+          else
+          if( (use_alpha == true) && (use_beta == true) )
+            {
+            C.at(col_A,col_B) = alpha*acc + beta*C.at(col_A,col_B);
+            }
+          
+          }
+        }
+      }
+    else
+    if( (do_trans_A == false) && (do_trans_B == true) )
+      {
+      Mat<eT> BB;
+      op_strans::apply_noalias(BB, B);
+      
+      gemm_emul_large<false, false, use_alpha, use_beta>::apply(C, A, BB, alpha, beta);
+      }
+    else
+    if( (do_trans_A == true) && (do_trans_B == true) )
+      {
+      // mat B_tmp = trans(B);
+      // dgemm_arma<true, false,  use_alpha, use_beta>::apply(C, A, B_tmp, alpha, beta);
+      
+      
+      // By using the trans(A)*trans(B) = trans(B*A) equivalency,
+      // transpose operations are not needed
+      
+      arma_aligned podarray<eT> tmp(B.n_cols);
+      eT* B_rowdata = tmp.memptr();
+      
+      for(uword row_B=0; row_B < B_n_rows; ++row_B)
+        {
+        tmp.copy_row(B, row_B);
+        
+        for(uword col_A=0; col_A < A_n_cols; ++col_A)
+          {
+          const eT acc = op_dot::direct_dot_arma(A_n_rows, B_rowdata, A.colptr(col_A));
+          
+          if( (use_alpha == false) && (use_beta == false) )
+            {
+            C.at(col_A,row_B) = acc;
+            }
+          else
+          if( (use_alpha == true) && (use_beta == false) )
+            {
+            C.at(col_A,row_B) = alpha * acc;
+            }
+          else
+          if( (use_alpha == false) && (use_beta == true) )
+            {
+            C.at(col_A,row_B) = acc + beta*C.at(col_A,row_B);
+            }
+          else
+          if( (use_alpha == true) && (use_beta == true) )
+            {
+            C.at(col_A,row_B) = alpha*acc + beta*C.at(col_A,row_B);
+            }
+          
+          }
+        }
+      
+      }
+    }
+  
+  };
+    
+  
+  
+template<const bool do_trans_A=false, const bool do_trans_B=false, const bool use_alpha=false, const bool use_beta=false>
+class gemm_emul
+  {
+  public:
+  
+  
+  template<typename eT>
+  arma_hot
+  inline
+  static
+  void
+  apply
+    (
+          Mat<eT>& C,
+    const Mat<eT>& A,
+    const Mat<eT>& B,
+    const eT alpha = eT(1),
+    const eT beta  = eT(0),
+    const typename arma_not_cx<eT>::result* junk = 0
+    )
+    {
+    arma_extra_debug_sigprint();
+    arma_ignore(junk);
+    
+    const uword A_n_rows = A.n_rows;
+    const uword A_n_cols = A.n_cols;
+    
+    const uword B_n_rows = B.n_rows;
+    const uword B_n_cols = B.n_cols;
+    
+    if( (A_n_rows <= 4) && (A_n_rows == A_n_cols) && (A_n_rows == B_n_rows) && (B_n_rows == B_n_cols) )
+      {
+      if(do_trans_B == false)
+        {
+        gemm_emul_tinysq<do_trans_A, use_alpha, use_beta>::apply(C, A, B, alpha, beta);
+        }
+      else
+        {
+        Mat<eT> BB(A_n_rows, A_n_rows);
+        op_strans::apply_noalias_tinysq(BB, B);
+        
+        gemm_emul_tinysq<do_trans_A, use_alpha, use_beta>::apply(C, A, BB, alpha, beta);
+        }
+      }
+    else
+      {
+      gemm_emul_large<do_trans_A, do_trans_B, use_alpha, use_beta>::apply(C, A, B, alpha, beta);
+      }
+    }
+  
+
+
+  template<typename eT>
+  arma_hot
+  inline
+  static
+  void
+  apply
+    (
+          Mat<eT>& C,
+    const Mat<eT>& A,
+    const Mat<eT>& B,
+    const eT alpha = eT(1),
+    const eT beta  = eT(0),
+    const typename arma_cx_only<eT>::result* junk = 0
+    )
+    {
+    arma_extra_debug_sigprint();
+    arma_ignore(junk);
+    
+    // "better than nothing" handling of hermitian transposes for complex number matrices
+    
+    Mat<eT> tmp_A;
+    Mat<eT> tmp_B;
+    
+    if(do_trans_A)
+      {
+      op_htrans::apply_noalias(tmp_A, A);
+      }
+    
+    if(do_trans_B)
+      {
+      op_htrans::apply_noalias(tmp_B, B);
+      }
+    
+    const Mat<eT>& AA = (do_trans_A == false) ? A : tmp_A;
+    const Mat<eT>& BB = (do_trans_B == false) ? B : tmp_B;
+    
+    const uword A_n_rows = AA.n_rows;
+    const uword A_n_cols = AA.n_cols;
+    
+    const uword B_n_rows = BB.n_rows;
+    const uword B_n_cols = BB.n_cols;
+    
+    if( (A_n_rows <= 4) && (A_n_rows == A_n_cols) && (A_n_rows == B_n_rows) && (B_n_rows == B_n_cols) )
+      {
+      gemm_emul_tinysq<false, use_alpha, use_beta>::apply(C, AA, BB, alpha, beta);
+      }
+    else
+      {
+      gemm_emul_large<false, false, use_alpha, use_beta>::apply(C, AA, BB, alpha, beta);
+      }
+    }
+
+  };
+
+
+
+//! \brief
+//! Wrapper for ATLAS/BLAS dgemm function, using template arguments to control the arguments passed to dgemm.
+//! Matrix 'C' is assumed to have been set to the correct size (i.e. taking into account transposes)
+
+template<const bool do_trans_A=false, const bool do_trans_B=false, const bool use_alpha=false, const bool use_beta=false>
+class gemm
+  {
+  public:
+  
+  template<typename eT>
+  inline
+  static
+  void
+  apply_blas_type( Mat<eT>& C, const Mat<eT>& A, const Mat<eT>& B, const eT alpha = eT(1), const eT beta = eT(0) )
+    {
+    arma_extra_debug_sigprint();
+    
+    if( (A.n_elem <= 48u) && (B.n_elem <= 48u) )
+      {
+      gemm_emul<do_trans_A, do_trans_B, use_alpha, use_beta>::apply(C,A,B,alpha,beta);
+      }
+    else
+      {
+      #if defined(ARMA_USE_ATLAS)
+        {
+        arma_extra_debug_print("atlas::cblas_gemm()");
+        
+        atlas::cblas_gemm<eT>
+          (
+          atlas::CblasColMajor,
+          (do_trans_A) ? ( is_complex<eT>::value ? CblasConjTrans : atlas::CblasTrans ) : atlas::CblasNoTrans,
+          (do_trans_B) ? ( is_complex<eT>::value ? CblasConjTrans : atlas::CblasTrans ) : atlas::CblasNoTrans,
+          C.n_rows,
+          C.n_cols,
+          (do_trans_A) ? A.n_rows : A.n_cols,
+          (use_alpha) ? alpha : eT(1),
+          A.mem,
+          (do_trans_A) ? A.n_rows : C.n_rows,
+          B.mem,
+          (do_trans_B) ? C.n_cols : ( (do_trans_A) ? A.n_rows : A.n_cols ),
+          (use_beta) ? beta : eT(0),
+          C.memptr(),
+          C.n_rows
+          );
+        }
+      #elif defined(ARMA_USE_BLAS)
+        {
+        arma_extra_debug_print("blas::gemm()");
+        
+        const char trans_A = (do_trans_A) ? ( is_complex<eT>::value ? 'C' : 'T' ) : 'N';
+        const char trans_B = (do_trans_B) ? ( is_complex<eT>::value ? 'C' : 'T' ) : 'N';
+        
+        const blas_int m   = C.n_rows;
+        const blas_int n   = C.n_cols;
+        const blas_int k   = (do_trans_A) ? A.n_rows : A.n_cols;
+        
+        const eT local_alpha = (use_alpha) ? alpha : eT(1);
+        
+        const blas_int lda = (do_trans_A) ? k : m;
+        const blas_int ldb = (do_trans_B) ? n : k;
+        
+        const eT local_beta  = (use_beta) ? beta : eT(0);
+        
+        arma_extra_debug_print( arma_boost::format("blas::gemm(): trans_A = %c") % trans_A );
+        arma_extra_debug_print( arma_boost::format("blas::gemm(): trans_B = %c") % trans_B );
+        
+        blas::gemm<eT>
+          (
+          &trans_A,
+          &trans_B,
+          &m,
+          &n,
+          &k,
+          &local_alpha,
+          A.mem,
+          &lda,
+          B.mem,
+          &ldb,
+          &local_beta,
+          C.memptr(),
+          &m
+          );
+        }
+      #else
+        {
+        gemm_emul<do_trans_A, do_trans_B, use_alpha, use_beta>::apply(C,A,B,alpha,beta);
+        }
+      #endif
+      }
+    }
+  
+  
+  
+  //! immediate multiplication of matrices A and B, storing the result in C
+  template<typename eT>
+  inline
+  static
+  void
+  apply( Mat<eT>& C, const Mat<eT>& A, const Mat<eT>& B, const eT alpha = eT(1), const eT beta = eT(0) )
+    {
+    gemm_emul<do_trans_A, do_trans_B, use_alpha, use_beta>::apply(C,A,B,alpha,beta);
+    }
+  
+  
+  
+  arma_inline
+  static
+  void
+  apply
+    (
+          Mat<float>& C,
+    const Mat<float>& A,
+    const Mat<float>& B,
+    const float alpha = float(1),
+    const float beta  = float(0)
+    )
+    {
+    gemm<do_trans_A, do_trans_B, use_alpha, use_beta>::apply_blas_type(C,A,B,alpha,beta);
+    }
+  
+  
+  
+  arma_inline
+  static
+  void
+  apply
+    (
+          Mat<double>& C,
+    const Mat<double>& A,
+    const Mat<double>& B,
+    const double alpha = double(1),
+    const double beta  = double(0)
+    )
+    {
+    gemm<do_trans_A, do_trans_B, use_alpha, use_beta>::apply_blas_type(C,A,B,alpha,beta);
+    }
+  
+  
+  
+  arma_inline
+  static
+  void
+  apply
+    (
+          Mat< std::complex<float> >& C,
+    const Mat< std::complex<float> >& A,
+    const Mat< std::complex<float> >& B,
+    const std::complex<float> alpha = std::complex<float>(1),
+    const std::complex<float> beta  = std::complex<float>(0)
+    )
+    {
+    gemm<do_trans_A, do_trans_B, use_alpha, use_beta>::apply_blas_type(C,A,B,alpha,beta);
+    }
+  
+  
+  
+  arma_inline
+  static
+  void
+  apply
+    (
+          Mat< std::complex<double> >& C,
+    const Mat< std::complex<double> >& A,
+    const Mat< std::complex<double> >& B,
+    const std::complex<double> alpha = std::complex<double>(1),
+    const std::complex<double> beta  = std::complex<double>(0)
+    )
+    {
+    gemm<do_trans_A, do_trans_B, use_alpha, use_beta>::apply_blas_type(C,A,B,alpha,beta);
+    }
+  
+  };
+
+
+
+//! @}