comparison armadillo-2.4.4/include/armadillo_bits/fn_lu.hpp @ 0:8b6102e2a9b0

Armadillo Library

+// Copyright (C) 2008-2011 NICTA (www.nicta.com.au)
+// Copyright (C) 2008-2011 Conrad Sanderson
+// 
+// This file is part of the Armadillo C++ library.
+// It is provided without any warranty of fitness
+// for any purpose. You can redistribute this file
+// and/or modify it under the terms of the GNU
+// Lesser General Public License (LGPL) as published
+// by the Free Software Foundation, either version 3
+// of the License or (at your option) any later version.
+// (see http://www.opensource.org/licenses for more info)
+
+
+//! \addtogroup fn_lu
+//! @{
+
+
+
+//! immediate lower upper decomposition, permutation info is embedded into L (similar to Matlab/Octave)
+template<typename T1>
+inline
+bool
+lu
+  (
+         Mat<typename T1::elem_type>&    L,
+         Mat<typename T1::elem_type>&    U,
+  const Base<typename T1::elem_type,T1>& X,
+  const typename arma_blas_type_only<typename T1::elem_type>::result* junk = 0
+  )
+  {
+  arma_extra_debug_sigprint();
+  arma_ignore(junk);
+  
+  arma_debug_check( (&L == &U), "lu(): L and U are the same object");
+  
+  const bool status = auxlib::lu(L, U, X);
+  
+  if(status == false)
+    {
+    L.reset();
+    U.reset();
+    arma_bad("lu(): failed to converge", false);
+    }
+  
+  return status;
+  }
+
+
+
+//! immediate lower upper decomposition, also providing the permutation matrix
+template<typename T1>
+inline
+bool
+lu
+  (
+         Mat<typename T1::elem_type>&    L,
+         Mat<typename T1::elem_type>&    U, 
+         Mat<typename T1::elem_type>&    P,
+  const Base<typename T1::elem_type,T1>& X,
+  const typename arma_blas_type_only<typename T1::elem_type>::result* junk = 0
+  )
+  {
+  arma_extra_debug_sigprint();
+  arma_ignore(junk);
+  
+  arma_debug_check( ( (&L == &U) || (&L == &P) || (&U == &P) ), "lu(): two or more output objects are the same object");
+  
+  const bool status = auxlib::lu(L, U, P, X);
+  
+  if(status == false)
+    {
+    L.reset();
+    U.reset();
+    P.reset();
+    arma_bad("lu(): failed to converge", false);
+    }
+  
+  return status;
+  }
+
+
+
+//! @}