A.I.M.S algorithms


svd.h
Go to the documentation of this file.
1 /* This software and supporting documentation are distributed by
2  * Institut Federatif de Recherche 49
3  * CEA/NeuroSpin, Batiment 145,
4  * 91191 Gif-sur-Yvette cedex
5  * France
6  *
7  * This software is governed by the CeCILL-B license under
8  * French law and abiding by the rules of distribution of free software.
9  * You can use, modify and/or redistribute the software under the
10  * terms of the CeCILL-B license as circulated by CEA, CNRS
11  * and INRIA at the following URL "http://www.cecill.info".
12  *
13  * As a counterpart to the access to the source code and rights to copy,
14  * modify and redistribute granted by the license, users are provided only
15  * with a limited warranty and the software's author, the holder of the
16  * economic rights, and the successive licensors have only limited
17  * liability.
18  *
19  * In this respect, the user's attention is drawn to the risks associated
20  * with loading, using, modifying and/or developing or reproducing the
21  * software by the user in light of its specific status of free software,
22  * that may mean that it is complicated to manipulate, and that also
23  * therefore means that it is reserved for developers and experienced
24  * professionals having in-depth computer knowledge. Users are therefore
25  * encouraged to load and test the software's suitability as regards their
26  * requirements in conditions enabling the security of their systems and/or
27  * data to be ensured and, more generally, to use and operate it in the
28  * same conditions as regards security.
29  *
30  * The fact that you are presently reading this means that you have had
31  * knowledge of the CeCILL-B license and that you accept its terms.
32  */
33 
34 
35 #ifndef AIMS_MATH_SVD_H
36 #define AIMS_MATH_SVD_H
37 
38 #include <aims/def/general.h>
39 
40 template <class T> class AimsData;
41 
54 template< class T >
55 class AimsSVD
56 {
57 public:
58 
60  {
63  };
64 
67  AimsSVD( SVDReturnType rt=MatrixOfSingularValues ) : retType( rt ) { }
70  virtual ~AimsSVD() { }
72 
73  void setReturnType( SVDReturnType rt ) { retType = rt; }
74 
85 
87  void sort( AimsData< T >&, AimsData< T >&, AimsData< T > *v = NULL );
88 
90  const AimsData< T >& W,
91  const AimsData< T >& V,
92  const AimsData< T >& S );
93 
94 private:
95 
96  SVDReturnType retType;
97 };
98 
99 #endif
void sort(AimsData< T > &, AimsData< T > &, AimsData< T > *v=NULL)
sort the U and V matrices and the W vector in decreasing order
virtual ~AimsSVD()
destructor
Definition: svd.h:70
AimsData< T > doit(AimsData< T > &, AimsData< T > *v=NULL)
Singular Value Decomposition.
void setReturnType(SVDReturnType rt)
Definition: svd.h:73
SVDReturnType
Definition: svd.h:59
AimsSVD(SVDReturnType rt=MatrixOfSingularValues)
Constructor and destructor.
Definition: svd.h:68
AimsData< T > backwardSubstitution(const AimsData< T > &U, const AimsData< T > &W, const AimsData< T > &V, const AimsData< T > &S)
Definition: svd.h:55