fn_chol.hpp

Go to the documentation of this file.
00001 // Copyright (C) 2009 NICTA
00002 // 
00003 // Authors:
00004 // - Conrad Sanderson (conradsand at ieee dot org)
00005 // 
00006 // This file is part of the Armadillo C++ library.
00007 // It is provided without any warranty of fitness
00008 // for any purpose. You can redistribute this file
00009 // and/or modify it under the terms of the GNU
00010 // Lesser General Public License (LGPL) as published
00011 // by the Free Software Foundation, either version 3
00012 // of the License or (at your option) any later version.
00013 // (see http://www.opensource.org/licenses for more info)
00014 
00015 
00016 //! \addtogroup fn_chol
00017 //! @{
00018 
00019 
00020 template<typename eT, typename T1>
00021 inline
00022 bool
00023 chol(Mat<eT>& out, const Base<eT,T1>& X)
00024   {
00025   arma_extra_debug_sigprint();
00026   
00027   const unwrap<T1> tmp(X.get_ref());
00028   arma_debug_check( !tmp.M.is_square(), "chol(): given matrix is not square");
00029   
00030   return auxlib::chol(out, tmp.M);
00031   }
00032 
00033 
00034 
00035 template<typename eT, typename T1>
00036 inline
00037 Mat<eT>
00038 chol(const Base<eT,T1>& X)
00039   {
00040   arma_extra_debug_sigprint();
00041   
00042   Mat<eT> out;
00043   
00044   const bool ok = chol(out, X);
00045   if(ok == false)
00046     {
00047     arma_print("chol(): matrix factorisation failed");
00048     }
00049   
00050   return out;
00051   }
00052 
00053 
00054 //! @}