svd.h
Go to the documentation of this file.
1 /*!
2  *
3  *
4  * \brief Algorithm for Singular Value Decomposition
5  *
6  *
7  *
8  *
9  * \author O. Krause
10  * \date 2011
11  *
12  *
13  * \par Copyright 1995-2015 Shark Development Team
14  *
15  * <BR><HR>
16  * This file is part of Shark.
17  * <http://image.diku.dk/shark/>
18  *
19  * Shark is free software: you can redistribute it and/or modify
20  * it under the terms of the GNU Lesser General Public License as published
21  * by the Free Software Foundation, either version 3 of the License, or
22  * (at your option) any later version.
23  *
24  * Shark is distributed in the hope that it will be useful,
25  * but WITHOUT ANY WARRANTY; without even the implied warranty of
26  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27  * GNU Lesser General Public License for more details.
28  *
29  * You should have received a copy of the GNU Lesser General Public License
30  * along with Shark. If not, see <http://www.gnu.org/licenses/>.
31  *
32  */
33 #ifndef SHARK_LINALG_SVD_H
34 #define SHARK_LINALG_SVD_H
35 
36 #include <shark/LinAlg/Base.h>
37 
38 namespace shark{ namespace blas{
39 
40 /**
41  * \ingroup shark_globals
42  *
43  * @{
44  */
45 
46 
47 //! \par
48 //! Determines the singular value decomposition of a rectangular
49 //! matrix "amatA".
50 //!
51 template<class MatrixT,class MatrixU,class VectorT>
52 void svd
53 (
54  const MatrixT& amatA,
55  MatrixU& umatA,
56  MatrixU& vmatA,
57  VectorT& wvecA,
58  unsigned maxIterations = 200,
59  bool ignoreThreshold = true
60 );
61 
62 
63 /** @}*/
64 }}
65 
66 #include "Impl/svd.inl"
67 #endif