Chris@49: // Copyright (C) 2008-2011 NICTA (www.nicta.com.au)
Chris@49: // Copyright (C) 2008-2011 Conrad Sanderson
Chris@49: // 
Chris@49: // This Source Code Form is subject to the terms of the Mozilla Public
Chris@49: // License, v. 2.0. If a copy of the MPL was not distributed with this
Chris@49: // file, You can obtain one at http://mozilla.org/MPL/2.0/.
Chris@49: 
Chris@49: 
Chris@49: //! \addtogroup fn_inv
Chris@49: //! @{
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: //! delayed matrix inverse (general matrices)
Chris@49: template<typename T1>
Chris@49: arma_inline
Chris@49: const Op<T1, op_inv>
Chris@49: inv
Chris@49:   (
Chris@49:   const Base<typename T1::elem_type,T1>& X,
Chris@49:   const bool slow = false,
Chris@49:   const typename arma_blas_type_only<typename T1::elem_type>::result* junk = 0
Chris@49:   )
Chris@49:   {
Chris@49:   arma_extra_debug_sigprint();
Chris@49:   arma_ignore(junk);
Chris@49:   
Chris@49:   return Op<T1, op_inv>(X.get_ref(), ((slow == false) ? 0 : 1), 0);
Chris@49:   }
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: //! remove the inverse operation if applied twice consecutively
Chris@49: template<typename T1>
Chris@49: arma_inline
Chris@49: const T1&
Chris@49: inv(const Op<T1, op_inv>& X, const bool slow = false)
Chris@49:   {
Chris@49:   arma_extra_debug_sigprint();
Chris@49:   arma_ignore(slow);
Chris@49:   
Chris@49:   return X.m;
Chris@49:   }
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: //! delayed matrix inverse (triangular matrices)
Chris@49: template<typename T1>
Chris@49: arma_inline
Chris@49: const Op<T1, op_inv_tr>
Chris@49: inv
Chris@49:   (
Chris@49:   const Op<T1, op_trimat>& X,
Chris@49:   const bool slow = false,
Chris@49:   const typename arma_blas_type_only<typename T1::elem_type>::result* junk = 0
Chris@49:   )
Chris@49:   {
Chris@49:   arma_extra_debug_sigprint();
Chris@49:   arma_ignore(slow);
Chris@49:   arma_ignore(junk);
Chris@49:   
Chris@49:   return Op<T1, op_inv_tr>(X.m, X.aux_uword_a, 0);
Chris@49:   }
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: //! delayed matrix inverse (symmetric positive definite matrices)
Chris@49: template<typename T1>
Chris@49: arma_inline
Chris@49: const Op<T1, op_inv_sympd>
Chris@49: inv
Chris@49:   (
Chris@49:   const Op<T1, op_sympd>& X,
Chris@49:   const bool slow = false,
Chris@49:   const typename arma_blas_type_only<typename T1::elem_type>::result* junk = 0
Chris@49:   )
Chris@49:   {
Chris@49:   arma_extra_debug_sigprint();
Chris@49:   arma_ignore(slow);
Chris@49:   arma_ignore(junk);
Chris@49:   
Chris@49:   return Op<T1, op_inv_sympd>(X.m, 0, 0);
Chris@49:   }
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: template<typename T1>
Chris@49: inline
Chris@49: bool
Chris@49: inv
Chris@49:   (
Chris@49:          Mat<typename T1::elem_type>&    out,
Chris@49:   const Base<typename T1::elem_type,T1>& X,
Chris@49:   const bool slow = false,
Chris@49:   const typename arma_blas_type_only<typename T1::elem_type>::result* junk = 0
Chris@49:   )
Chris@49:   {
Chris@49:   arma_extra_debug_sigprint();
Chris@49:   arma_ignore(junk);
Chris@49:   
Chris@49:   try
Chris@49:     {
Chris@49:     out = inv(X,slow);
Chris@49:     }
Chris@49:   catch(std::runtime_error&)
Chris@49:     {
Chris@49:     return false;
Chris@49:     }
Chris@49:   
Chris@49:   return true;
Chris@49:   }
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: //! @}