GNU Octave  3.8.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
fCmplxSVD.h
Go to the documentation of this file.
1 /*
2 
3 Copyright (C) 1994-2013 John W. Eaton
4 
5 This file is part of Octave.
6 
7 Octave is free software; you can redistribute it and/or modify it
8 under the terms of the GNU General Public License as published by the
9 Free Software Foundation; either version 3 of the License, or (at your
10 option) any later version.
11 
12 Octave is distributed in the hope that it will be useful, but WITHOUT
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 for more details.
16 
17 You should have received a copy of the GNU General Public License
18 along with Octave; see the file COPYING. If not, see
19 <http://www.gnu.org/licenses/>.
20 
21 */
22 
23 #if !defined (octave_fCmplxSVD_h)
24 #define octave_fCmplxSVD_h 1
25 
26 #include <iosfwd>
27 
28 #include "fDiagMatrix.h"
29 #include "fCMatrix.h"
30 #include "dbleSVD.h"
31 
32 class
33 OCTAVE_API
35 {
36 public:
37 
39  : type_computed (), sigma (), left_sm (), right_sm ()
40  { }
41 
43  SVD::type svd_type = SVD::std,
44  SVD::driver svd_driver = SVD::GESVD)
45  : type_computed (), sigma (), left_sm (), right_sm ()
46  {
47  init (a, svd_type, svd_driver);
48  }
49 
51  SVD::type svd_type = SVD::std,
52  SVD::driver svd_driver = SVD::GESVD)
53  : type_computed (), sigma (), left_sm (), right_sm ()
54  {
55  info = init (a, svd_type, svd_driver);
56  }
57 
59  : type_computed (a.type_computed), sigma (a.sigma),
60  left_sm (a.left_sm), right_sm (a.right_sm)
61  { }
62 
64  {
65  if (this != &a)
66  {
67  type_computed = a.type_computed;
68  sigma = a.sigma;
69  left_sm = a.left_sm;
70  right_sm = a.right_sm;
71  }
72  return *this;
73  }
74 
75  ~FloatComplexSVD (void) { }
76 
77  FloatDiagMatrix singular_values (void) const { return sigma; }
78 
79  FloatComplexMatrix left_singular_matrix (void) const;
80 
81  FloatComplexMatrix right_singular_matrix (void) const;
82 
83  friend std::ostream& operator << (std::ostream& os,
84  const FloatComplexSVD& a);
85 
86 private:
87 
89 
93 
94  octave_idx_type init (const FloatComplexMatrix& a,
95  SVD::type svd_type = SVD::std,
96  SVD::driver svd_driver = SVD::GESVD);
97 };
98 
99 #endif