|
7
|
1 // f-svd.cc -*- C++ -*- |
|
1
|
2 /* |
|
|
3 |
|
1009
|
4 Copyright (C) 1993, 1994, 1995 John W. Eaton |
|
1
|
5 |
|
|
6 This file is part of Octave. |
|
|
7 |
|
|
8 Octave is free software; you can redistribute it and/or modify it |
|
|
9 under the terms of the GNU General Public License as published by the |
|
|
10 Free Software Foundation; either version 2, or (at your option) any |
|
|
11 later version. |
|
|
12 |
|
|
13 Octave is distributed in the hope that it will be useful, but WITHOUT |
|
|
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
|
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
|
16 for more details. |
|
|
17 |
|
|
18 You should have received a copy of the GNU General Public License |
|
|
19 along with Octave; see the file COPYING. If not, write to the Free |
|
1315
|
20 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
|
1
|
21 |
|
|
22 */ |
|
|
23 |
|
240
|
24 #ifdef HAVE_CONFIG_H |
|
1192
|
25 #include <config.h> |
|
1
|
26 #endif |
|
|
27 |
|
1352
|
28 #include "CmplxSVD.h" |
|
453
|
29 #include "dbleSVD.h" |
|
1
|
30 |
|
1352
|
31 #include "defun-dld.h" |
|
|
32 #include "error.h" |
|
|
33 #include "gripes.h" |
|
|
34 #include "help.h" |
|
|
35 #include "mappers.h" |
|
|
36 #include "pr-output.h" |
|
1
|
37 #include "tree-const.h" |
|
|
38 #include "user-prefs.h" |
|
628
|
39 #include "utils.h" |
|
1
|
40 |
|
1488
|
41 DEFUN_DLD_BUILTIN ("svd", Fsvd, Ssvd, 11, |
|
539
|
42 "S = svd (X) or [U, S, V] = svd (X [, 0])\n\ |
|
519
|
43 \n\ |
|
539
|
44 Compute the singular value decomposition of X. Given a second input\n\ |
|
|
45 argument, an `economy' sized factorization is computed that omits\n\ |
|
1310
|
46 unnecessary rows and columns of U and V.\n\ |
|
|
47 \n\ |
|
|
48 X may not contain any Inf or NaN values.") |
|
1
|
49 { |
|
636
|
50 Octave_object retval; |
|
1
|
51 |
|
519
|
52 int nargin = args.length (); |
|
|
53 |
|
712
|
54 if (nargin < 1 || nargin > 2 || nargout == 2 || nargout > 3) |
|
519
|
55 { |
|
|
56 print_usage ("svd"); |
|
|
57 return retval; |
|
|
58 } |
|
|
59 |
|
712
|
60 tree_constant arg = args(0); |
|
620
|
61 |
|
718
|
62 int arg_is_empty = empty_arg ("svd", arg.rows (), arg.columns ()); |
|
|
63 |
|
|
64 if (arg_is_empty < 0) |
|
636
|
65 return retval; |
|
718
|
66 else if (arg_is_empty > 0) |
|
|
67 return Octave_object (3, Matrix ()); |
|
636
|
68 |
|
1544
|
69 SVD::type type = ((nargout == 0 || nargout == 1) |
|
|
70 ? SVD::sigma_only |
|
1543
|
71 : (nargin == 2) ? SVD::economy : SVD::std); |
|
539
|
72 |
|
620
|
73 if (arg.is_real_type ()) |
|
1
|
74 { |
|
620
|
75 Matrix tmp = arg.matrix_value (); |
|
1
|
76 |
|
636
|
77 if (! error_state) |
|
|
78 { |
|
1310
|
79 if (any_element_is_inf_or_nan (tmp)) |
|
|
80 { |
|
|
81 error ("svd: cannot take SVD of matrix containing Inf or\ |
|
|
82 NaN values"); |
|
|
83 return retval; |
|
|
84 } |
|
|
85 |
|
636
|
86 SVD result (tmp, type); |
|
622
|
87 |
|
636
|
88 DiagMatrix sigma = result.singular_values (); |
|
1
|
89 |
|
636
|
90 if (nargout == 0 || nargout == 1) |
|
|
91 { |
|
|
92 retval(0) = tree_constant (sigma.diag (), 1); |
|
|
93 } |
|
|
94 else |
|
|
95 { |
|
|
96 retval(2) = result.right_singular_matrix (); |
|
|
97 retval(1) = sigma; |
|
|
98 retval(0) = result.left_singular_matrix (); |
|
|
99 } |
|
620
|
100 } |
|
|
101 } |
|
|
102 else if (arg.is_complex_type ()) |
|
|
103 { |
|
|
104 ComplexMatrix ctmp = arg.complex_matrix_value (); |
|
|
105 |
|
636
|
106 if (! error_state) |
|
|
107 { |
|
1310
|
108 if (any_element_is_inf_or_nan (ctmp)) |
|
|
109 { |
|
|
110 error ("svd: cannot take SVD of matrix containing Inf or\ |
|
|
111 NaN values"); |
|
|
112 return retval; |
|
|
113 } |
|
|
114 |
|
636
|
115 ComplexSVD result (ctmp, type); |
|
622
|
116 |
|
636
|
117 DiagMatrix sigma = result.singular_values (); |
|
1
|
118 |
|
636
|
119 if (nargout == 0 || nargout == 1) |
|
|
120 { |
|
|
121 retval(0) = tree_constant (sigma.diag (), 1); |
|
|
122 } |
|
|
123 else |
|
|
124 { |
|
|
125 retval(2) = result.right_singular_matrix (); |
|
|
126 retval(1) = sigma; |
|
|
127 retval(0) = result.left_singular_matrix (); |
|
|
128 } |
|
620
|
129 } |
|
|
130 } |
|
|
131 else |
|
|
132 { |
|
|
133 gripe_wrong_type_arg ("svd", arg); |
|
|
134 return retval; |
|
1
|
135 } |
|
|
136 |
|
|
137 return retval; |
|
|
138 } |
|
|
139 |
|
|
140 /* |
|
|
141 ;;; Local Variables: *** |
|
|
142 ;;; mode: C++ *** |
|
|
143 ;;; page-delimiter: "^/\\*" *** |
|
|
144 ;;; End: *** |
|
|
145 */ |
