GNU Octave  4.0.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
CmplxSVD.h
Go to the documentation of this file.
1 /*
2 
3 Copyright (C) 1994-2015 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_CmplxSVD_h)
24 #define octave_CmplxSVD_h 1
25 
26 #include <iosfwd>
27 
28 #include "dDiagMatrix.h"
29 #include "CMatrix.h"
30 #include "dbleSVD.h"
31 
32 class
33 OCTAVE_API
35 {
36 public:
37 
38  ComplexSVD (void)
39  : type_computed (), sigma (), left_sm (), right_sm ()
40  { }
41 
42  ComplexSVD (const ComplexMatrix& a, SVD::type svd_type = SVD::std,
43  SVD::driver svd_driver = SVD::GESVD)
44  : type_computed (), sigma (), left_sm (), right_sm ()
45  {
46  init (a, svd_type, svd_driver);
47  }
48 
50  SVD::type svd_type = SVD::std,
51  SVD::driver svd_driver = SVD::GESVD)
52  : type_computed (), sigma (), left_sm (), right_sm ()
53  {
54  info = init (a, svd_type, svd_driver);
55  }
56 
58  : type_computed (a.type_computed), sigma (a.sigma),
59  left_sm (a.left_sm), right_sm (a.right_sm)
60  { }
61 
62  ComplexSVD& operator = (const ComplexSVD& a)
63  {
64  if (this != &a)
65  {
66  type_computed = a.type_computed;
67  sigma = a.sigma;
68  left_sm = a.left_sm;
69  right_sm = a.right_sm;
70  }
71  return *this;
72  }
73 
74  ~ComplexSVD (void) { }
75 
76  DiagMatrix singular_values (void) const { return sigma; }
77 
78  ComplexMatrix left_singular_matrix (void) const;
79 
80  ComplexMatrix right_singular_matrix (void) const;
81 
82  friend std::ostream& operator << (std::ostream& os, const ComplexSVD& a);
83 
84 private:
85 
87 
91 
92  octave_idx_type init (const ComplexMatrix& a,
93  SVD::type svd_type = SVD::std,
94  SVD::driver svd_driver = SVD::GESVD);
95 };
96 
97 #endif
ComplexSVD(const ComplexMatrix &a, octave_idx_type &info, SVD::type svd_type=SVD::std, SVD::driver svd_driver=SVD::GESVD)
Definition: CmplxSVD.h:49
ComplexMatrix left_sm
Definition: CmplxSVD.h:89
DiagMatrix sigma
Definition: CmplxSVD.h:88
SVD::type type_computed
Definition: CmplxSVD.h:86
ComplexSVD(const ComplexMatrix &a, SVD::type svd_type=SVD::std, SVD::driver svd_driver=SVD::GESVD)
Definition: CmplxSVD.h:42
~ComplexSVD(void)
Definition: CmplxSVD.h:74
ComplexSVD(const ComplexSVD &a)
Definition: CmplxSVD.h:57
ComplexSVD(void)
Definition: CmplxSVD.h:38
DiagMatrix singular_values(void) const
Definition: CmplxSVD.h:76
template OCTAVE_API std::ostream & operator<<(std::ostream &, const Array< bool > &)
ComplexMatrix right_sm
Definition: CmplxSVD.h:90
driver
Definition: dbleSVD.h:44
type
Definition: dbleSVD.h:37