Mercurial > octave
annotate scripts/deprecated/shift.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 | 397d29f7135c |
children | 597f3ee61a48 |
rev | line source |
---|---|
27923
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
1 ######################################################################## |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
2 ## |
30564
796f54d4ddbf
update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents:
29359
diff
changeset
|
3 ## Copyright (C) 1995-2022 The Octave Project Developers |
27918
b442ec6dda5c
use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
4 ## |
27923
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
5 ## See the file COPYRIGHT.md in the top-level directory of this |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
6 ## distribution or <https://octave.org/copyright/>. |
3426 | 7 ## |
3922 | 8 ## This file is part of Octave. |
9 ## | |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
10 ## Octave is free software: you can redistribute it and/or modify it |
3922 | 11 ## under the terms of the GNU General Public License as published by |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
12 ## the Free Software Foundation, either version 3 of the License, or |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
13 ## (at your option) any later version. |
3426 | 14 ## |
3922 | 15 ## Octave is distributed in the hope that it will be useful, but |
2539 | 16 ## WITHOUT ANY WARRANTY; without even the implied warranty of |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
18 ## GNU General Public License for more details. |
3426 | 19 ## |
2539 | 20 ## You should have received a copy of the GNU General Public License |
7016 | 21 ## along with Octave; see the file COPYING. If not, see |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
22 ## <https://www.gnu.org/licenses/>. |
27923
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
23 ## |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
24 ######################################################################## |
2539 | 25 |
3369 | 26 ## -*- texinfo -*- |
30875
5d3faba0342e
doc: Ensure documentation lists output argument when it exists for all m-files.
Rik <rik@octave.org>
parents:
30603
diff
changeset
|
27 ## @deftypefn {} {@var{y} =} shift (@var{x}, @var{b}) |
5d3faba0342e
doc: Ensure documentation lists output argument when it exists for all m-files.
Rik <rik@octave.org>
parents:
30603
diff
changeset
|
28 ## @deftypefnx {} {@var{y} =} shift (@var{x}, @var{b}, @var{dim}) |
30603
397d29f7135c
shift.m: Deprecate function in favor of circshift for Matlab compatibility.
Rik <rik@octave.org>
parents:
30564
diff
changeset
|
29 ## |
397d29f7135c
shift.m: Deprecate function in favor of circshift for Matlab compatibility.
Rik <rik@octave.org>
parents:
30564
diff
changeset
|
30 ## @code{shift} is deprecated and will be removed in Octave version 10. Use |
397d29f7135c
shift.m: Deprecate function in favor of circshift for Matlab compatibility.
Rik <rik@octave.org>
parents:
30564
diff
changeset
|
31 ## @code{circshift} instead. |
397d29f7135c
shift.m: Deprecate function in favor of circshift for Matlab compatibility.
Rik <rik@octave.org>
parents:
30564
diff
changeset
|
32 ## |
3369 | 33 ## If @var{x} is a vector, perform a circular shift of length @var{b} of |
34 ## the elements of @var{x}. | |
3426 | 35 ## |
3369 | 36 ## If @var{x} is a matrix, do the same for each column of @var{x}. |
20158
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
37 ## |
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
38 ## If the optional @var{dim} argument is given, operate along this dimension. |
30603
397d29f7135c
shift.m: Deprecate function in favor of circshift for Matlab compatibility.
Rik <rik@octave.org>
parents:
30564
diff
changeset
|
39 ## @seealso{circshift} |
3369 | 40 ## @end deftypefn |
2539 | 41 |
30603
397d29f7135c
shift.m: Deprecate function in favor of circshift for Matlab compatibility.
Rik <rik@octave.org>
parents:
30564
diff
changeset
|
42 ## FIXME: DEPRECATED: Remove in version 10. |
397d29f7135c
shift.m: Deprecate function in favor of circshift for Matlab compatibility.
Rik <rik@octave.org>
parents:
30564
diff
changeset
|
43 |
4862 | 44 function y = shift (x, b, dim) |
2539 | 45 |
30603
397d29f7135c
shift.m: Deprecate function in favor of circshift for Matlab compatibility.
Rik <rik@octave.org>
parents:
30564
diff
changeset
|
46 persistent warned = false; |
397d29f7135c
shift.m: Deprecate function in favor of circshift for Matlab compatibility.
Rik <rik@octave.org>
parents:
30564
diff
changeset
|
47 if (! warned) |
397d29f7135c
shift.m: Deprecate function in favor of circshift for Matlab compatibility.
Rik <rik@octave.org>
parents:
30564
diff
changeset
|
48 warned = true; |
397d29f7135c
shift.m: Deprecate function in favor of circshift for Matlab compatibility.
Rik <rik@octave.org>
parents:
30564
diff
changeset
|
49 warning ("Octave:deprecated-function", |
397d29f7135c
shift.m: Deprecate function in favor of circshift for Matlab compatibility.
Rik <rik@octave.org>
parents:
30564
diff
changeset
|
50 "shift is deprecated and will be removed from a future version of Octave, please use circshift instead\n"); |
397d29f7135c
shift.m: Deprecate function in favor of circshift for Matlab compatibility.
Rik <rik@octave.org>
parents:
30564
diff
changeset
|
51 endif |
397d29f7135c
shift.m: Deprecate function in favor of circshift for Matlab compatibility.
Rik <rik@octave.org>
parents:
30564
diff
changeset
|
52 |
28789
28de41192f3c
Eliminate unneeded verification of nargin, nargout in m-files.
Rik <rik@octave.org>
parents:
27985
diff
changeset
|
53 if (nargin < 2) |
6046 | 54 print_usage (); |
2539 | 55 endif |
56 | |
13278
04edb15d7966
shift.m: Clean up code and add more tests
Rik <octave@nomad.inbox5.com>
parents:
12676
diff
changeset
|
57 if (numel (x) < 1) |
04edb15d7966
shift.m: Clean up code and add more tests
Rik <octave@nomad.inbox5.com>
parents:
12676
diff
changeset
|
58 error ("shift: X must not be empty"); |
04edb15d7966
shift.m: Clean up code and add more tests
Rik <octave@nomad.inbox5.com>
parents:
12676
diff
changeset
|
59 elseif (! (isscalar (b) && b == fix (b))) |
10690
35adf2a71f3f
Use common code block to find first non-singleton dimension.
Rik <octave@nomad.inbox5.com>
parents:
10549
diff
changeset
|
60 error ("shift: B must be an integer"); |
2539 | 61 endif |
62 | |
4862 | 63 nd = ndims (x); |
64 sz = size (x); | |
65 | |
66 if (nargin == 3) | |
13278
04edb15d7966
shift.m: Clean up code and add more tests
Rik <octave@nomad.inbox5.com>
parents:
12676
diff
changeset
|
67 if (!(isscalar (dim) && dim == fix (dim)) |
11149
fe3c3dfc07eb
style fix: break lines before && and ||, not after
John W. Eaton <jwe@octave.org>
parents:
10690
diff
changeset
|
68 || !(1 <= dim && dim <= nd)) |
10690
35adf2a71f3f
Use common code block to find first non-singleton dimension.
Rik <octave@nomad.inbox5.com>
parents:
10549
diff
changeset
|
69 error ("shift: DIM must be an integer and a valid dimension"); |
4862 | 70 endif |
71 else | |
10690
35adf2a71f3f
Use common code block to find first non-singleton dimension.
Rik <octave@nomad.inbox5.com>
parents:
10549
diff
changeset
|
72 ## Find the first non-singleton dimension. |
12674
9493880928c8
Use common idiom in m-files for finding first non-singleton dimension.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
73 (dim = find (sz > 1, 1)) || (dim = 1); |
4862 | 74 endif |
75 | |
13278
04edb15d7966
shift.m: Clean up code and add more tests
Rik <octave@nomad.inbox5.com>
parents:
12676
diff
changeset
|
76 d = sz(dim); |
4862 | 77 |
12676
2783fa95cab7
Use common code idiom for creating cell array for indexing ND-arrays
Rik <octave@nomad.inbox5.com>
parents:
12674
diff
changeset
|
78 idx = repmat ({':'}, nd, 1); |
13278
04edb15d7966
shift.m: Clean up code and add more tests
Rik <octave@nomad.inbox5.com>
parents:
12676
diff
changeset
|
79 if (b > 0) |
5568 | 80 b = rem (b, d); |
7208 | 81 idx{dim} = [d-b+1:d, 1:d-b]; |
5568 | 82 elseif (b < 0) |
83 b = rem (abs (b), d); | |
7208 | 84 idx{dim} = [b+1:d, 1:b]; |
5568 | 85 endif |
13278
04edb15d7966
shift.m: Clean up code and add more tests
Rik <octave@nomad.inbox5.com>
parents:
12676
diff
changeset
|
86 |
7208 | 87 y = x(idx{:}); |
4369 | 88 |
7411 | 89 endfunction |
2539 | 90 |
13278
04edb15d7966
shift.m: Clean up code and add more tests
Rik <octave@nomad.inbox5.com>
parents:
12676
diff
changeset
|
91 |
7411 | 92 %!test |
93 %! a = [1, 2, 3]; | |
94 %! b = [4, 5, 6]; | |
95 %! c = [7, 8, 9]; | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
96 %! |
7411 | 97 %! r = [a, b, c]; |
98 %! m = [a; b; c]; | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
99 %! |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
100 %! assert (shift (r, 0), r); |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
101 %! assert (shift (r, 3), [c, a, b]); |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
102 %! assert (shift (r, -6), [c, a, b]); |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
103 %! assert (shift (r, -3), [b, c, a]); |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
104 %! assert (shift (m, 1), [c; a; b]); |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
105 %! assert (shift (m, -2), [c; a; b]); |
7411 | 106 |
19833
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
107 ## Test input validation |
28886
d8318c12d903
test: remove unnecessary BIST tests in m-files checking for excessive number of inputs.
Rik <rik@octave.org>
parents:
28789
diff
changeset
|
108 %!error <Invalid call> shift () |
d8318c12d903
test: remove unnecessary BIST tests in m-files checking for excessive number of inputs.
Rik <rik@octave.org>
parents:
28789
diff
changeset
|
109 %!error <Invalid call> shift (1) |
d8318c12d903
test: remove unnecessary BIST tests in m-files checking for excessive number of inputs.
Rik <rik@octave.org>
parents:
28789
diff
changeset
|
110 %!error <X must not be empty> shift ([], 1) |
d8318c12d903
test: remove unnecessary BIST tests in m-files checking for excessive number of inputs.
Rik <rik@octave.org>
parents:
28789
diff
changeset
|
111 %!error <B must be an integer> shift (ones (2), ones (2)) |
d8318c12d903
test: remove unnecessary BIST tests in m-files checking for excessive number of inputs.
Rik <rik@octave.org>
parents:
28789
diff
changeset
|
112 %!error <B must be an integer> shift (ones (2), 1.5) |
d8318c12d903
test: remove unnecessary BIST tests in m-files checking for excessive number of inputs.
Rik <rik@octave.org>
parents:
28789
diff
changeset
|
113 %!error <DIM must be an integer> shift (1, 1, 1.5) |
d8318c12d903
test: remove unnecessary BIST tests in m-files checking for excessive number of inputs.
Rik <rik@octave.org>
parents:
28789
diff
changeset
|
114 %!error <DIM must be .* a valid dimension> shift (1, 1, 0) |
d8318c12d903
test: remove unnecessary BIST tests in m-files checking for excessive number of inputs.
Rik <rik@octave.org>
parents:
28789
diff
changeset
|
115 %!error <DIM must be .* a valid dimension> shift (1, 1, 3) |