op_dot_proto.hpp

Go to the documentation of this file.
00001 // Copyright (C) 2010 NICTA and the authors listed below
00002 // http://nicta.com.au
00003 // 
00004 // Authors:
00005 // - Conrad Sanderson (conradsand at ieee dot org)
00006 // 
00007 // This file is part of the Armadillo C++ library.
00008 // It is provided without any warranty of fitness
00009 // for any purpose. You can redistribute this file
00010 // and/or modify it under the terms of the GNU
00011 // Lesser General Public License (LGPL) as published
00012 // by the Free Software Foundation, either version 3
00013 // of the License or (at your option) any later version.
00014 // (see http://www.opensource.org/licenses for more info)
00015 
00016 
00017 //! \addtogroup op_dot
00018 //! @{
00019 
00020 //! \brief
00021 //! dot product operation 
00022 
00023 class op_dot
00024   {
00025   public:
00026   
00027   template<typename eT>
00028   arma_hot arma_pure inline static eT direct_dot_arma(const u32 n_elem, const eT* const A, const eT* const B);
00029   
00030   template<typename eT>
00031   arma_hot arma_pure inline static typename arma_float_only<eT>::result
00032   direct_dot(const u32 n_elem, const eT* const A, const eT* const B);
00033   
00034   template<typename eT>
00035   arma_hot arma_pure inline static typename arma_cx_only<eT>::result
00036   direct_dot(const u32 n_elem, const eT* const A, const eT* const B);
00037   
00038   template<typename eT>
00039   arma_hot arma_pure inline static typename arma_integral_only<eT>::result
00040   direct_dot(const u32 n_elem, const eT* const A, const eT* const B);
00041   
00042   
00043   template<typename eT>
00044   arma_hot arma_pure inline static eT direct_dot(const u32 n_elem, const eT* const A, const eT* const B, const eT* C);
00045   
00046   template<typename T1, typename T2>
00047   arma_hot arma_inline static typename T1::elem_type apply(const Base<typename T1::elem_type,T1>& X, const Base<typename T1::elem_type,T2>& Y);
00048   
00049   template<typename T1, typename T2>
00050   arma_hot inline static typename T1::elem_type apply_unwrap(const Base<typename T1::elem_type,T1>& X, const Base<typename T1::elem_type,T2>& Y);
00051   
00052   template<typename T1, typename T2>
00053   arma_hot inline static typename T1::elem_type apply_proxy (const Base<typename T1::elem_type,T1>& X, const Base<typename T1::elem_type,T2>& Y);
00054   };
00055 
00056 
00057 
00058 //! \brief
00059 //! normalised dot product operation 
00060 
00061 class op_norm_dot
00062   {
00063   public:
00064   
00065   template<typename T1, typename T2>
00066   arma_hot arma_inline static typename T1::elem_type apply(const Base<typename T1::elem_type,T1>& X, const Base<typename T1::elem_type,T2>& Y);
00067   
00068   template<typename T1, typename T2>
00069   arma_hot inline static typename T1::elem_type apply_unwrap(const Base<typename T1::elem_type,T1>& X, const Base<typename T1::elem_type,T2>& Y);
00070   
00071   template<typename T1, typename T2>
00072   arma_hot inline static typename T1::elem_type apply_proxy (const Base<typename T1::elem_type,T1>& X, const Base<typename T1::elem_type,T2>& Y);
00073   };
00074 
00075 
00076 
00077 //! @}