Mercurial > octave
annotate src/DLD-FUNCTIONS/det.cc @ 7973:e69bca367ed7
DLD-FUNCTIONS/det.cc (Fdet): return calculated determinant for numerically singular matrices
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Fri, 25 Jul 2008 15:20:39 -0400 |
parents | 87865ed7405f |
children | 64cf956a109c |
rev | line source |
---|---|
2928 | 1 /* |
2 | |
7017 | 3 Copyright (C) 1996, 1997, 1999, 2000, 2001, 2002, 2003, 2004, 2005, |
4 2006, 2007 John W. Eaton | |
2928 | 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 | |
7016 | 10 Free Software Foundation; either version 3 of the License, or (at your |
11 option) any later version. | |
2928 | 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 | |
7016 | 19 along with Octave; see the file COPYING. If not, see |
20 <http://www.gnu.org/licenses/>. | |
2928 | 21 |
22 */ | |
23 | |
24 #ifdef HAVE_CONFIG_H | |
25 #include <config.h> | |
26 #endif | |
27 | |
28 #include "CmplxDET.h" | |
29 #include "dbleDET.h" | |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
30 #include "fCmplxDET.h" |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
31 #include "floatDET.h" |
2928 | 32 |
33 #include "defun-dld.h" | |
34 #include "error.h" | |
35 #include "gripes.h" | |
36 #include "oct-obj.h" | |
37 #include "utils.h" | |
38 | |
5164 | 39 DEFUN_DLD (det, args, , |
3548 | 40 "-*- texinfo -*-\n\ |
7650 | 41 @deftypefn {Loadable Function} {[@var{d}, @var{rcond}] =} det (@var{a})\n\ |
7505
f5005d9510f4
Remove dispatched sparse functions and treat in the generic versions of the functions
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
42 Compute the determinant of @var{a} using @sc{Lapack} for full and UMFPACK\n\ |
f5005d9510f4
Remove dispatched sparse functions and treat in the generic versions of the functions
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
43 for sparse matrices. Return an estimate of the reciprocal condition number\n\ |
f5005d9510f4
Remove dispatched sparse functions and treat in the generic versions of the functions
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
44 if requested.\n\ |
3372 | 45 @end deftypefn") |
2928 | 46 { |
47 octave_value_list retval; | |
48 | |
49 int nargin = args.length (); | |
50 | |
51 if (nargin != 1) | |
52 { | |
5823 | 53 print_usage (); |
2928 | 54 return retval; |
55 } | |
56 | |
57 octave_value arg = args(0); | |
58 | |
7505
f5005d9510f4
Remove dispatched sparse functions and treat in the generic versions of the functions
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
59 octave_idx_type nr = arg.rows (); |
f5005d9510f4
Remove dispatched sparse functions and treat in the generic versions of the functions
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
60 octave_idx_type nc = arg.columns (); |
2928 | 61 |
62 if (nr == 0 && nc == 0) | |
63 { | |
4233 | 64 retval(0) = 1.0; |
2928 | 65 return retval; |
66 } | |
67 | |
68 int arg_is_empty = empty_arg ("det", nr, nc); | |
69 if (arg_is_empty < 0) | |
70 return retval; | |
71 if (arg_is_empty > 0) | |
4233 | 72 return octave_value (Matrix (1, 1, 1.0)); |
2928 | 73 |
74 if (nr != nc) | |
75 { | |
76 gripe_square_matrix_required ("det"); | |
77 return retval; | |
78 } | |
79 | |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
80 |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
81 if (arg.is_single_type ()) |
2928 | 82 { |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
83 if (arg.is_real_type ()) |
2928 | 84 { |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
85 octave_idx_type info; |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
86 float rcond = 0.0; |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
87 // Always compute rcond, so we can detect numerically |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
88 // singular matrices. |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
89 FloatMatrix m = arg.float_matrix_value (); |
7505
f5005d9510f4
Remove dispatched sparse functions and treat in the generic versions of the functions
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
90 if (! error_state) |
f5005d9510f4
Remove dispatched sparse functions and treat in the generic versions of the functions
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
91 { |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
92 FloatDET det = m.determinant (info, rcond); |
7505
f5005d9510f4
Remove dispatched sparse functions and treat in the generic versions of the functions
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
93 retval(1) = rcond; |
7973
e69bca367ed7
DLD-FUNCTIONS/det.cc (Fdet): return calculated determinant for numerically singular matrices
John W. Eaton <jwe@octave.org>
parents:
7814
diff
changeset
|
94 retval(0) = info == -1 ? static_cast<float>(0.0) : det.value (); |
7505
f5005d9510f4
Remove dispatched sparse functions and treat in the generic versions of the functions
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
95 } |
2928 | 96 } |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
97 else if (arg.is_complex_type ()) |
2928 | 98 { |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
99 octave_idx_type info; |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
100 float rcond = 0.0; |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
101 // Always compute rcond, so we can detect numerically |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
102 // singular matrices. |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
103 FloatComplexMatrix m = arg.float_complex_matrix_value (); |
7505
f5005d9510f4
Remove dispatched sparse functions and treat in the generic versions of the functions
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
104 if (! error_state) |
f5005d9510f4
Remove dispatched sparse functions and treat in the generic versions of the functions
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
105 { |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
106 FloatComplexDET det = m.determinant (info, rcond); |
7505
f5005d9510f4
Remove dispatched sparse functions and treat in the generic versions of the functions
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
107 retval(1) = rcond; |
7973
e69bca367ed7
DLD-FUNCTIONS/det.cc (Fdet): return calculated determinant for numerically singular matrices
John W. Eaton <jwe@octave.org>
parents:
7814
diff
changeset
|
108 retval(0) = info == -1 ? FloatComplex (0.0) : det.value (); |
7505
f5005d9510f4
Remove dispatched sparse functions and treat in the generic versions of the functions
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
109 } |
2928 | 110 } |
111 } | |
112 else | |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
113 { |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
114 if (arg.is_real_type ()) |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
115 { |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
116 octave_idx_type info; |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
117 double rcond = 0.0; |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
118 // Always compute rcond, so we can detect numerically |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
119 // singular matrices. |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
120 if (arg.is_sparse_type ()) |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
121 { |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
122 SparseMatrix m = arg.sparse_matrix_value (); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
123 if (! error_state) |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
124 { |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
125 DET det = m.determinant (info, rcond); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
126 retval(1) = rcond; |
7973
e69bca367ed7
DLD-FUNCTIONS/det.cc (Fdet): return calculated determinant for numerically singular matrices
John W. Eaton <jwe@octave.org>
parents:
7814
diff
changeset
|
127 retval(0) = info == -1 ? 0.0 : det.value (); |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
128 } |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
129 } |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
130 else |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
131 { |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
132 Matrix m = arg.matrix_value (); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
133 if (! error_state) |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
134 { |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
135 DET det = m.determinant (info, rcond); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
136 retval(1) = rcond; |
7973
e69bca367ed7
DLD-FUNCTIONS/det.cc (Fdet): return calculated determinant for numerically singular matrices
John W. Eaton <jwe@octave.org>
parents:
7814
diff
changeset
|
137 retval(0) = info == -1 ? 0.0 : det.value (); |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
138 } |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
139 } |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
140 } |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
141 else if (arg.is_complex_type ()) |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
142 { |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
143 octave_idx_type info; |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
144 double rcond = 0.0; |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
145 // Always compute rcond, so we can detect numerically |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
146 // singular matrices. |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
147 if (arg.is_sparse_type ()) |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
148 { |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
149 SparseComplexMatrix m = arg.sparse_complex_matrix_value (); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
150 if (! error_state) |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
151 { |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
152 ComplexDET det = m.determinant (info, rcond); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
153 retval(1) = rcond; |
7973
e69bca367ed7
DLD-FUNCTIONS/det.cc (Fdet): return calculated determinant for numerically singular matrices
John W. Eaton <jwe@octave.org>
parents:
7814
diff
changeset
|
154 retval(0) = info == -1 ? Complex (0.0) : det.value (); |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
155 } |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
156 } |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
157 else |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
158 { |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
159 ComplexMatrix m = arg.complex_matrix_value (); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
160 if (! error_state) |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
161 { |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
162 ComplexDET det = m.determinant (info, rcond); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
163 retval(1) = rcond; |
7973
e69bca367ed7
DLD-FUNCTIONS/det.cc (Fdet): return calculated determinant for numerically singular matrices
John W. Eaton <jwe@octave.org>
parents:
7814
diff
changeset
|
164 retval(0) = info == -1 ? Complex (0.0) : det.value (); |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
165 } |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
166 } |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
167 } |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
168 else |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
169 gripe_wrong_type_arg ("det", arg); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7650
diff
changeset
|
170 } |
2928 | 171 return retval; |
172 } | |
173 | |
174 /* | |
7814
87865ed7405f
Second set of single precision test code and fix of resulting bugs
David Bateman <dbateman@free.fr>
parents:
7789
diff
changeset
|
175 |
87865ed7405f
Second set of single precision test code and fix of resulting bugs
David Bateman <dbateman@free.fr>
parents:
7789
diff
changeset
|
176 %!assert(det ([1, 2; 3, 4]), -2, 10 * eps); |
87865ed7405f
Second set of single precision test code and fix of resulting bugs
David Bateman <dbateman@free.fr>
parents:
7789
diff
changeset
|
177 %!assert(det (single([1, 2; 3, 4])), single(-2), 10 * eps ('single')); |
87865ed7405f
Second set of single precision test code and fix of resulting bugs
David Bateman <dbateman@free.fr>
parents:
7789
diff
changeset
|
178 %!error <Invalid call to det.*> det (); |
87865ed7405f
Second set of single precision test code and fix of resulting bugs
David Bateman <dbateman@free.fr>
parents:
7789
diff
changeset
|
179 %!error <Invalid call to det.*> det (1, 2); |
87865ed7405f
Second set of single precision test code and fix of resulting bugs
David Bateman <dbateman@free.fr>
parents:
7789
diff
changeset
|
180 %!error det ([1, 2; 3, 4; 5, 6]); |
87865ed7405f
Second set of single precision test code and fix of resulting bugs
David Bateman <dbateman@free.fr>
parents:
7789
diff
changeset
|
181 |
87865ed7405f
Second set of single precision test code and fix of resulting bugs
David Bateman <dbateman@free.fr>
parents:
7789
diff
changeset
|
182 */ |
87865ed7405f
Second set of single precision test code and fix of resulting bugs
David Bateman <dbateman@free.fr>
parents:
7789
diff
changeset
|
183 |
87865ed7405f
Second set of single precision test code and fix of resulting bugs
David Bateman <dbateman@free.fr>
parents:
7789
diff
changeset
|
184 /* |
2928 | 185 ;;; Local Variables: *** |
186 ;;; mode: C++ *** | |
187 ;;; End: *** | |
188 */ |