Mercurial > octave
view scripts/general/repmat.m @ 30875:5d3faba0342e
doc: Ensure documentation lists output argument when it exists for all m-files.
For new users of Octave it is best to show explicit calling forms
in the documentation and to show a return argument when it exists.
* bp-table.cc, shift.m, accumarray.m, accumdim.m, bincoeff.m, bitcmp.m,
bitget.m, bitset.m, blkdiag.m, celldisp.m, cplxpair.m, dblquad.m, flip.m,
fliplr.m, flipud.m, idivide.m, int2str.m, interpft.m, logspace.m, num2str.m,
polyarea.m, postpad.m, prepad.m, randi.m, repmat.m, rng.m, rot90.m, rotdim.m,
structfun.m, triplequad.m, uibuttongroup.m, uicontrol.m, uipanel.m,
uipushtool.m, uitoggletool.m, uitoolbar.m, waitforbuttonpress.m, help.m,
__additional_help_message__.m, hsv.m, im2double.m, im2frame.m, javachk.m,
usejava.m, argnames.m, char.m, formula.m, inline.m, __vectorize__.m, findstr.m,
flipdim.m, strmatch.m, vectorize.m, commutation_matrix.m, cond.m, cross.m,
duplication_matrix.m, expm.m, orth.m, rank.m, rref.m, trace.m, vech.m, cast.m,
compare_versions.m, delete.m, dir.m, fileattrib.m, grabcode.m, gunzip.m,
inputname.m, license.m, list_primes.m, ls.m, mexext.m, movefile.m,
namelengthmax.m, nargoutchk.m, nthargout.m, substruct.m, swapbytes.m, ver.m,
verLessThan.m, what.m, fminunc.m, fsolve.m, fzero.m, optimget.m, __fdjac__.m,
matlabroot.m, savepath.m, campos.m, camroll.m, camtarget.m, camup.m, camva.m,
camzoom.m, clabel.m, diffuse.m, legend.m, orient.m, rticks.m, specular.m,
thetaticks.m, xlim.m, xtickangle.m, xticklabels.m, xticks.m, ylim.m,
ytickangle.m, yticklabels.m, yticks.m, zlim.m, ztickangle.m, zticklabels.m,
zticks.m, ellipsoid.m, isocolors.m, isonormals.m, stairs.m, surfnorm.m,
__actual_axis_position__.m, __pltopt__.m, close.m, graphics_toolkit.m, pan.m,
print.m, printd.m, __ghostscript__.m, __gnuplot_print__.m, __opengl_print__.m,
rotate3d.m, subplot.m, zoom.m, compan.m, conv.m, poly.m, polyaffine.m,
polyder.m, polyint.m, polyout.m, polyreduce.m, polyvalm.m, roots.m, prefdir.m,
prefsfile.m, profexplore.m, profexport.m, profshow.m, powerset.m, unique.m,
arch_rnd.m, arma_rnd.m, autoreg_matrix.m, bartlett.m, blackman.m, detrend.m,
durbinlevinson.m, fftconv.m, fftfilt.m, fftshift.m, fractdiff.m, hamming.m,
hanning.m, hurst.m, ifftshift.m, rectangle_lw.m, rectangle_sw.m, triangle_lw.m,
sinc.m, sinetone.m, sinewave.m, spectral_adf.m, spectral_xdf.m, spencer.m,
ilu.m, __sprand__.m, sprand.m, sprandn.m, sprandsym.m, treelayout.m, beta.m,
betainc.m, betaincinv.m, betaln.m, cosint.m, expint.m, factorial.m, gammainc.m,
gammaincinv.m, lcm.m, nthroot.m, perms.m, reallog.m, realpow.m, realsqrt.m,
sinint.m, hadamard.m, hankel.m, hilb.m, invhilb.m, magic.m, pascal.m, rosser.m,
toeplitz.m, vander.m, wilkinson.m, center.m, corr.m, cov.m, discrete_cdf.m,
discrete_inv.m, discrete_pdf.m, discrete_rnd.m, empirical_cdf.m,
empirical_inv.m, empirical_pdf.m, empirical_rnd.m, kendall.m, kurtosis.m,
mad.m, mean.m, meansq.m, median.m, mode.m, moment.m, range.m, ranks.m,
run_count.m, skewness.m, spearman.m, statistics.m, std.m, base2dec.m,
bin2dec.m, blanks.m, cstrcat.m, deblank.m, dec2base.m, dec2bin.m, dec2hex.m,
hex2dec.m, index.m, regexptranslate.m, rindex.m, strcat.m, strjust.m,
strtrim.m, strtrunc.m, substr.m, untabify.m, __have_feature__.m,
__prog_output_assert__.m, __run_test_suite__.m, example.m, fail.m, asctime.m,
calendar.m, ctime.m, date.m, etime.m:
Add return arguments to @deftypefn macros where they were missing. Rename
variables in functions (particularly generic "retval") to match documentation.
Rename some return variables for (hopefully) better clarity (e.g., 'ax' to 'hax'
to indicate it is a graphics handle to an axes object).
author | Rik <rik@octave.org> |
---|---|
date | Wed, 30 Mar 2022 20:40:27 -0700 |
parents | 796f54d4ddbf |
children | 597f3ee61a48 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2000-2022 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## 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 ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {@var{B} =} repmat (@var{A}, @var{m}) ## @deftypefnx {} {@var{B} =} repmat (@var{A}, @var{m}, @var{n}) ## @deftypefnx {} {@var{B} =} repmat (@var{A}, @var{m}, @var{n}, @var{p} @dots{}) ## @deftypefnx {} {@var{B} =} repmat (@var{A}, [@var{m} @var{n}]) ## @deftypefnx {} {@var{B} =} repmat (@var{A}, [@var{m} @var{n} @var{p} @dots{}]) ## Repeat matrix or N-D array. ## ## 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{bsxfun, kron, repelems} ## @end deftypefn function B = 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"); endif 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)) B = resize (A, idx); else B(1:prod (idx)) = A; B = reshape (B, idx); endif elseif (ndims (A) == 2 && length (idx) < 3) if (issparse (A)) B = 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); B = reshape (A, m, 1, n, 1); B = B(:, ones (1, p), :, ones (1, q)); B = reshape (B, 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(:)); B = 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]) %!assert (size (repmat (ones (0, 3), [2 3])), [0 9]) %!assert (size (repmat (ones (0, 0, 3), [2 3])), [0 0 3]) %!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))