Mercurial > hg > octave-lyh
annotate src/DLD-FUNCTIONS/sparse.cc @ 10479:ded9beac7582
optimize sparse matrix assembly
author | Jaroslav Hajek <highegg@gmail.com> |
---|---|
date | Wed, 31 Mar 2010 10:03:55 +0200 |
parents | d0ce5e973937 |
children | c5005bc2b7a9 |
rev | line source |
---|---|
5164 | 1 /* |
2 | |
8920 | 3 Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 David Bateman |
7016 | 4 Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004 Andy Adler |
5 | |
6 This file is part of Octave. | |
5164 | 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. | |
5164 | 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/>. | |
5164 | 21 |
22 */ | |
23 | |
24 #ifdef HAVE_CONFIG_H | |
25 #include <config.h> | |
26 #endif | |
27 | |
28 #include <cstdlib> | |
29 #include <string> | |
30 | |
31 #include "variables.h" | |
32 #include "utils.h" | |
33 #include "pager.h" | |
34 #include "defun-dld.h" | |
35 #include "gripes.h" | |
36 #include "quit.h" | |
10479
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
37 #include "unwind-prot.h" |
5164 | 38 |
39 #include "ov-re-sparse.h" | |
40 #include "ov-cx-sparse.h" | |
41 #include "ov-bool-sparse.h" | |
42 | |
43 DEFUN_DLD (issparse, args, , | |
44 "-*- texinfo -*-\n\ | |
45 @deftypefn {Loadable Function} {} issparse (@var{expr})\n\ | |
46 Return 1 if the value of the expression @var{expr} is a sparse matrix.\n\ | |
47 @end deftypefn") | |
48 { | |
49 if (args.length() != 1) | |
50 { | |
5823 | 51 print_usage (); |
5164 | 52 return octave_value (); |
53 } | |
54 else | |
7515
f3c00dc0912b
Eliminate the rest of the dispatched sparse functions
David Bateman <dbateman@free.fr>
parents:
7505
diff
changeset
|
55 return octave_value (args(0).is_sparse_type ()); |
5164 | 56 } |
57 | |
58 DEFUN_DLD (sparse, args, , | |
59 "-*- texinfo -*-\n\ | |
6556 | 60 @deftypefn {Loadable Function} {@var{s} =} sparse (@var{a})\n\ |
8106
8a42498edb30
Clarify doc for sparse function
David Bateman <dbateman@free.fr>
parents:
7515
diff
changeset
|
61 @deftypefnx {Loadable Function} {@var{s} =} sparse (@var{i}, @var{j}, @var{sv}, @var{m}, @var{n}, @var{nzmax})\n\ |
8a42498edb30
Clarify doc for sparse function
David Bateman <dbateman@free.fr>
parents:
7515
diff
changeset
|
62 @deftypefnx {Loadable Function} {@var{s} =} sparse (@var{i}, @var{j}, @var{sv})\n\ |
8a42498edb30
Clarify doc for sparse function
David Bateman <dbateman@free.fr>
parents:
7515
diff
changeset
|
63 @deftypefnx {Loadable Function} {@var{s} =} sparse (@var{i}, @var{j}, @var{s}, @var{m}, @var{n}, \"unique\")\n\ |
8a42498edb30
Clarify doc for sparse function
David Bateman <dbateman@free.fr>
parents:
7515
diff
changeset
|
64 @deftypefnx {Loadable Function} {@var{s} =} sparse (@var{m}, @var{n})\n\ |
8a42498edb30
Clarify doc for sparse function
David Bateman <dbateman@free.fr>
parents:
7515
diff
changeset
|
65 Create a sparse matrix from the full matrix or row, column, value triplets.\n\ |
8a42498edb30
Clarify doc for sparse function
David Bateman <dbateman@free.fr>
parents:
7515
diff
changeset
|
66 If @var{a} is a full matrix, convert it to a sparse matrix representation,\n\ |
8a42498edb30
Clarify doc for sparse function
David Bateman <dbateman@free.fr>
parents:
7515
diff
changeset
|
67 removing all zero values in the process.\n\ |
5164 | 68 \n\ |
8106
8a42498edb30
Clarify doc for sparse function
David Bateman <dbateman@free.fr>
parents:
7515
diff
changeset
|
69 Given the integer index vectors @var{i} and @var{j}, a 1-by-@code{nnz} vector\n\ |
8a42498edb30
Clarify doc for sparse function
David Bateman <dbateman@free.fr>
parents:
7515
diff
changeset
|
70 of real of complex values @var{sv}, overall dimensions @var{m} and @var{n}\n\ |
8a42498edb30
Clarify doc for sparse function
David Bateman <dbateman@free.fr>
parents:
7515
diff
changeset
|
71 of the sparse matrix. The argument @code{nzmax} is ignored but accepted for\n\ |
9064
7c02ec148a3c
Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
72 compatibility with @sc{matlab}. If @var{m} or @var{n} are not specified their\n\ |
8106
8a42498edb30
Clarify doc for sparse function
David Bateman <dbateman@free.fr>
parents:
7515
diff
changeset
|
73 values are derived from the maximum index in the vectors @var{i} and @var{j}\n\ |
8a42498edb30
Clarify doc for sparse function
David Bateman <dbateman@free.fr>
parents:
7515
diff
changeset
|
74 as given by @code{@var{m} = max (@var{i})}, @code{@var{n} = max (@var{j})}.\n\ |
5164 | 75 \n\ |
6556 | 76 @strong{Note}: if multiple values are specified with the same\n\ |
77 @var{i}, @var{j} indices, the corresponding values in @var{s} will\n\ | |
78 be added.\n\ | |
79 \n\ | |
6557 | 80 The following are all equivalent:\n\ |
5164 | 81 \n\ |
6556 | 82 @example\n\ |
83 @group\n\ | |
84 s = sparse (i, j, s, m, n)\n\ | |
85 s = sparse (i, j, s, m, n, \"summation\")\n\ | |
86 s = sparse (i, j, s, m, n, \"sum\")\n\ | |
87 @end group\n\ | |
88 @end example\n\ | |
5164 | 89 \n\ |
8106
8a42498edb30
Clarify doc for sparse function
David Bateman <dbateman@free.fr>
parents:
7515
diff
changeset
|
90 Given the option \"unique\". if more than two values are specified for the\n\ |
6556 | 91 same @var{i}, @var{j} indices, the last specified value will be used.\n\ |
5164 | 92 \n\ |
8106
8a42498edb30
Clarify doc for sparse function
David Bateman <dbateman@free.fr>
parents:
7515
diff
changeset
|
93 @code{sparse(@var{m}, @var{n})} is equivalent to\n\ |
8a42498edb30
Clarify doc for sparse function
David Bateman <dbateman@free.fr>
parents:
7515
diff
changeset
|
94 @code{sparse ([], [], [], @var{m}, @var{n}, 0)}\n\ |
6556 | 95 \n\ |
96 If any of @var{sv}, @var{i} or @var{j} are scalars, they are expanded\n\ | |
97 to have a common size.\n\ | |
5164 | 98 @seealso{full}\n\ |
99 @end deftypefn") | |
100 { | |
101 octave_value retval; | |
10479
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
102 int nargin = args.length (); |
5164 | 103 |
10479
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
104 // Temporarily disable sparse_auto_mutate if set (it's obsolete anyway). |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
105 unwind_protect frame; |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
106 frame.protect_var (Vsparse_auto_mutate); |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
107 Vsparse_auto_mutate = false; |
5164 | 108 |
7287 | 109 if (nargin == 1) |
5164 | 110 { |
111 octave_value arg = args (0); | |
10479
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
112 if (arg.is_bool_type ()) |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
113 retval = arg.sparse_bool_matrix_value (); |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
114 else if (arg.is_complex_type ()) |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
115 retval = arg.sparse_complex_matrix_value (); |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
116 else if (arg.is_numeric_type ()) |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
117 retval = arg.sparse_matrix_value (); |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
118 else |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
119 gripe_wrong_type_arg ("sparse", arg); |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
120 } |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
121 else if (nargin == 2) |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
122 { |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
123 octave_idx_type m = 0, n = 0; |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
124 if (args(0).is_scalar_type () && args(1).is_scalar_type ()) |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9064
diff
changeset
|
125 { |
10479
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
126 m = args(0).idx_type_value (); |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
127 n = args(1).idx_type_value (); |
8910
6e9f26506804
optimize diag -> sparse and perm -> sparse conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
8458
diff
changeset
|
128 } |
5164 | 129 else |
10479
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
130 error ("sparse: expecting scalar dimensions"); |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
131 |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
132 if (! error_state) |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9064
diff
changeset
|
133 { |
10479
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
134 if (m >= 0 && n >= 0) |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
135 retval = SparseMatrix (m, n); |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
136 else |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
137 error ("sparse: dimensions must be nonnegative"); |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9064
diff
changeset
|
138 } |
5164 | 139 } |
10479
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
140 else if (nargin >= 3) |
5164 | 141 { |
10479
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
142 bool summation = true; |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
143 if (nargin > 3 && args(nargin-1).is_string ()) |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9064
diff
changeset
|
144 { |
10479
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
145 std::string opt = args(nargin-1).string_value (); |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
146 if (opt == "unique") |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
147 summation = false; |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
148 else if (opt == "sum" || opt == "summation") |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
149 summation = true; |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9064
diff
changeset
|
150 else |
10479
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
151 error ("sparse: invalid option: %s", opt.c_str ()); |
5164 | 152 |
10479
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
153 nargin -= 1; |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
154 } |
5164 | 155 |
10479
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
156 if (! error_state) |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
157 { |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
158 octave_idx_type m = -1, n = -1; |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
159 if (nargin == 5) |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
160 { |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
161 if (args(3).is_scalar_type () && args(4).is_scalar_type ()) |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
162 { |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
163 m = args(3).idx_type_value (); |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
164 n = args(4).idx_type_value (); |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
165 } |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
166 else |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
167 error ("sparse: expecting scalar dimensions"); |
5164 | 168 |
169 | |
10479
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
170 if (! error_state && (m < 0 || n < 0)) |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
171 error ("sparse: dimensions must be nonnegative"); |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
172 } |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
173 else if (nargin != 3) |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
174 print_usage (); |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
175 |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
176 if (! error_state) |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
177 { |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
178 idx_vector i = args(0).index_vector (); |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
179 idx_vector j = args(1).index_vector (); |
5164 | 180 |
10479
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
181 if (args(2).is_bool_type ()) |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
182 retval = SparseBoolMatrix (args(2).bool_array_value (), i, j, |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
183 m, n, summation); |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
184 else if (args(2).is_complex_type ()) |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
185 retval = SparseComplexMatrix (args(2).complex_array_value (), i, j, |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
186 m, n, summation); |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
187 else if (args(2).is_numeric_type ()) |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
188 retval = SparseMatrix (args(2).array_value (), i, j, |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
189 m, n, summation); |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
190 else |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
191 gripe_wrong_type_arg ("sparse", args(2)); |
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10155
diff
changeset
|
192 } |
5164 | 193 |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9064
diff
changeset
|
194 } |
5164 | 195 } |
196 | |
197 return retval; | |
198 } |