max@0: // Copyright (C) 2009-2011 NICTA (www.nicta.com.au)
max@0: // Copyright (C) 2009-2011 Conrad Sanderson
max@0: // 
max@0: // This file is part of the Armadillo C++ library.
max@0: // It is provided without any warranty of fitness
max@0: // for any purpose. You can redistribute this file
max@0: // and/or modify it under the terms of the GNU
max@0: // Lesser General Public License (LGPL) as published
max@0: // by the Free Software Foundation, either version 3
max@0: // of the License or (at your option) any later version.
max@0: // (see http://www.opensource.org/licenses for more info)
max@0: 
max@0: 
max@0: //! \addtogroup fn_svd
max@0: //! @{
max@0: 
max@0: 
max@0: 
max@0: template<typename T1>
max@0: inline
max@0: bool
max@0: svd
max@0:   (
max@0:          Col<typename T1::pod_type>&     S,
max@0:   const Base<typename T1::elem_type,T1>& X,
max@0:   const typename arma_blas_type_only<typename T1::elem_type>::result* junk = 0
max@0:   )
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   arma_ignore(junk);
max@0:   
max@0:   // it doesn't matter if X is an alias of S, as auxlib::svd() makes a copy of X
max@0:   
max@0:   const bool status = auxlib::svd(S, X);
max@0:   
max@0:   if(status == false)
max@0:     {
max@0:     S.reset();
max@0:     arma_bad("svd(): failed to converge", false);
max@0:     }
max@0:   
max@0:   return status;
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: template<typename T1>
max@0: inline
max@0: Col<typename T1::pod_type>
max@0: svd
max@0:   (
max@0:   const Base<typename T1::elem_type,T1>& X,
max@0:   const typename arma_blas_type_only<typename T1::elem_type>::result* junk = 0
max@0:   )
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   arma_ignore(junk);
max@0:   
max@0:   Col<typename T1::pod_type> out;
max@0:   
max@0:   const bool status = auxlib::svd(out, X);
max@0:   
max@0:   if(status == false)
max@0:     {
max@0:     out.reset();
max@0:     arma_bad("svd(): failed to converge");
max@0:     }
max@0:   
max@0:   return out;
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: template<typename T1>
max@0: inline
max@0: bool
max@0: svd
max@0:   (
max@0:          Mat<typename T1::elem_type>&    U,
max@0:          Col<typename T1::pod_type >&    S,
max@0:          Mat<typename T1::elem_type>&    V,
max@0:   const Base<typename T1::elem_type,T1>& X,
max@0:   const typename arma_blas_type_only<typename T1::elem_type>::result* junk = 0
max@0:   )
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   arma_ignore(junk);
max@0:   
max@0:   typedef typename T1::elem_type eT;
max@0:   
max@0:   arma_debug_check
max@0:     (
max@0:     ( ((void*)(&U) == (void*)(&S)) || (&U == &V) || ((void*)(&S) == (void*)(&V)) ),
max@0:     "svd(): two or more output objects are the same object"
max@0:     );
max@0:   
max@0:   // auxlib::svd() makes an internal copy of X
max@0:   const bool status = auxlib::svd(U, S, V, X);
max@0:   
max@0:   if(status == false)
max@0:     {
max@0:     U.reset();
max@0:     S.reset();
max@0:     V.reset();
max@0:     arma_bad("svd(): failed to converge", false);
max@0:     }
max@0:   
max@0:   return status;
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: template<typename T1>
max@0: inline
max@0: bool
max@0: svd_econ
max@0:   (
max@0:          Mat<typename T1::elem_type>&    U,
max@0:          Col<typename T1::pod_type >&    S,
max@0:          Mat<typename T1::elem_type>&    V,
max@0:   const Base<typename T1::elem_type,T1>& X,
max@0:   const char                             mode = 'b',
max@0:   const typename arma_blas_type_only<typename T1::elem_type>::result* junk = 0
max@0:   )
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   arma_ignore(junk);
max@0:   
max@0:   typedef typename T1::elem_type eT;
max@0:   
max@0:   arma_debug_check
max@0:     (
max@0:     ( ((void*)(&U) == (void*)(&S)) || (&U == &V) || ((void*)(&S) == (void*)(&V)) ),
max@0:     "svd_econ(): two or more output objects are the same object"
max@0:     );
max@0:   
max@0:   arma_debug_check
max@0:     (
max@0:     ( (mode != 'l') && (mode != 'r') && (mode != 'b') ),
max@0:     "svd_econ(): parameter 'mode' is incorrect"
max@0:     );
max@0:   
max@0:   
max@0:   // auxlib::svd_econ() makes an internal copy of X
max@0:   const bool status = auxlib::svd_econ(U, S, V, X, mode);
max@0:   
max@0:   if(status == false)
max@0:     {
max@0:     U.reset();
max@0:     S.reset();
max@0:     V.reset();
max@0:     arma_bad("svd_econ(): failed to converge", false);
max@0:     }
max@0:   
max@0:   return status;
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: template<typename T1>
max@0: arma_deprecated
max@0: inline
max@0: bool
max@0: svd_thin
max@0:   (
max@0:          Mat<typename T1::elem_type>&    U,
max@0:          Col<typename T1::pod_type >&    S,
max@0:          Mat<typename T1::elem_type>&    V,
max@0:   const Base<typename T1::elem_type,T1>& X,
max@0:   const char                             mode = 'b',
max@0:   const typename arma_blas_type_only<typename T1::elem_type>::result* junk = 0
max@0:   )
max@0:   {
max@0:   arma_ignore(junk);
max@0:   
max@0:   return svd_econ(U,S,V,X,mode);
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: //! @}