fn_cov.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 // - Dimitrios Bouzas (dimitris dot mpouzas at gmail dot com)
00007 // 
00008 // This file is part of the Armadillo C++ library.
00009 // It is provided without any warranty of fitness
00010 // for any purpose. You can redistribute this file
00011 // and/or modify it under the terms of the GNU
00012 // Lesser General Public License (LGPL) as published
00013 // by the Free Software Foundation, either version 3
00014 // of the License or (at your option) any later version.
00015 // (see http://www.opensource.org/licenses for more info)
00016 
00017 
00018 //! \addtogroup fn_cov
00019 //! @{
00020 
00021 
00022 
00023 template<typename T1>
00024 inline
00025 const Op<T1, op_cov>
00026 cov(const Base<typename T1::elem_type,T1>& X, const u32 norm_type = 0)
00027   {
00028   arma_extra_debug_sigprint();
00029   
00030   arma_debug_check( (norm_type > 1), "cov(): norm_type must be 0 or 1");
00031 
00032   return Op<T1, op_cov>(X.get_ref(), norm_type, 0);
00033   }
00034 
00035 
00036 
00037 template<typename T1, typename T2>
00038 inline
00039 const Glue<T1,T2,glue_cov>
00040 cov(const Base<typename T1::elem_type,T1>& A, const Base<typename T1::elem_type,T2>& B, const u32 norm_type = 0)
00041   {
00042   arma_extra_debug_sigprint();
00043   
00044   arma_debug_check( (norm_type > 1), "cov(): norm_type must be 0 or 1");
00045   
00046   return Glue<T1, T2, glue_cov>(A.get_ref(), B.get_ref(), norm_type);
00047   }
00048 
00049 
00050 
00051 //! @}