Mercurial > octave-antonio

annotate scripts/general/repmat.m @ 8920:eb63fbe60fab

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
update copyright notices
author John W. Eaton <jwe@octave.org>
date Sat, 07 Mar 2009 10:41:27 -0500
parents dee629f14bfa
children b37a6c27c23f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8920
eb63fbe60fab update copyright notices
John W. Eaton <jwe@octave.org>
parents: 8508
diff changeset
1 ## Copyright (C) 2000, 2002, 2004, 2005, 2006, 2007, 2009 Paul Kienzle
8390
49901b624316 optimize repmat for scalar & matrix case
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
2 ## Copyright (C) 2008 Jaroslav Hajek
3914
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
3 ##
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
4 ## This file is part of Octave.
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
5 ##
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
6 ## Octave is free software; you can redistribute it and/or modify it
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
7 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6987
diff changeset
8 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6987
diff changeset
9 ## your option) any later version.
3914
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
10 ##
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
11 ## Octave is distributed in the hope that it will be useful, but
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
14 ## General Public License for more details.
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
15 ##
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
16 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6987
diff changeset
17 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6987
diff changeset
18 ## <http://www.gnu.org/licenses/>.
3914
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
19
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
20 ## -*- texinfo -*-
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
21 ## @deftypefn {Function File} {} repmat (@var{A}, @var{m}, @var{n})
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
22 ## @deftypefnx {Function File} {} repmat (@var{A}, [@var{m} @var{n}])
6987
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
23 ## @deftypefnx {Function File} {} repmat (@var{A}, [@var{m} @var{n} @var{p} ...])
3914
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
24 ## Form a block matrix of size @var{m} by @var{n}, with a copy of matrix
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
25 ## @var{A} as each element. If @var{n} is not specified, form an
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
26 ## @var{m} by @var{m} block matrix.
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
27 ## @end deftypefn
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
28
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
29 ## Author: Paul Kienzle <pkienzle@kienzle.powernet.co.uk>
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
30 ## Created: July 2000
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
31
3915
2f341412622f [project @ 2002-04-30 02:41:04 by jwe]
jwe
parents: 3914
diff changeset
32 function x = repmat (a, m, n)
2f341412622f [project @ 2002-04-30 02:41:04 by jwe]
jwe
parents: 3914
diff changeset
33
3914
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
34 if (nargin < 2 || nargin > 3)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5443
diff changeset
35 print_usage ();
3914
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
36 endif
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
37
4844
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4030
diff changeset
38 if (nargin == 3)
5195
5208182e2e62 [project @ 2005-03-08 19:04:12 by jwe]
jwe
parents: 4964
diff changeset
39 if (! (isscalar (m) && isscalar (n)))
4844
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4030
diff changeset
40 error ("repmat: with 3 arguments m and n must be scalar");
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4030
diff changeset
41 endif
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4030
diff changeset
42 idx = [m, n];
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4030
diff changeset
43 else
4030
22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe]
jwe
parents: 3915
diff changeset
44 if (isscalar (m))
4844
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4030
diff changeset
45 idx = [m, m];
3914
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
46 n = m;
4844
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4030
diff changeset
47 elseif (isvector (m) && length (m) > 1)
8390
49901b624316 optimize repmat for scalar & matrix case
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
48 ## Ensure that we have a row vector
4844
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4030
diff changeset
49 idx = m(:).';
3914
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
50 else
4844
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4030
diff changeset
51 error ("repmat: invalid dimensional argument");
3914
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
52 endif
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
53 endif
8508
dee629f14bfa repmat.m: handle negative dimensions properly
John W. Eaton <jwe@octave.org>
parents: 8507
diff changeset
54
dee629f14bfa repmat.m: handle negative dimensions properly
John W. Eaton <jwe@octave.org>
parents: 8507
diff changeset
55 if (all (idx < 0))
dee629f14bfa repmat.m: handle negative dimensions properly
John W. Eaton <jwe@octave.org>
parents: 8507
diff changeset
56 error ("repmat: invalid dimensions");
dee629f14bfa repmat.m: handle negative dimensions properly
John W. Eaton <jwe@octave.org>
parents: 8507
diff changeset
57 else
dee629f14bfa repmat.m: handle negative dimensions properly
John W. Eaton <jwe@octave.org>
parents: 8507
diff changeset
58 idx = max (idx, 0);
dee629f14bfa repmat.m: handle negative dimensions properly
John W. Eaton <jwe@octave.org>
parents: 8507
diff changeset
59 endif
3914
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
60
4844
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4030
diff changeset
61 if (numel (a) == 1)
8390
49901b624316 optimize repmat for scalar & matrix case
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
62 ## optimize the scalar fill case.
49901b624316 optimize repmat for scalar & matrix case
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
63 x(1:prod (idx)) = a;
49901b624316 optimize repmat for scalar & matrix case
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
64 x = reshape (x, idx);
49901b624316 optimize repmat for scalar & matrix case
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
65 elseif (ndims (a) == 2 && length (idx) < 3)
49901b624316 optimize repmat for scalar & matrix case
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
66 if (issparse (a))
49901b624316 optimize repmat for scalar & matrix case
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
67 x = spkron (ones (idx), a);
4844
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4030
diff changeset
68 else
8390
49901b624316 optimize repmat for scalar & matrix case
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
69 ## indexing is now faster, so we use it rather than kron.
49901b624316 optimize repmat for scalar & matrix case
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
70 m = rows (a); n = columns (a);
49901b624316 optimize repmat for scalar & matrix case
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
71 p = idx(1); q = idx(2);
49901b624316 optimize repmat for scalar & matrix case
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
72 x = reshape (a, m, 1, n, 1);
49901b624316 optimize repmat for scalar & matrix case
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
73 x = x(:, ones (1, p), :, ones (1, q));
49901b624316 optimize repmat for scalar & matrix case
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
74 x = reshape (x, m*p, n*q);
4844
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4030
diff changeset
75 endif
3914
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
76 else
4844
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4030
diff changeset
77 aidx = size(a);
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4030
diff changeset
78 if (length(aidx) > length(idx))
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4030
diff changeset
79 idx = [idx, ones(1,length(aidx)-length(idx))];
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4030
diff changeset
80 elseif (length(aidx) < length(idx))
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4030
diff changeset
81 aidx = [aidx, ones(1,length(idx)-length(aidx))];
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4030
diff changeset
82 endif
4945
4bd917f8a4a7 [project @ 2004-08-31 15:09:17 by jwe]
jwe
parents: 4844
diff changeset
83 cidx = cell (1, length (aidx));
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8390
diff changeset
84 for i = 1:length (aidx)
4844
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4030
diff changeset
85 cidx{i} = kron (ones (1, idx(i)), 1:aidx(i));
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4030
diff changeset
86 endfor
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4030
diff changeset
87 x = a (cidx{:});
3914
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
88 endif
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
89
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
90 endfunction
6987
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
91
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
92 # Test various methods of providing size parameters
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
93 %!shared x
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
94 %! x = [1 2;3 4];
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
95 %!assert(repmat(x, [1 1]), repmat(x, 1));
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
96 %!assert(repmat(x, [3 3]), repmat(x, 3));
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
97 %!assert(repmat(x, [1 1]), repmat(x, 1, 1));
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
98 %!assert(repmat(x, [1 3]), repmat(x, 1, 3));
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
99 %!assert(repmat(x, [3 1]), repmat(x, 3, 1));
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
100 %!assert(repmat(x, [3 3]), repmat(x, 3, 3));
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
101
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
102 # Tests for numel==1 case:
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
103 %!shared x, r
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
104 %! x = [ 65 ];
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
105 %! r = kron(ones(2,2), x);
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
106 %!assert(r, repmat(x, [2 2]));
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
107 %!assert(char(r), repmat(char(x), [2 2]));
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
108 %!assert(int8(r), repmat(int8(x), [2 2]));
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
109
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
110 # Tests for ndims==2 case:
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
111 %!shared x, r
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
112 %! x = [ 65 66 67 ];
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
113 %! r = kron(ones(2,2), x);
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
114 %!assert(r, repmat(x, [2 2]));
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
115 %!assert(char(r), repmat(char(x), [2 2]));
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
116 %!assert(int8(r), repmat(int8(x), [2 2]));
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
117
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
118 # Tests for dim>2 case:
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
119 %!shared x, r
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
120 %! x = [ 65 66 67 ];
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
121 %! r = kron(ones(2,2), x);
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
122 %! r(:,:,2) = r(:,:,1);
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
123 %!assert(r, repmat(x, [2 2 2]));
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
124 %!assert(char(r), repmat(char(x), [2 2 2]));
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
125 %!assert(int8(r), repmat(int8(x), [2 2 2]));
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
126
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
127 # Test that sparsity is kept
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
128 %!assert(sparse(4,4), repmat(sparse(2,2),[2 2]));
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
129
8508
dee629f14bfa repmat.m: handle negative dimensions properly
John W. Eaton <jwe@octave.org>
parents: 8507
diff changeset
130
dee629f14bfa repmat.m: handle negative dimensions properly
John W. Eaton <jwe@octave.org>
parents: 8507
diff changeset
131 %!assert (size (repmat (".", -1, 1)), [0, 1]);
dee629f14bfa repmat.m: handle negative dimensions properly
John W. Eaton <jwe@octave.org>
parents: 8507
diff changeset
132 %!assert (size (repmat (".", 1, -1)), [1, 0]);
dee629f14bfa repmat.m: handle negative dimensions properly
John W. Eaton <jwe@octave.org>
parents: 8507
diff changeset
133 %!error (size (repmat (".", -1, -1)));