Mercurial > hg > octave-nkf
annotate src/DLD-FUNCTIONS/kron.cc @ 13929:9cae456085c2
Grammarcheck of documentation before 3.6.0 release.
* accumarray.m, blkdiag.m, nargoutchk.m, nthargout.m, profexplore.m, profile.m,
computer.m, orderfields.m, recycle.m, version.m, sqp.m, matlabroot.m,
__plt_get_axis_arg__.m, isonormals.m, isosurface.m, __fltk_file_filter__.m,
__is_function__.m, __uigetdir_fltk__.m, __uigetfile_fltk__.m,
__uiobject_split_args__.m, __uiputfile_fltk__.m, uicontextmenu.m, uiresume.m,
uiwait.m, mkpp.m, ppder.m, residue.m, addpref.m, getpref.m, ispref.m,
loadprefs.m, prefsfile.m, saveprefs.m, rmpref.m, setpref.m, fftshift.m, bicg.m,
bicgstab.m, cgs.m, gmres.m, __sprand_impl__.m, quantile.m, deblank.m,
strsplit.m, addtodate.m, bsxfun.cc, kron.cc, regexp.cc, data.cc, file-io.cc,
graphics.cc, load-save.cc, mappers.cc: Grammarcheck of documentation
before 3.6.0 release.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Wed, 23 Nov 2011 08:38:19 -0800 |
parents | 77857d6fe074 |
children | 72c96de7a403 |
rev | line source |
---|---|
3910 | 1 /* |
2 | |
11523 | 3 Copyright (C) 2002-2011 John W. Eaton |
3910 | 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 | |
7016 | 9 Free Software Foundation; either version 3 of the License, or (at your |
10 option) any later version. | |
3910 | 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 | |
7016 | 18 along with Octave; see the file COPYING. If not, see |
19 <http://www.gnu.org/licenses/>. | |
3910 | 20 |
21 */ | |
22 | |
3911 | 23 // Author: Paul Kienzle <pkienzle@users.sf.net> |
24 | |
3910 | 25 #ifdef HAVE_CONFIG_H |
26 #include <config.h> | |
27 #endif | |
28 | |
29 #include "dMatrix.h" | |
10461 | 30 #include "fMatrix.h" |
3910 | 31 #include "CMatrix.h" |
10461 | 32 #include "fCMatrix.h" |
33 | |
34 #include "dSparse.h" | |
35 #include "CSparse.h" | |
36 | |
37 #include "dDiagMatrix.h" | |
38 #include "fDiagMatrix.h" | |
39 #include "CDiagMatrix.h" | |
40 #include "fCDiagMatrix.h" | |
41 | |
42 #include "PermMatrix.h" | |
43 | |
44 #include "mx-inlines.cc" | |
4153 | 45 #include "quit.h" |
3910 | 46 |
47 #include "defun-dld.h" | |
48 #include "error.h" | |
49 #include "oct-obj.h" | |
50 | |
10461 | 51 template <class R, class T> |
52 static MArray<T> | |
53 kron (const MArray<R>& a, const MArray<T>& b) | |
54 { | |
55 assert (a.ndims () == 2); | |
56 assert (b.ndims () == 2); | |
57 | |
58 octave_idx_type nra = a.rows (), nrb = b.rows (); | |
59 octave_idx_type nca = a.cols (), ncb = b.cols (); | |
3910 | 60 |
11570
57632dea2446
attempt better backward compatibility for Array constructors
John W. Eaton <jwe@octave.org>
parents:
11553
diff
changeset
|
61 MArray<T> c (dim_vector (nra*nrb, nca*ncb)); |
10461 | 62 T *cv = c.fortran_vec (); |
63 | |
64 for (octave_idx_type ja = 0; ja < nca; ja++) | |
65 for (octave_idx_type jb = 0; jb < ncb; jb++) | |
66 for (octave_idx_type ia = 0; ia < nra; ia++) | |
67 { | |
68 octave_quit (); | |
69 mx_inline_mul (nrb, cv, a(ia, ja), b.data () + nrb*jb); | |
70 cv += nrb; | |
71 } | |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7455
diff
changeset
|
72 |
10461 | 73 return c; |
74 } | |
75 | |
76 template <class R, class T> | |
77 static MArray<T> | |
78 kron (const MDiagArray2<R>& a, const MArray<T>& b) | |
79 { | |
80 assert (b.ndims () == 2); | |
81 | |
82 octave_idx_type nra = a.rows (), nrb = b.rows (), dla = a.diag_length (); | |
83 octave_idx_type nca = a.cols (), ncb = b.cols (); | |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7455
diff
changeset
|
84 |
11570
57632dea2446
attempt better backward compatibility for Array constructors
John W. Eaton <jwe@octave.org>
parents:
11553
diff
changeset
|
85 MArray<T> c (dim_vector (nra*nrb, nca*ncb), T()); |
10461 | 86 |
87 for (octave_idx_type ja = 0; ja < dla; ja++) | |
88 for (octave_idx_type jb = 0; jb < ncb; jb++) | |
89 { | |
90 octave_quit (); | |
91 mx_inline_mul (nrb, &c.xelem(ja*nrb, ja*ncb + jb), a.dgelem (ja), b.data () + nrb*jb); | |
92 } | |
93 | |
94 return c; | |
95 } | |
3910 | 96 |
97 template <class T> | |
10461 | 98 static MSparse<T> |
99 kron (const MSparse<T>& A, const MSparse<T>& B) | |
7455
fe332ce262b5
eliminate spkron.cc; dispatch in kron
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
100 { |
fe332ce262b5
eliminate spkron.cc; dispatch in kron
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
101 octave_idx_type idx = 0; |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11570
diff
changeset
|
102 MSparse<T> C (A.rows () * B.rows (), A.columns () * B.columns (), |
10527
b4d2080b6df7
Replace nzmax by nnz as needed
David Bateman <dbateman@free.fr>
parents:
10461
diff
changeset
|
103 A.nnz () * B.nnz ()); |
7455
fe332ce262b5
eliminate spkron.cc; dispatch in kron
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
104 |
fe332ce262b5
eliminate spkron.cc; dispatch in kron
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
105 C.cidx (0) = 0; |
fe332ce262b5
eliminate spkron.cc; dispatch in kron
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
106 |
fe332ce262b5
eliminate spkron.cc; dispatch in kron
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
107 for (octave_idx_type Aj = 0; Aj < A.columns (); Aj++) |
fe332ce262b5
eliminate spkron.cc; dispatch in kron
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
108 for (octave_idx_type Bj = 0; Bj < B.columns (); Bj++) |
fe332ce262b5
eliminate spkron.cc; dispatch in kron
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
109 { |
10461 | 110 octave_quit (); |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
111 for (octave_idx_type Ai = A.cidx (Aj); Ai < A.cidx (Aj+1); Ai++) |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
112 { |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
113 octave_idx_type Ci = A.ridx(Ai) * B.rows (); |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
114 const T v = A.data (Ai); |
7455
fe332ce262b5
eliminate spkron.cc; dispatch in kron
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
115 |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
116 for (octave_idx_type Bi = B.cidx (Bj); Bi < B.cidx (Bj+1); Bi++) |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
117 { |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
118 C.data (idx) = v * B.data (Bi); |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
119 C.ridx (idx++) = Ci + B.ridx (Bi); |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
120 } |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
121 } |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9209
diff
changeset
|
122 C.cidx (Aj * B.columns () + Bj + 1) = idx; |
7455
fe332ce262b5
eliminate spkron.cc; dispatch in kron
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
123 } |
10461 | 124 |
125 return C; | |
7455
fe332ce262b5
eliminate spkron.cc; dispatch in kron
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
126 } |
fe332ce262b5
eliminate spkron.cc; dispatch in kron
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
127 |
10461 | 128 static PermMatrix |
129 kron (const PermMatrix& a, const PermMatrix& b) | |
130 { | |
131 octave_idx_type na = a.rows (), nb = b.rows (); | |
132 const octave_idx_type *pa = a.data (), *pb = b.data (); | |
133 PermMatrix c(na*nb); // Row permutation. | |
134 octave_idx_type *pc = c.fortran_vec (); | |
7455
fe332ce262b5
eliminate spkron.cc; dispatch in kron
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
135 |
10461 | 136 bool cola = a.is_col_perm (), colb = b.is_col_perm (); |
137 if (cola && colb) | |
138 { | |
139 for (octave_idx_type i = 0; i < na; i++) | |
140 for (octave_idx_type j = 0; j < nb; j++) | |
141 pc[pa[i]*nb+pb[j]] = i*nb+j; | |
142 } | |
143 else if (cola) | |
144 { | |
145 for (octave_idx_type i = 0; i < na; i++) | |
146 for (octave_idx_type j = 0; j < nb; j++) | |
147 pc[pa[i]*nb+j] = i*nb+pb[j]; | |
148 } | |
149 else if (colb) | |
150 { | |
151 for (octave_idx_type i = 0; i < na; i++) | |
152 for (octave_idx_type j = 0; j < nb; j++) | |
153 pc[i*nb+pb[j]] = pa[i]*nb+j; | |
154 } | |
155 else | |
156 { | |
157 for (octave_idx_type i = 0; i < na; i++) | |
158 for (octave_idx_type j = 0; j < nb; j++) | |
159 pc[i*nb+j] = pa[i]*nb+pb[j]; | |
160 } | |
161 | |
162 return c; | |
163 } | |
7455
fe332ce262b5
eliminate spkron.cc; dispatch in kron
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
164 |
fe332ce262b5
eliminate spkron.cc; dispatch in kron
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
165 |
10461 | 166 template <class MTA, class MTB> |
167 octave_value | |
168 do_kron (const octave_value& a, const octave_value& b) | |
169 { | |
170 MTA am = octave_value_extract<MTA> (a); | |
171 MTB bm = octave_value_extract<MTB> (b); | |
172 return octave_value (kron (am, bm)); | |
173 } | |
174 | |
13748
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
175 octave_value |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
176 dispatch_kron (const octave_value& a, const octave_value& b) |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
177 { |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
178 octave_value retval; |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
179 if (a.is_perm_matrix () && b.is_perm_matrix ()) |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
180 retval = do_kron<PermMatrix, PermMatrix> (a, b); |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
181 else if (a.is_diag_matrix ()) |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
182 { |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
183 if (b.is_diag_matrix () && a.rows () == a.columns () |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
184 && b.rows () == b.columns ()) |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
185 { |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
186 octave_value_list tmp; |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
187 tmp(0) = a.diag (); |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
188 tmp(1) = b.diag (); |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
189 tmp = dispatch_kron (tmp, 1); |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
190 if (tmp.length () == 1) |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
191 retval = tmp(0).diag (); |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
192 } |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
193 else if (a.is_single_type () || b.is_single_type ()) |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
194 { |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
195 if (a.is_complex_type ()) |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
196 retval = do_kron<FloatComplexDiagMatrix, FloatComplexMatrix> (a, b); |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
197 else if (b.is_complex_type ()) |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
198 retval = do_kron<FloatDiagMatrix, FloatComplexMatrix> (a, b); |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
199 else |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
200 retval = do_kron<FloatDiagMatrix, FloatMatrix> (a, b); |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
201 } |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
202 else |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
203 { |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
204 if (a.is_complex_type ()) |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
205 retval = do_kron<ComplexDiagMatrix, ComplexMatrix> (a, b); |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
206 else if (b.is_complex_type ()) |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
207 retval = do_kron<DiagMatrix, ComplexMatrix> (a, b); |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
208 else |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
209 retval = do_kron<DiagMatrix, Matrix> (a, b); |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
210 } |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
211 } |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
212 else if (a.is_sparse_type () || b.is_sparse_type ()) |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
213 { |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
214 if (a.is_complex_type () || b.is_complex_type ()) |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
215 retval = do_kron<SparseComplexMatrix, SparseComplexMatrix> (a, b); |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
216 else |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
217 retval = do_kron<SparseMatrix, SparseMatrix> (a, b); |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
218 } |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
219 else if (a.is_single_type () || b.is_single_type ()) |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
220 { |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
221 if (a.is_complex_type ()) |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
222 retval = do_kron<FloatComplexMatrix, FloatComplexMatrix> (a, b); |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
223 else if (b.is_complex_type ()) |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
224 retval = do_kron<FloatMatrix, FloatComplexMatrix> (a, b); |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
225 else |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
226 retval = do_kron<FloatMatrix, FloatMatrix> (a, b); |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
227 } |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
228 else |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
229 { |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
230 if (a.is_complex_type ()) |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
231 retval = do_kron<ComplexMatrix, ComplexMatrix> (a, b); |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
232 else if (b.is_complex_type ()) |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
233 retval = do_kron<Matrix, ComplexMatrix> (a, b); |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
234 else |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
235 retval = do_kron<Matrix, Matrix> (a, b); |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
236 } |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
237 return retval; |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
238 } |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
239 |
10461 | 240 |
241 DEFUN_DLD (kron, args, , "-*- texinfo -*-\n\ | |
13929
9cae456085c2
Grammarcheck of documentation before 3.6.0 release.
Rik <octave@nomad.inbox5.com>
parents:
13748
diff
changeset
|
242 @deftypefn {Loadable Function} {} kron (@var{A}, @var{B})\n\ |
13748
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
243 @deftypefnx {Loadable Function} {} kron (@var{A1}, @var{A2}, @dots{})\n\ |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
244 Form the Kronecker product of two or more matrices, defined block by \n\ |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
245 block as\n\ |
3910 | 246 \n\ |
247 @example\n\ | |
248 x = [a(i, j) b]\n\ | |
249 @end example\n\ | |
250 \n\ | |
10840 | 251 For example:\n\ |
3910 | 252 \n\ |
253 @example\n\ | |
254 @group\n\ | |
255 kron (1:4, ones (3, 1))\n\ | |
256 @result{} 1 2 3 4\n\ | |
257 1 2 3 4\n\ | |
258 1 2 3 4\n\ | |
259 @end group\n\ | |
260 @end example\n\ | |
13748
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
261 \n\ |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
262 If there are more than two input arguments @var{A1}, @var{A2}, @dots{}, \n\ |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
263 @var{An} the Kronecker product is computed as\n\ |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
264 \n\ |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
265 @example\n\ |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
266 kron (kron (@var{A1}, @var{A2}), @dots{}, @var{An})\n\ |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
267 @end example\n\ |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
268 \n\ |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
269 @noindent\n\ |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
270 Since the Kronecker product is associative, this is well-defined.\n\ |
3910 | 271 @end deftypefn") |
272 { | |
10461 | 273 octave_value retval; |
3910 | 274 |
275 int nargin = args.length (); | |
276 | |
13748
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
277 if (nargin >= 2) |
3910 | 278 { |
10461 | 279 octave_value a = args(0), b = args(1); |
13748
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
280 retval = dispatch_kron (a, b); |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
281 for (octave_idx_type i = 2; i < nargin; i++) |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
282 retval = dispatch_kron (retval, args(i)); |
3910 | 283 } |
13748
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
284 else |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
285 print_usage (); |
3910 | 286 |
287 return retval; | |
288 } | |
12790
5ecdb60ddf0f
codesprint: Write two tests for kron.cc
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
11586
diff
changeset
|
289 |
13748
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
290 |
12790
5ecdb60ddf0f
codesprint: Write two tests for kron.cc
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
11586
diff
changeset
|
291 /* |
5ecdb60ddf0f
codesprint: Write two tests for kron.cc
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
11586
diff
changeset
|
292 |
5ecdb60ddf0f
codesprint: Write two tests for kron.cc
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
11586
diff
changeset
|
293 %!test |
5ecdb60ddf0f
codesprint: Write two tests for kron.cc
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
11586
diff
changeset
|
294 %! x = ones(2); |
5ecdb60ddf0f
codesprint: Write two tests for kron.cc
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
11586
diff
changeset
|
295 %! assert( kron (x, x), ones (4)); |
5ecdb60ddf0f
codesprint: Write two tests for kron.cc
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
11586
diff
changeset
|
296 |
13748
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
297 %!shared x, y, z |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
298 %! x = [1, 2]; |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
299 %! y = [-1, -2]; |
12790
5ecdb60ddf0f
codesprint: Write two tests for kron.cc
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
11586
diff
changeset
|
300 %! z = [1, 2, 3, 4; 1, 2, 3, 4; 1, 2, 3, 4]; |
13748
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
301 %!assert (kron (1:4, ones (3, 1)), z) |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
302 %!assert (kron (x, y, z), kron (kron (x, y), z)) |
77857d6fe074
Allow more than two input arguments for the kron function, plus some cleanup.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12790
diff
changeset
|
303 %!assert (kron (x, y, z), kron (x, kron (y, z))) |
12790
5ecdb60ddf0f
codesprint: Write two tests for kron.cc
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
11586
diff
changeset
|
304 |
5ecdb60ddf0f
codesprint: Write two tests for kron.cc
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
11586
diff
changeset
|
305 */ |