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
fCmplxSVD.cc
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 #ifdef HAVE_CONFIG_H
24 #include <config.h>
25 #endif
26 
27 #include "fCmplxSVD.h"
28 #include "f77-fcn.h"
29 #include "lo-error.h"
30 #include "oct-locbuf.h"
31 
32 extern "C"
33 {
34  F77_RET_T
35  F77_FUNC (cgesvd, CGESVD) (F77_CONST_CHAR_ARG_DECL,
37  const octave_idx_type&, const octave_idx_type&,
38  FloatComplex*, const octave_idx_type&, float*,
39  FloatComplex*, const octave_idx_type&,
40  FloatComplex*, const octave_idx_type&,
41  FloatComplex*, const octave_idx_type&,
42  float*, octave_idx_type&
45 
46  F77_RET_T
47  F77_FUNC (cgesdd, CGESDD) (F77_CONST_CHAR_ARG_DECL,
48  const octave_idx_type&, const octave_idx_type&,
49  FloatComplex*, const octave_idx_type&, float*,
50  FloatComplex*, const octave_idx_type&,
51  FloatComplex*, const octave_idx_type&,
52  FloatComplex*, const octave_idx_type&,
53  float*, octave_idx_type *, octave_idx_type&
55 }
56 
59 {
61  {
62  (*current_liboctave_error_handler)
63  ("FloatComplexSVD: U not computed because type == SVD::sigma_only");
64  return FloatComplexMatrix ();
65  }
66  else
67  return left_sm;
68 }
69 
72 {
74  {
75  (*current_liboctave_error_handler)
76  ("FloatComplexSVD: V not computed because type == SVD::sigma_only");
77  return FloatComplexMatrix ();
78  }
79  else
80  return right_sm;
81 }
82 
85  SVD::driver svd_driver)
86 {
87  octave_idx_type info;
88 
89  octave_idx_type m = a.rows ();
90  octave_idx_type n = a.cols ();
91 
92  FloatComplexMatrix atmp = a;
93  FloatComplex *tmp_data = atmp.fortran_vec ();
94 
95  octave_idx_type min_mn = m < n ? m : n;
96  octave_idx_type max_mn = m > n ? m : n;
97 
98  char jobu = 'A';
99  char jobv = 'A';
100 
101  octave_idx_type ncol_u = m;
102  octave_idx_type nrow_vt = n;
103  octave_idx_type nrow_s = m;
104  octave_idx_type ncol_s = n;
105 
106  switch (svd_type)
107  {
108  case SVD::economy:
109  jobu = jobv = 'S';
110  ncol_u = nrow_vt = nrow_s = ncol_s = min_mn;
111  break;
112 
113  case SVD::sigma_only:
114 
115  // Note: for this case, both jobu and jobv should be 'N', but
116  // there seems to be a bug in dgesvd from Lapack V2.0. To
117  // demonstrate the bug, set both jobu and jobv to 'N' and find
118  // the singular values of [eye(3), eye(3)]. The result is
119  // [-sqrt(2), -sqrt(2), -sqrt(2)].
120  //
121  // For Lapack 3.0, this problem seems to be fixed.
122 
123  jobu = jobv = 'N';
124  ncol_u = nrow_vt = 1;
125  break;
126 
127  default:
128  break;
129  }
130 
131  type_computed = svd_type;
132 
133  if (! (jobu == 'N' || jobu == 'O'))
134  left_sm.resize (m, ncol_u);
135 
137 
138  sigma.resize (nrow_s, ncol_s);
139  float *s_vec = sigma.fortran_vec ();
140 
141  if (! (jobv == 'N' || jobv == 'O'))
142  right_sm.resize (nrow_vt, n);
143 
145 
146  // Query CGESVD for the correct dimension of WORK.
147 
148  octave_idx_type lwork = -1;
149 
150  Array<FloatComplex> work (dim_vector (1, 1));
151 
152  octave_idx_type one = 1;
153  octave_idx_type m1 = std::max (m, one);
154  octave_idx_type nrow_vt1 = std::max (nrow_vt, one);
155 
156  if (svd_driver == SVD::GESVD)
157  {
158  octave_idx_type lrwork = 5*max_mn;
159  Array<float> rwork (dim_vector (lrwork, 1));
160 
161  F77_XFCN (cgesvd, CGESVD, (F77_CONST_CHAR_ARG2 (&jobu, 1),
162  F77_CONST_CHAR_ARG2 (&jobv, 1),
163  m, n, tmp_data, m1, s_vec, u, m1, vt,
164  nrow_vt1, work.fortran_vec (), lwork,
165  rwork.fortran_vec (), info
166  F77_CHAR_ARG_LEN (1)
167  F77_CHAR_ARG_LEN (1)));
168 
169  lwork = static_cast<octave_idx_type> (work(0).real ());
170  work.resize (dim_vector (lwork, 1));
171 
172  F77_XFCN (cgesvd, CGESVD, (F77_CONST_CHAR_ARG2 (&jobu, 1),
173  F77_CONST_CHAR_ARG2 (&jobv, 1),
174  m, n, tmp_data, m1, s_vec, u, m1, vt,
175  nrow_vt1, work.fortran_vec (), lwork,
176  rwork.fortran_vec (), info
177  F77_CHAR_ARG_LEN (1)
178  F77_CHAR_ARG_LEN (1)));
179  }
180  else if (svd_driver == SVD::GESDD)
181  {
182  assert (jobu == jobv);
183  char jobz = jobu;
184 
185  octave_idx_type lrwork;
186  if (jobz == 'N')
187  lrwork = 5*min_mn;
188  else
189  lrwork = min_mn * std::max (5*min_mn+7, 2*max_mn+2*min_mn+1);
190  Array<float> rwork (dim_vector (lrwork, 1));
191 
192  OCTAVE_LOCAL_BUFFER (octave_idx_type, iwork, 8*min_mn);
193 
194  F77_XFCN (cgesdd, CGESDD, (F77_CONST_CHAR_ARG2 (&jobz, 1),
195  m, n, tmp_data, m1, s_vec, u, m1, vt,
196  nrow_vt1, work.fortran_vec (), lwork,
197  rwork.fortran_vec (), iwork, info
198  F77_CHAR_ARG_LEN (1)));
199 
200  lwork = static_cast<octave_idx_type> (work(0).real ());
201  work.resize (dim_vector (lwork, 1));
202 
203  F77_XFCN (cgesdd, CGESDD, (F77_CONST_CHAR_ARG2 (&jobz, 1),
204  m, n, tmp_data, m1, s_vec, u, m1, vt,
205  nrow_vt1, work.fortran_vec (), lwork,
206  rwork.fortran_vec (), iwork, info
207  F77_CHAR_ARG_LEN (1)));
208  }
209  else
210  assert (0); // impossible
211 
212  if (! (jobv == 'N' || jobv == 'O'))
214 
215  return info;
216 }
void resize(octave_idx_type n, octave_idx_type m, const T &rfv)
Definition: DiagArray2.cc:93
void resize(octave_idx_type nr, octave_idx_type nc, const FloatComplex &rfv=FloatComplex(0))
Definition: fCMatrix.h:175
#define F77_CHAR_ARG_LEN(l)
Definition: f77-fcn.h:253
const T * fortran_vec(void) const
Definition: DiagArray2.h:182
octave_idx_type init(const FloatComplexMatrix &a, SVD::type svd_type=SVD::std, SVD::driver svd_driver=SVD::GESVD)
Definition: fCmplxSVD.cc:84
FloatComplexMatrix right_sm
Definition: fCmplxSVD.h:92
FloatComplexMatrix hermitian(void) const
Definition: fCMatrix.h:154
FloatComplexMatrix left_singular_matrix(void) const
Definition: fCmplxSVD.cc:58
F77_RET_T const octave_idx_type const octave_idx_type FloatComplex const octave_idx_type float FloatComplex const octave_idx_type FloatComplex const octave_idx_type FloatComplex const octave_idx_type float octave_idx_type &F77_CHAR_ARG_LEN_DECL F77_CHAR_ARG_LEN_DECL
Definition: fCmplxSVD.cc:36
FloatComplexMatrix right_singular_matrix(void) const
Definition: fCmplxSVD.cc:71
SVD::type type_computed
Definition: fCmplxSVD.h:88
#define F77_XFCN(f, F, args)
Definition: f77-fcn.h:51
octave_idx_type rows(void) const
Definition: Array.h:313
#define F77_CONST_CHAR_ARG2(x, l)
Definition: f77-fcn.h:251
void resize(const dim_vector &dv, const T &rfv)
Definition: Array.cc:1033
#define F77_RET_T
Definition: f77-fcn.h:264
F77_RET_T F77_CONST_CHAR_ARG_DECL
Definition: fCmplxSVD.cc:36
F77_RET_T F77_FUNC(cgesvd, CGESVD)(F77_CONST_CHAR_ARG_DECL
charNDArray max(char d, const charNDArray &m)
Definition: chNDArray.cc:233
FloatComplexMatrix left_sm
Definition: fCmplxSVD.h:91
#define OCTAVE_LOCAL_BUFFER(T, buf, size)
Definition: oct-locbuf.h:197
std::complex< float > FloatComplex
Definition: oct-cmplx.h:30
const T * fortran_vec(void) const
Definition: Array.h:481
octave_idx_type cols(void) const
Definition: Array.h:321
FloatDiagMatrix sigma
Definition: fCmplxSVD.h:90
driver
Definition: dbleSVD.h:44
type
Definition: dbleSVD.h:37