Mercurial > octave-antonio
view 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 |
line wrap: on
line source
## Copyright (C) 2014-2015 Markus Bergholz ## Copyright (C) 2000-2015 Paul Kienzle ## Copyright (C) 2008 Jaroslav Hajek ## ## This file is part of Octave. ## ## Octave is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 3 of the License, or (at ## your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ## General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {} repmat (@var{A}, @var{m}) ## @deftypefnx {Function File} {} repmat (@var{A}, @var{m}, @var{n}) ## @deftypefnx {Function File} {} repmat (@var{A}, @var{m}, @var{n}, @var{p} @dots{}) ## @deftypefnx {Function File} {} repmat (@var{A}, [@var{m} @var{n}]) ## @deftypefnx {Function File} {} repmat (@var{A}, [@var{m} @var{n} @var{p} @dots{}]) ## Form a block matrix of size @var{m} by @var{n}, with a copy of matrix ## @var{A} as each element. ## ## If @var{n} is not specified, form an @var{m} by @var{m} block matrix. For ## copying along more than two dimensions, specify the number of times to copy ## across each dimension @var{m}, @var{n}, @var{p}, @dots{}, in a vector in the ## second argument. ## @seealso{repelems} ## @end deftypefn ## Author: Paul Kienzle <pkienzle@kienzle.powernet.co.uk> ## Created: July 2000 function x = repmat (A, m, varargin) if (nargin < 2) print_usage (); endif if (nargin == 3) n = varargin{1}; if (! isempty (m) && isempty (n)) m = m(:).'; n = 1; elseif (isempty (m) && ! isempty (n)) m = n(:).'; n = 1; elseif (isempty (m) && isempty (n)) m = n = 1; else if (all (size (m) > 1)) m = m(:,1); if (numel (m) < 3) n = n(end); else n = []; endif endif if (all (size (n) > 1)) n = n(:,1); endif m = m(:).'; n = n(:).'; endif else if (nargin > 3) ## input check for m and varargin if (isscalar (m) && all (cellfun ("numel", varargin) == 1)) m = [m varargin{:}]; n = []; else error ("repmat: all input arguments must be scalar"); end elseif (isempty (m)) m = n = 1; elseif (isscalar (m)) n = m; elseif (ndims (m) > 2) error ("repmat: M has more than 2 dimensions"); elseif (all (size (m) > 1)) m = m(:,1).'; n = []; else m = m(:).'; n = []; endif endif idx = [m, n]; if (all (idx < 0)) error ("repmat: invalid dimensions"); else idx = max (idx, 0); endif if (numel (A) == 1) ## optimize the scalar fill case. if (any (idx == 0)) x = resize (A, idx); else x(1:prod (idx)) = A; x = reshape (x, idx); endif elseif (ndims (A) == 2 && length (idx) < 3) if (issparse (A)) x = kron (ones (idx), A); else ## indexing is now faster, so we use it rather than kron. m = rows (A); n = columns (A); p = idx(1); q = idx(2); x = reshape (A, m, 1, n, 1); x = x(:, ones (1, p), :, ones (1, q)); x = reshape (x, m*p, n*q); endif else aidx = size (A); ## ensure matching size idx(end+1:length (aidx)) = 1; aidx(end+1:length (idx)) = 1; ## create subscript array cidx = cell (2, length (aidx)); for i = 1:length (aidx) cidx{1,i} = ':'; cidx{2,i} = ones (1, idx (i)); endfor aaidx = aidx; ## add singleton dims aaidx(2,:) = 1; A = reshape (A, aaidx(:)); x = reshape (A (cidx{:}), idx .* aidx); endif endfunction ## Tests for ML compatibility %!shared x %! x = [1 2 3]; %!assert (repmat (x, [3, 1]), repmat (x, 3, [])) %!assert (repmat (x, [3, 1]), repmat (x, [], 3)) %!assert (repmat (x, [1, 3]), repmat (x, [], [1, 3])) %!assert (repmat (x, [1, 3]), repmat (x, [1, 3], [])) %!assert (repmat (x, [1 3]), repmat (x, [1 3; 3 3])) %!assert (repmat (x, [1 1 2]), repmat (x, [1 1; 1 3; 2 1])) %!assert (repmat (x, [1 3; 1 3], [1; 3]), repmat (x, [1 1 3])) %!assert (repmat (x, [1 1], 4), repmat (x, [1 3; 1 3], [1; 4])) %!assert (repmat (x, [1 1], 4), repmat (x, [1 3; 1 3], [1 2; 3 4])) %!assert (repmat (x, [1 1], 4), repmat (x, [1 1 4])); %!assert (repmat (x, [1 1], 4), repmat (x, 1, [1 4])); ## Test various methods of providing size parameters %!shared x %! x = [1 2;3 4]; %!assert (repmat (x, [1 1]), repmat (x, 1)) %!assert (repmat (x, [3 3]), repmat (x, 3)) %!assert (repmat (x, [1 1]), repmat (x, 1, 1)) %!assert (repmat (x, [1 3]), repmat (x, 1, 3)) %!assert (repmat (x, [3 1]), repmat (x, 3, 1)) %!assert (repmat (x, [3 3]), repmat (x, 3, 3)) %!assert (repmat (pi, [1,2,3,4]), repmat (pi, 1,2,3,4)) ## Tests for numel==1 case: %!shared x, r %! x = [ 65 ]; %! r = kron (ones (2,2), x); %!assert (r, repmat (x, [2 2])) %!assert (char (r), repmat (char (x), [2 2])) %!assert (int8 (r), repmat (int8 (x), [2 2])) ## Tests for ndims==2 case: %!shared x, r %! x = [ 65 66 67 ]; %! r = kron (ones (2,2), x); %!assert (r, repmat (x, [2 2])) %!assert (char (r), repmat (char (x), [2 2])) %!assert (int8 (r), repmat (int8 (x), [2 2])) ## Tests for dim>2 case: %!shared x, r %! x = [ 65 66 67 ]; %! r = kron (ones (2,2), x); %! r(:,:,2) = r(:,:,1); %!assert (r, repmat (x, [2 2 2])) %!assert (char (r), repmat (char (x), [2 2 2])) %!assert (int8 (r), repmat (int8 (x), [2 2 2])) ## Test that sparsity is kept %!assert (sparse (4,4), repmat (sparse (2,2),[2 2])) %!assert (size (repmat (".", -1, 1)), [0, 1]) %!assert (size (repmat (".", 1, -1)), [1, 0]) %!assert (size (repmat (1, [1, 0])), [1, 0]) %!assert (size (repmat (1, [5, 0])), [5, 0]) %!assert (size (repmat (1, [0, 1])), [0, 1]) %!assert (size (repmat (1, [0, 5])), [0, 5]) %!shared x %! x = struct ("a", [], "b", []); %!assert (size (repmat (x, [1, 0])), [1, 0]) %!assert (size (repmat (x, [5, 0])), [5, 0]) %!assert (size (repmat (x, [0, 1])), [0, 1]) %!assert (size (repmat (x, [0, 5])), [0, 5]) %!assert (size (repmat ({1}, [1, 0])), [1, 0]) %!assert (size (repmat ({1}, [5, 0])), [5, 0]) %!assert (size (repmat ({1}, [0, 1])), [0, 1]) %!assert (size (repmat ({1}, [0, 5])), [0, 5]) %!error (size (repmat (".", -1, -1)))