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 25 of file fn_chol.hpp.

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

Referenced by chol().

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

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

Definition at line 44 of file fn_chol.hpp.

References arma_print(), and chol().

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