Mercurial > hg > octave-nkf
annotate scripts/general/repmat.m @ 11595:5ec6aa05638d
Prevent doubled quotes around @table items in Info.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Thu, 20 Jan 2011 21:29:14 -0800 |
parents | c792872f8942 |
children | 4d777e05d47c |
rev | line source |
---|---|
11523 | 1 ## Copyright (C) 2000-2011 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 | 3 ## |
4 ## This file is part of Octave. | |
5 ## | |
6 ## Octave is free software; you can redistribute it and/or modify it | |
7 ## under the terms of the GNU General Public License as published by | |
7016 | 8 ## the Free Software Foundation; either version 3 of the License, or (at |
9 ## your option) any later version. | |
3914 | 10 ## |
11 ## Octave is distributed in the hope that it will be useful, but | |
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
14 ## General Public License for more details. | |
15 ## | |
16 ## You should have received a copy of the GNU General Public License | |
7016 | 17 ## along with Octave; see the file COPYING. If not, see |
18 ## <http://www.gnu.org/licenses/>. | |
3914 | 19 |
20 ## -*- texinfo -*- | |
10793
be55736a0783
Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents:
9388
diff
changeset
|
21 ## @deftypefn {Function File} {} repmat (@var{A}, @var{m}, @var{n}) |
3914 | 22 ## @deftypefnx {Function File} {} repmat (@var{A}, [@var{m} @var{n}]) |
9041
853f96e8008f
Cleanup documentation file matrix.texi
Rik <rdrider0-list@yahoo.com>
parents:
8970
diff
changeset
|
23 ## @deftypefnx {Function File} {} repmat (@var{A}, [@var{m} @var{n} @var{p} @dots{}]) |
3914 | 24 ## Form a block matrix of size @var{m} by @var{n}, with a copy of matrix |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
25 ## @var{A} as each element. If @var{n} is not specified, form an |
3914 | 26 ## @var{m} by @var{m} block matrix. |
10801
a40e32927b3a
Improve documentation for new repelems function.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
27 ## @seealso{repelems} |
3914 | 28 ## @end deftypefn |
29 | |
30 ## Author: Paul Kienzle <pkienzle@kienzle.powernet.co.uk> | |
31 ## Created: July 2000 | |
32 | |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11318
diff
changeset
|
33 function x = repmat (A, m, n) |
3915 | 34 |
3914 | 35 if (nargin < 2 || nargin > 3) |
6046 | 36 print_usage (); |
3914 | 37 endif |
38 | |
4844 | 39 if (nargin == 3) |
5195 | 40 if (! (isscalar (m) && isscalar (n))) |
11472
1740012184f9
Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents:
11469
diff
changeset
|
41 error ("repmat: with 3 arguments M and N must be scalar"); |
4844 | 42 endif |
43 idx = [m, n]; | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
44 else |
4030 | 45 if (isscalar (m)) |
4844 | 46 idx = [m, m]; |
3914 | 47 n = m; |
4844 | 48 elseif (isvector (m) && length (m) > 1) |
8390
49901b624316
optimize repmat for scalar & matrix case
Jaroslav Hajek <highegg@gmail.com>
parents:
7017
diff
changeset
|
49 ## Ensure that we have a row vector |
4844 | 50 idx = m(:).'; |
3914 | 51 else |
4844 | 52 error ("repmat: invalid dimensional argument"); |
3914 | 53 endif |
54 endif | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
55 |
8508
dee629f14bfa
repmat.m: handle negative dimensions properly
John W. Eaton <jwe@octave.org>
parents:
8507
diff
changeset
|
56 if (all (idx < 0)) |
dee629f14bfa
repmat.m: handle negative dimensions properly
John W. Eaton <jwe@octave.org>
parents:
8507
diff
changeset
|
57 error ("repmat: invalid dimensions"); |
dee629f14bfa
repmat.m: handle negative dimensions properly
John W. Eaton <jwe@octave.org>
parents:
8507
diff
changeset
|
58 else |
dee629f14bfa
repmat.m: handle negative dimensions properly
John W. Eaton <jwe@octave.org>
parents:
8507
diff
changeset
|
59 idx = max (idx, 0); |
dee629f14bfa
repmat.m: handle negative dimensions properly
John W. Eaton <jwe@octave.org>
parents:
8507
diff
changeset
|
60 endif |
3914 | 61 |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11318
diff
changeset
|
62 if (numel (A) == 1) |
8390
49901b624316
optimize repmat for scalar & matrix case
Jaroslav Hajek <highegg@gmail.com>
parents:
7017
diff
changeset
|
63 ## optimize the scalar fill case. |
11318
d7ea780b036f
repmat: handle special case of replicating scalar using index vector containing zeros
John W. Eaton <jwe@octave.org>
parents:
10801
diff
changeset
|
64 if (any (idx == 0)) |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11318
diff
changeset
|
65 x = resize (A, idx); |
11318
d7ea780b036f
repmat: handle special case of replicating scalar using index vector containing zeros
John W. Eaton <jwe@octave.org>
parents:
10801
diff
changeset
|
66 else |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11318
diff
changeset
|
67 x(1:prod (idx)) = A; |
11318
d7ea780b036f
repmat: handle special case of replicating scalar using index vector containing zeros
John W. Eaton <jwe@octave.org>
parents:
10801
diff
changeset
|
68 x = reshape (x, idx); |
d7ea780b036f
repmat: handle special case of replicating scalar using index vector containing zeros
John W. Eaton <jwe@octave.org>
parents:
10801
diff
changeset
|
69 endif |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11318
diff
changeset
|
70 elseif (ndims (A) == 2 && length (idx) < 3) |
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11318
diff
changeset
|
71 if (issparse (A)) |
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11318
diff
changeset
|
72 x = kron (ones (idx), A); |
4844 | 73 else |
8390
49901b624316
optimize repmat for scalar & matrix case
Jaroslav Hajek <highegg@gmail.com>
parents:
7017
diff
changeset
|
74 ## indexing is now faster, so we use it rather than kron. |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11318
diff
changeset
|
75 m = rows (A); n = columns (A); |
8390
49901b624316
optimize repmat for scalar & matrix case
Jaroslav Hajek <highegg@gmail.com>
parents:
7017
diff
changeset
|
76 p = idx(1); q = idx(2); |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11318
diff
changeset
|
77 x = reshape (A, m, 1, n, 1); |
8390
49901b624316
optimize repmat for scalar & matrix case
Jaroslav Hajek <highegg@gmail.com>
parents:
7017
diff
changeset
|
78 x = x(:, ones (1, p), :, ones (1, q)); |
49901b624316
optimize repmat for scalar & matrix case
Jaroslav Hajek <highegg@gmail.com>
parents:
7017
diff
changeset
|
79 x = reshape (x, m*p, n*q); |
4844 | 80 endif |
3914 | 81 else |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11318
diff
changeset
|
82 aidx = size (A); |
8970 | 83 ## ensure matching size |
84 idx(end+1:length (aidx)) = 1; | |
85 aidx(end+1:length (idx)) = 1; | |
86 ## create subscript array | |
87 cidx = cell (2, length (aidx)); | |
8507 | 88 for i = 1:length (aidx) |
8970 | 89 cidx{1,i} = ':'; |
90 cidx{2,i} = ones (1, idx (i)); | |
4844 | 91 endfor |
8970 | 92 aaidx = aidx; |
93 # add singleton dims | |
94 aaidx(2,:) = 1; | |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11318
diff
changeset
|
95 A = reshape (A, aaidx(:)); |
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11318
diff
changeset
|
96 x = reshape (A (cidx{:}), idx .* aidx); |
3914 | 97 endif |
98 | |
99 endfunction | |
6987 | 100 |
101 # Test various methods of providing size parameters | |
102 %!shared x | |
103 %! x = [1 2;3 4]; | |
104 %!assert(repmat(x, [1 1]), repmat(x, 1)); | |
105 %!assert(repmat(x, [3 3]), repmat(x, 3)); | |
106 %!assert(repmat(x, [1 1]), repmat(x, 1, 1)); | |
107 %!assert(repmat(x, [1 3]), repmat(x, 1, 3)); | |
108 %!assert(repmat(x, [3 1]), repmat(x, 3, 1)); | |
109 %!assert(repmat(x, [3 3]), repmat(x, 3, 3)); | |
110 | |
111 # Tests for numel==1 case: | |
112 %!shared x, r | |
113 %! x = [ 65 ]; | |
114 %! r = kron(ones(2,2), x); | |
115 %!assert(r, repmat(x, [2 2])); | |
116 %!assert(char(r), repmat(char(x), [2 2])); | |
117 %!assert(int8(r), repmat(int8(x), [2 2])); | |
118 | |
119 # Tests for ndims==2 case: | |
120 %!shared x, r | |
121 %! x = [ 65 66 67 ]; | |
122 %! r = kron(ones(2,2), x); | |
123 %!assert(r, repmat(x, [2 2])); | |
124 %!assert(char(r), repmat(char(x), [2 2])); | |
125 %!assert(int8(r), repmat(int8(x), [2 2])); | |
126 | |
127 # Tests for dim>2 case: | |
128 %!shared x, r | |
129 %! x = [ 65 66 67 ]; | |
130 %! r = kron(ones(2,2), x); | |
131 %! r(:,:,2) = r(:,:,1); | |
132 %!assert(r, repmat(x, [2 2 2])); | |
133 %!assert(char(r), repmat(char(x), [2 2 2])); | |
134 %!assert(int8(r), repmat(int8(x), [2 2 2])); | |
135 | |
136 # Test that sparsity is kept | |
137 %!assert(sparse(4,4), repmat(sparse(2,2),[2 2])); | |
138 | |
8508
dee629f14bfa
repmat.m: handle negative dimensions properly
John W. Eaton <jwe@octave.org>
parents:
8507
diff
changeset
|
139 |
dee629f14bfa
repmat.m: handle negative dimensions properly
John W. Eaton <jwe@octave.org>
parents:
8507
diff
changeset
|
140 %!assert (size (repmat (".", -1, 1)), [0, 1]); |
dee629f14bfa
repmat.m: handle negative dimensions properly
John W. Eaton <jwe@octave.org>
parents:
8507
diff
changeset
|
141 %!assert (size (repmat (".", 1, -1)), [1, 0]); |
dee629f14bfa
repmat.m: handle negative dimensions properly
John W. Eaton <jwe@octave.org>
parents:
8507
diff
changeset
|
142 %!error (size (repmat (".", -1, -1))); |
11318
d7ea780b036f
repmat: handle special case of replicating scalar using index vector containing zeros
John W. Eaton <jwe@octave.org>
parents:
10801
diff
changeset
|
143 |
d7ea780b036f
repmat: handle special case of replicating scalar using index vector containing zeros
John W. Eaton <jwe@octave.org>
parents:
10801
diff
changeset
|
144 %!assert (size (repmat (1, [1, 0])), [1, 0]); |
d7ea780b036f
repmat: handle special case of replicating scalar using index vector containing zeros
John W. Eaton <jwe@octave.org>
parents:
10801
diff
changeset
|
145 %!assert (size (repmat (1, [5, 0])), [5, 0]); |
d7ea780b036f
repmat: handle special case of replicating scalar using index vector containing zeros
John W. Eaton <jwe@octave.org>
parents:
10801
diff
changeset
|
146 %!assert (size (repmat (1, [0, 1])), [0, 1]); |
d7ea780b036f
repmat: handle special case of replicating scalar using index vector containing zeros
John W. Eaton <jwe@octave.org>
parents:
10801
diff
changeset
|
147 %!assert (size (repmat (1, [0, 5])), [0, 5]); |
d7ea780b036f
repmat: handle special case of replicating scalar using index vector containing zeros
John W. Eaton <jwe@octave.org>
parents:
10801
diff
changeset
|
148 |
d7ea780b036f
repmat: handle special case of replicating scalar using index vector containing zeros
John W. Eaton <jwe@octave.org>
parents:
10801
diff
changeset
|
149 %!shared x |
d7ea780b036f
repmat: handle special case of replicating scalar using index vector containing zeros
John W. Eaton <jwe@octave.org>
parents:
10801
diff
changeset
|
150 %! x = struct ("a", [], "b", []); |
d7ea780b036f
repmat: handle special case of replicating scalar using index vector containing zeros
John W. Eaton <jwe@octave.org>
parents:
10801
diff
changeset
|
151 %!assert (size (repmat (x, [1, 0])), [1, 0]); |
d7ea780b036f
repmat: handle special case of replicating scalar using index vector containing zeros
John W. Eaton <jwe@octave.org>
parents:
10801
diff
changeset
|
152 %!assert (size (repmat (x, [5, 0])), [5, 0]); |
d7ea780b036f
repmat: handle special case of replicating scalar using index vector containing zeros
John W. Eaton <jwe@octave.org>
parents:
10801
diff
changeset
|
153 %!assert (size (repmat (x, [0, 1])), [0, 1]); |
d7ea780b036f
repmat: handle special case of replicating scalar using index vector containing zeros
John W. Eaton <jwe@octave.org>
parents:
10801
diff
changeset
|
154 %!assert (size (repmat (x, [0, 5])), [0, 5]); |
d7ea780b036f
repmat: handle special case of replicating scalar using index vector containing zeros
John W. Eaton <jwe@octave.org>
parents:
10801
diff
changeset
|
155 |
d7ea780b036f
repmat: handle special case of replicating scalar using index vector containing zeros
John W. Eaton <jwe@octave.org>
parents:
10801
diff
changeset
|
156 %!assert (size (repmat ({1}, [1, 0])), [1, 0]); |
d7ea780b036f
repmat: handle special case of replicating scalar using index vector containing zeros
John W. Eaton <jwe@octave.org>
parents:
10801
diff
changeset
|
157 %!assert (size (repmat ({1}, [5, 0])), [5, 0]); |
d7ea780b036f
repmat: handle special case of replicating scalar using index vector containing zeros
John W. Eaton <jwe@octave.org>
parents:
10801
diff
changeset
|
158 %!assert (size (repmat ({1}, [0, 1])), [0, 1]); |
d7ea780b036f
repmat: handle special case of replicating scalar using index vector containing zeros
John W. Eaton <jwe@octave.org>
parents:
10801
diff
changeset
|
159 %!assert (size (repmat ({1}, [0, 5])), [0, 5]); |
d7ea780b036f
repmat: handle special case of replicating scalar using index vector containing zeros
John W. Eaton <jwe@octave.org>
parents:
10801
diff
changeset
|
160 |