annotate scripts/general/repmat.m @ 20158:7503499a252b stable

doc: Update docstrings to have one sentence summary as first line. Update scripts in audio, elfun, general, geometry, and image directories. * scripts/audio/@audioplayer/__get_properties__.m, scripts/audio/@audioplayer/audioplayer.m, scripts/audio/@audioplayer/get.m, scripts/audio/@audioplayer/isplaying.m, scripts/audio/@audioplayer/play.m, scripts/audio/@audioplayer/playblocking.m, scripts/audio/@audioplayer/set.m, scripts/audio/@audioplayer/subsasgn.m, scripts/audio/@audioplayer/subsref.m, scripts/audio/@audiorecorder/audiorecorder.m, scripts/audio/@audiorecorder/get.m, scripts/audio/@audiorecorder/getaudiodata.m, scripts/audio/@audiorecorder/getplayer.m, scripts/audio/@audiorecorder/isrecording.m, scripts/audio/@audiorecorder/play.m, scripts/audio/@audiorecorder/record.m, scripts/audio/@audiorecorder/recordblocking.m, scripts/audio/@audiorecorder/set.m, scripts/audio/@audiorecorder/stop.m, scripts/audio/@audiorecorder/subsasgn.m, scripts/audio/@audiorecorder/subsref.m, scripts/audio/lin2mu.m, scripts/audio/mu2lin.m, scripts/audio/record.m, scripts/audio/sound.m, scripts/audio/soundsc.m, scripts/audio/wavread.m, scripts/audio/wavwrite.m, scripts/elfun/cosd.m, scripts/elfun/sind.m, scripts/elfun/tand.m, scripts/general/accumarray.m, scripts/general/accumdim.m, scripts/general/bitcmp.m, scripts/general/bitget.m, scripts/general/bitset.m, scripts/general/blkdiag.m, scripts/general/cart2pol.m, scripts/general/cart2sph.m, scripts/general/cell2mat.m, scripts/general/celldisp.m, scripts/general/chop.m, scripts/general/circshift.m, scripts/general/common_size.m, scripts/general/cplxpair.m, scripts/general/cumtrapz.m, scripts/general/dblquad.m, scripts/general/deal.m, scripts/general/del2.m, scripts/general/display.m, scripts/general/divergence.m, scripts/general/fieldnames.m, scripts/general/flip.m, scripts/general/flipdim.m, scripts/general/fliplr.m, scripts/general/flipud.m, scripts/general/gradient.m, scripts/general/interp3.m, scripts/general/interpft.m, scripts/general/interpn.m, scripts/general/loadobj.m, scripts/general/logspace.m, scripts/general/methods.m, scripts/general/nargchk.m, scripts/general/narginchk.m, scripts/general/nargoutchk.m, scripts/general/nextpow2.m, scripts/general/nthargout.m, scripts/general/num2str.m, scripts/general/pol2cart.m, scripts/general/polyarea.m, scripts/general/postpad.m, scripts/general/prepad.m, scripts/general/profile.m, scripts/general/quadgk.m, scripts/general/quadl.m, scripts/general/quadv.m, scripts/general/randi.m, scripts/general/rat.m, scripts/general/repmat.m, scripts/general/rot90.m, scripts/general/rotdim.m, scripts/general/saveobj.m, scripts/general/shift.m, scripts/general/shiftdim.m, scripts/general/sortrows.m, scripts/general/sph2cart.m, scripts/general/structfun.m, scripts/general/subsindex.m, scripts/general/trapz.m, scripts/general/triplequad.m, scripts/geometry/delaunayn.m, scripts/geometry/dsearch.m, scripts/geometry/dsearchn.m, scripts/geometry/griddata.m, scripts/geometry/griddata3.m, scripts/geometry/griddatan.m, scripts/geometry/inpolygon.m, scripts/geometry/rectint.m, scripts/geometry/tsearchn.m, scripts/geometry/voronoi.m, scripts/geometry/voronoin.m, scripts/help/__unimplemented__.m, scripts/help/doc.m, scripts/help/doc_cache_create.m, scripts/help/get_first_help_sentence.m, scripts/help/help.m, scripts/help/lookfor.m, scripts/help/print_usage.m, scripts/help/type.m, scripts/help/which.m, scripts/image/autumn.m, scripts/image/bone.m, scripts/image/brighten.m, scripts/image/cmpermute.m, scripts/image/colorcube.m, scripts/image/contrast.m, scripts/image/cool.m, scripts/image/copper.m, scripts/image/cubehelix.m, scripts/image/flag.m, scripts/image/gmap40.m, scripts/image/gray.m, scripts/image/gray2ind.m, scripts/image/hot.m, scripts/image/hsv.m, scripts/image/image.m, scripts/image/imagesc.m, scripts/image/imfinfo.m, scripts/image/imformats.m, scripts/image/imread.m, scripts/image/imshow.m, scripts/image/imwrite.m, scripts/image/iscolormap.m, scripts/image/jet.m, scripts/image/lines.m, scripts/image/ntsc2rgb.m, scripts/image/ocean.m, scripts/image/pink.m, scripts/image/prism.m, scripts/image/rainbow.m, scripts/image/rgb2ntsc.m, scripts/image/spinmap.m, scripts/image/spring.m, scripts/image/summer.m, scripts/image/white.m, scripts/image/winter.m: Update docstrings to have one sentence summary as first line. Re-structure to have line lengths <= 80 chars.
author Rik <rik@octave.org>
date Sun, 03 May 2015 09:36:20 -0700
parents 9fc020886ae9
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19697
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19115
diff changeset
1 ## Copyright (C) 2014-2015 Markus Bergholz
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19115
diff changeset
2 ## Copyright (C) 2000-2015 Paul Kienzle
8390
49901b624316 optimize repmat for scalar & matrix case
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
3 ## Copyright (C) 2008 Jaroslav Hajek
3914
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
4 ##
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
5 ## This file is part of Octave.
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
6 ##
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
7 ## 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
8 ## 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
9 ## 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
10 ## your option) any later version.
3914
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
11 ##
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
12 ## 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
13 ## WITHOUT ANY WARRANTY; without even the implied warranty of
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
14 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
15 ## General Public License for more details.
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
16 ##
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
17 ## 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
18 ## 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
19 ## <http://www.gnu.org/licenses/>.
3914
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
20
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
21 ## -*- texinfo -*-
12639
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
22 ## @deftypefn {Function File} {} repmat (@var{A}, @var{m})
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
23 ## @deftypefnx {Function File} {} repmat (@var{A}, @var{m}, @var{n})
19114
c53401edf4e3 make repmat do accept more than 3 arguments (bug #38391)
Markus Bergholz <markuman+octave@gmail.com>
parents: 17744
diff changeset
24 ## @deftypefnx {Function File} {} repmat (@var{A}, @var{m}, @var{n}, @var{p} @dots{})
3914
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
25 ## @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
26 ## @deftypefnx {Function File} {} repmat (@var{A}, [@var{m} @var{n} @var{p} @dots{}])
3914
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
27 ## Form a block matrix of size @var{m} by @var{n}, with a copy of matrix
20158
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
28 ## @var{A} as each element.
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
29 ##
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
30 ## If @var{n} is not specified, form an @var{m} by @var{m} block matrix. For
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
31 ## copying along more than two dimensions, specify the number of times to copy
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
32 ## across each dimension @var{m}, @var{n}, @var{p}, @dots{}, in a vector in the
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
33 ## second argument.
10801
a40e32927b3a Improve documentation for new repelems function.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
34 ## @seealso{repelems}
3914
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
35 ## @end deftypefn
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
36
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
37 ## Author: Paul Kienzle <pkienzle@kienzle.powernet.co.uk>
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
38 ## Created: July 2000
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
39
19114
c53401edf4e3 make repmat do accept more than 3 arguments (bug #38391)
Markus Bergholz <markuman+octave@gmail.com>
parents: 17744
diff changeset
40 function x = repmat (A, m, varargin)
3915
2f341412622f [project @ 2002-04-30 02:41:04 by jwe]
jwe
parents: 3914
diff changeset
41
19114
c53401edf4e3 make repmat do accept more than 3 arguments (bug #38391)
Markus Bergholz <markuman+octave@gmail.com>
parents: 17744
diff changeset
42 if (nargin < 2)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5443
diff changeset
43 print_usage ();
3914
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
44 endif
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
45
4844
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4030
diff changeset
46 if (nargin == 3)
19114
c53401edf4e3 make repmat do accept more than 3 arguments (bug #38391)
Markus Bergholz <markuman+octave@gmail.com>
parents: 17744
diff changeset
47 n = varargin{1};
15436
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
48 if (! isempty (m) && isempty (n))
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
49 m = m(:).';
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
50 n = 1;
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
51 elseif (isempty (m) && ! isempty (n))
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
52 m = n(:).';
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
53 n = 1;
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
54 elseif (isempty (m) && isempty (n))
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
55 m = n = 1;
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
56 else
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
57 if (all (size (m) > 1))
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
58 m = m(:,1);
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
59 if (numel (m) < 3)
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
60 n = n(end);
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
61 else
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
62 n = [];
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
63 endif
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
64 endif
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
65 if (all (size (n) > 1))
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
66 n = n(:,1);
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
67 endif
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
68 m = m(:).';
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
69 n = n(:).';
4844
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4030
diff changeset
70 endif
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
71 else
19115
3132cd3d6625 repmat.m: Use Octave coding conventions in cset c53401edf4e3.
Rik <rik@octave.org>
parents: 19114
diff changeset
72 if (nargin > 3)
19833
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
73 ## input check for m and varargin
19115
3132cd3d6625 repmat.m: Use Octave coding conventions in cset c53401edf4e3.
Rik <rik@octave.org>
parents: 19114
diff changeset
74 if (isscalar (m) && all (cellfun ("numel", varargin) == 1))
19114
c53401edf4e3 make repmat do accept more than 3 arguments (bug #38391)
Markus Bergholz <markuman+octave@gmail.com>
parents: 17744
diff changeset
75 m = [m varargin{:}];
c53401edf4e3 make repmat do accept more than 3 arguments (bug #38391)
Markus Bergholz <markuman+octave@gmail.com>
parents: 17744
diff changeset
76 n = [];
c53401edf4e3 make repmat do accept more than 3 arguments (bug #38391)
Markus Bergholz <markuman+octave@gmail.com>
parents: 17744
diff changeset
77 else
19115
3132cd3d6625 repmat.m: Use Octave coding conventions in cset c53401edf4e3.
Rik <rik@octave.org>
parents: 19114
diff changeset
78 error ("repmat: all input arguments must be scalar");
19114
c53401edf4e3 make repmat do accept more than 3 arguments (bug #38391)
Markus Bergholz <markuman+octave@gmail.com>
parents: 17744
diff changeset
79 end
c53401edf4e3 make repmat do accept more than 3 arguments (bug #38391)
Markus Bergholz <markuman+octave@gmail.com>
parents: 17744
diff changeset
80 elseif (isempty (m))
15436
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
81 m = n = 1;
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
82 elseif (isscalar (m))
3914
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
83 n = m;
15436
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
84 elseif (ndims (m) > 2)
19115
3132cd3d6625 repmat.m: Use Octave coding conventions in cset c53401edf4e3.
Rik <rik@octave.org>
parents: 19114
diff changeset
85 error ("repmat: M has more than 2 dimensions");
15436
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
86 elseif (all (size (m) > 1))
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
87 m = m(:,1).';
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
88 n = [];
3914
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
89 else
15436
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
90 m = m(:).';
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
91 n = [];
3914
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
92 endif
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
93 endif
15436
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
94 idx = [m, n];
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
95
8508
dee629f14bfa repmat.m: handle negative dimensions properly
John W. Eaton <jwe@octave.org>
parents: 8507
diff changeset
96 if (all (idx < 0))
19115
3132cd3d6625 repmat.m: Use Octave coding conventions in cset c53401edf4e3.
Rik <rik@octave.org>
parents: 19114
diff changeset
97 error ("repmat: invalid dimensions");
8508
dee629f14bfa repmat.m: handle negative dimensions properly
John W. Eaton <jwe@octave.org>
parents: 8507
diff changeset
98 else
dee629f14bfa repmat.m: handle negative dimensions properly
John W. Eaton <jwe@octave.org>
parents: 8507
diff changeset
99 idx = max (idx, 0);
dee629f14bfa repmat.m: handle negative dimensions properly
John W. Eaton <jwe@octave.org>
parents: 8507
diff changeset
100 endif
3914
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
101
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11318
diff changeset
102 if (numel (A) == 1)
8390
49901b624316 optimize repmat for scalar & matrix case
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
103 ## 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
104 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
105 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
106 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
107 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
108 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
109 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
110 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
111 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
112 x = kron (ones (idx), A);
4844
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4030
diff changeset
113 else
8390
49901b624316 optimize repmat for scalar & matrix case
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
114 ## 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
115 m = rows (A); n = columns (A);
8390
49901b624316 optimize repmat for scalar & matrix case
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
116 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
117 x = reshape (A, m, 1, n, 1);
8390
49901b624316 optimize repmat for scalar & matrix case
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
118 x = x(:, ones (1, p), :, ones (1, q));
49901b624316 optimize repmat for scalar & matrix case
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
119 x = reshape (x, m*p, n*q);
4844
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4030
diff changeset
120 endif
3914
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
121 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
122 aidx = size (A);
8970
b37a6c27c23f simplify repmat
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
123 ## ensure matching size
b37a6c27c23f simplify repmat
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
124 idx(end+1:length (aidx)) = 1;
b37a6c27c23f simplify repmat
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
125 aidx(end+1:length (idx)) = 1;
b37a6c27c23f simplify repmat
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
126 ## create subscript array
b37a6c27c23f simplify repmat
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
127 cidx = cell (2, length (aidx));
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8390
diff changeset
128 for i = 1:length (aidx)
8970
b37a6c27c23f simplify repmat
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
129 cidx{1,i} = ':';
b37a6c27c23f simplify repmat
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
130 cidx{2,i} = ones (1, idx (i));
4844
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4030
diff changeset
131 endfor
8970
b37a6c27c23f simplify repmat
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
132 aaidx = aidx;
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 15436
diff changeset
133 ## add singleton dims
8970
b37a6c27c23f simplify repmat
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
134 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
135 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
136 x = reshape (A (cidx{:}), idx .* aidx);
3914
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
137 endif
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
138
9eb96199e0f1 [project @ 2002-04-30 02:40:04 by jwe]
jwe
parents:
diff changeset
139 endfunction
6987
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
140
17338
1c89599167a6 maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents: 17336
diff changeset
141
19833
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
142 ## Tests for ML compatibility
15436
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
143 %!shared x
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
144 %! x = [1 2 3];
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
145 %!assert (repmat (x, [3, 1]), repmat (x, 3, []))
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
146 %!assert (repmat (x, [3, 1]), repmat (x, [], 3))
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
147 %!assert (repmat (x, [1, 3]), repmat (x, [], [1, 3]))
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
148 %!assert (repmat (x, [1, 3]), repmat (x, [1, 3], []))
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
149 %!assert (repmat (x, [1 3]), repmat (x, [1 3; 3 3]))
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
150 %!assert (repmat (x, [1 1 2]), repmat (x, [1 1; 1 3; 2 1]))
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
151 %!assert (repmat (x, [1 3; 1 3], [1; 3]), repmat (x, [1 1 3]))
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
152 %!assert (repmat (x, [1 1], 4), repmat (x, [1 3; 1 3], [1; 4]))
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
153 %!assert (repmat (x, [1 1], 4), repmat (x, [1 3; 1 3], [1 2; 3 4]))
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
154 %!assert (repmat (x, [1 1], 4), repmat (x, [1 1 4]));
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
155 %!assert (repmat (x, [1 1], 4), repmat (x, 1, [1 4]));
32fd31378052 Additional changes to repmat.m (e1f59fd57756).
Ben Abbott <bpabbott@mac.com>
parents: 15434
diff changeset
156
19833
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
157 ## Test various methods of providing size parameters
6987
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
158 %!shared x
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
159 %! x = [1 2;3 4];
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
160 %!assert (repmat (x, [1 1]), repmat (x, 1))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
161 %!assert (repmat (x, [3 3]), repmat (x, 3))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
162 %!assert (repmat (x, [1 1]), repmat (x, 1, 1))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
163 %!assert (repmat (x, [1 3]), repmat (x, 1, 3))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
164 %!assert (repmat (x, [3 1]), repmat (x, 3, 1))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
165 %!assert (repmat (x, [3 3]), repmat (x, 3, 3))
19115
3132cd3d6625 repmat.m: Use Octave coding conventions in cset c53401edf4e3.
Rik <rik@octave.org>
parents: 19114
diff changeset
166 %!assert (repmat (pi, [1,2,3,4]), repmat (pi, 1,2,3,4))
6987
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
167
19833
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
168 ## Tests for numel==1 case:
6987
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
169 %!shared x, r
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
170 %! x = [ 65 ];
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
171 %! r = kron (ones (2,2), x);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
172 %!assert (r, repmat (x, [2 2]))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
173 %!assert (char (r), repmat (char (x), [2 2]))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
174 %!assert (int8 (r), repmat (int8 (x), [2 2]))
6987
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
175
19833
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
176 ## Tests for ndims==2 case:
6987
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
177 %!shared x, r
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
178 %! x = [ 65 66 67 ];
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
179 %! r = kron (ones (2,2), x);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
180 %!assert (r, repmat (x, [2 2]))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
181 %!assert (char (r), repmat (char (x), [2 2]))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
182 %!assert (int8 (r), repmat (int8 (x), [2 2]))
6987
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
183
19833
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
184 ## Tests for dim>2 case:
6987
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
185 %!shared x, r
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
186 %! x = [ 65 66 67 ];
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
187 %! r = kron (ones (2,2), x);
6987
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
188 %! r(:,:,2) = r(:,:,1);
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
189 %!assert (r, repmat (x, [2 2 2]))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
190 %!assert (char (r), repmat (char (x), [2 2 2]))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
191 %!assert (int8 (r), repmat (int8 (x), [2 2 2]))
6987
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
192
19833
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
193 ## Test that sparsity is kept
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
194 %!assert (sparse (4,4), repmat (sparse (2,2),[2 2]))
6987
deb175b6e4a1 [project @ 2007-10-09 18:39:15 by jwe]
jwe
parents: 6046
diff changeset
195
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
196 %!assert (size (repmat (".", -1, 1)), [0, 1])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
197 %!assert (size (repmat (".", 1, -1)), [1, 0])
8508
dee629f14bfa repmat.m: handle negative dimensions properly
John W. Eaton <jwe@octave.org>
parents: 8507
diff changeset
198
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
199 %!assert (size (repmat (1, [1, 0])), [1, 0])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
200 %!assert (size (repmat (1, [5, 0])), [5, 0])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
201 %!assert (size (repmat (1, [0, 1])), [0, 1])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
202 %!assert (size (repmat (1, [0, 5])), [0, 5])
11318
d7ea780b036f repmat: handle special case of replicating scalar using index vector containing zeros
John W. Eaton <jwe@octave.org>
parents: 10801
diff changeset
203
d7ea780b036f repmat: handle special case of replicating scalar using index vector containing zeros
John W. Eaton <jwe@octave.org>
parents: 10801
diff changeset
204 %!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
205 %! x = struct ("a", [], "b", []);
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
206 %!assert (size (repmat (x, [1, 0])), [1, 0])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
207 %!assert (size (repmat (x, [5, 0])), [5, 0])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
208 %!assert (size (repmat (x, [0, 1])), [0, 1])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
209 %!assert (size (repmat (x, [0, 5])), [0, 5])
11318
d7ea780b036f repmat: handle special case of replicating scalar using index vector containing zeros
John W. Eaton <jwe@octave.org>
parents: 10801
diff changeset
210
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
211 %!assert (size (repmat ({1}, [1, 0])), [1, 0])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
212 %!assert (size (repmat ({1}, [5, 0])), [5, 0])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
213 %!assert (size (repmat ({1}, [0, 1])), [0, 1])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
214 %!assert (size (repmat ({1}, [0, 5])), [0, 5])
11318
d7ea780b036f repmat: handle special case of replicating scalar using index vector containing zeros
John W. Eaton <jwe@octave.org>
parents: 10801
diff changeset
215
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
216 %!error (size (repmat (".", -1, -1)))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14241
diff changeset
217