Fn_chol

Functions

template<typename T1 >
bool chol (Mat< typename T1::elem_type > &out, const Base< typename T1::elem_type, T1 > &X)
template<typename T1 >
Mat< typename T1::elem_type > chol (const Base< typename T1::elem_type, T1 > &X)

Function Documentation

template<typename T1 >
bool chol ( Mat< typename T1::elem_type > &  out,
const Base< typename T1::elem_type, T1 > &  X 
) [inline]

Definition at line 24 of file fn_chol.hpp.

References auxlib::chol(), and Base< elem_type, derived >::get_ref().

Referenced by chol().

00025   {
00026   arma_extra_debug_sigprint();
00027   
00028   typedef typename T1::elem_type eT;
00029   
00030   const unwrap_check<T1> tmp(X.get_ref(), out);
00031   const Mat<eT>&     A = tmp.M;
00032   
00033   arma_debug_check( (A.is_square() == false), "chol(): given matrix is not square");
00034   
00035   return auxlib::chol(out, A);
00036   }

template<typename T1 >
Mat<typename T1::elem_type> chol ( const Base< typename T1::elem_type, T1 > &  X  )  [inline]

Definition at line 43 of file fn_chol.hpp.

References arma_print(), and chol().

00044   {
00045   arma_extra_debug_sigprint();
00046   
00047   typedef typename T1::elem_type eT;
00048   
00049   Mat<eT> out;
00050   
00051   const bool ok = chol(out, X);
00052   
00053   if(ok == false)
00054     {
00055     arma_print("chol(): matrix factorisation failed");
00056     }
00057   
00058   return out;
00059   }