annotate scripts/signal/hanning.m @ 28886:d8318c12d903

test: remove unnecessary BIST tests in m-files checking for excessive number of inputs. Remove BIST tests now that interpreter enforces calling function with no more than the number of arguments defined in the function prototype. * makeUniqueStrings.m, makeValidName.m, base64decode.m, base64encode.m, record.m, sound.m, soundsc.m, acosd.m, acot.m, acotd.m, acoth.m, acsc.m, acscd.m, acsch.m, asec.m, asecd.m, asech.m, asind.m, atan2d.m, atand.m, cosd.m, cot.m, cotd.m, coth.m, csc.m, cscd.m, csch.m, sec.m, secd.m, sech.m, sind.m, tand.m, accumdim.m, bincoeff.m, bitget.m, bitset.m, cell2mat.m, circshift.m, cplxpair.m, cumtrapz.m, deg2rad.m, flip.m, fliplr.m, flipud.m, int2str.m, interpft.m, logspace.m, num2str.m, postpad.m, prepad.m, rad2deg.m, rot90.m, rotdim.m, shift.m, subsindex.m, trapz.m, rotx.m, roty.m, rotz.m, getappdata.m, getpixelposition.m, guidata.m, isappdata.m, waitforbuttonpress.m, __gripe_missing_component__.m, bessel.m, hsv2rgb.m, ind2gray.m, rgb2gray.m, rgb2hsv.m, rgbplot.m, fileread.m, javachk.m, usejava.m, findstr.m, genvarname.m, isdir.m, vectorize.m, cond.m, cross.m, duplication_matrix.m, expm.m, isbanded.m, isdefinite.m, isdiag.m, ishermitian.m, issymmetric.m, istril.m, istriu.m, trace.m, vech.m, vecnorm.m, cast.m, citation.m, compare_versions.m, grabcode.m, inputname.m, isfile.m, isfolder.m, ismac.m, ispc.m, isunix.m, list_primes.m, methods.m, news.m, open.m, run.m, swapbytes.m, tar.m, verLessThan.m, zip.m, odeget.m, optimget.m, stemleaf.m, allchild.m, ancestor.m, close.m, groot.m, hgsave.m, isaxes.m, isfigure.m, isgraphics.m, ishandle.m, isprop.m, linkaxes.m, rotate.m, saveas.m, conv.m, poly.m, polyint.m, polyreduce.m, ppval.m, roots.m, addpref.m, getpref.m, ispref.m, rmpref.m, setpref.m, profile.m, profshow.m, powerset.m, autoreg_matrix.m, bartlett.m, blackman.m, detrend.m, fftconv.m, fftfilt.m, fftshift.m, hamming.m, hanning.m, ifftshift.m, sinewave.m, spectral_adf.m, spectral_xdf.m, unwrap.m, nonzeros.m, spconvert.m, sprand.m, sprandn.m, beta.m, betainc.m, betaln.m, cosint.m, expint.m, factorial.m, legendre.m, nchoosek.m, nthroot.m, perms.m, pow2.m, primes.m, reallog.m, realpow.m, realsqrt.m, sinint.m, hankel.m, hilb.m, invhilb.m, magic.m, pascal.m, toeplitz.m, vander.m, wilkinson.m, center.m, corr.m, cov.m, discrete_cdf.m, discrete_inv.m, discrete_pdf.m, empirical_cdf.m, empirical_inv.m, empirical_pdf.m, iqr.m, kendall.m, kurtosis.m, mad.m, meansq.m, median.m, moment.m, prctile.m, quantile.m, range.m, run_count.m, skewness.m, spearman.m, statistics.m, std.m, var.m, base2dec.m, bin2dec.m, blanks.m, dec2base.m, dec2bin.m, dec2hex.m, endsWith.m, erase.m, hex2dec.m, index.m, isletter.m, isstring.m, isstrprop.m, mat2str.m, ostrsplit.m, rindex.m, startsWith.m, strtrunc.m, substr.m, fail.m, addtodate.m, asctime.m, ctime.m, date.m, datestr.m, eomday.m, etime.m, is_leap_year.m, now.m: remove unnecessary BIST tests in m-files checking for excessive number of inputs.
author Rik <rik@octave.org>
date Fri, 09 Oct 2020 13:28:53 -0700
parents 28de41192f3c
children 7854d5752dd2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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 ##
27919
1891570abac8 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 27918
diff changeset
3 ## Copyright (C) 1995-2020 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
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
7 ##
3922
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3457
diff changeset
8 ## This file is part of Octave.
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3457
diff changeset
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
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3457
diff changeset
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
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
14 ##
3922
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3457
diff changeset
15 ## Octave is distributed in the hope that it will be useful, but
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
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
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
19 ##
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
20 ## 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: 6046
diff changeset
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 ########################################################################
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
25
3449
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3426
diff changeset
26 ## -*- texinfo -*-
20852
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20231
diff changeset
27 ## @deftypefn {} {} hanning (@var{m})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20231
diff changeset
28 ## @deftypefnx {} {} hanning (@var{m}, "periodic")
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20231
diff changeset
29 ## @deftypefnx {} {} hanning (@var{m}, "symmetric")
3449
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3426
diff changeset
30 ## Return the filter coefficients of a Hanning window of length @var{m}.
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
31 ##
19826
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305)
Mike Miller <mtmiller@ieee.org>
parents: 19697
diff changeset
32 ## If the optional argument @qcode{"periodic"} is given, the periodic form
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305)
Mike Miller <mtmiller@ieee.org>
parents: 19697
diff changeset
33 ## of the window is returned. This is equivalent to the window of length
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305)
Mike Miller <mtmiller@ieee.org>
parents: 19697
diff changeset
34 ## @var{m}+1 with the last coefficient removed. The optional argument
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305)
Mike Miller <mtmiller@ieee.org>
parents: 19697
diff changeset
35 ## @qcode{"symmetric"} is equivalent to not specifying a second argument.
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305)
Mike Miller <mtmiller@ieee.org>
parents: 19697
diff changeset
36 ##
20165
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20026
diff changeset
37 ## For a definition of the Hanning window see, e.g.,
19040
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 17744
diff changeset
38 ## @nospell{A.V. Oppenheim & R. W. Schafer},
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 17744
diff changeset
39 ## @cite{Discrete-Time Signal Processing}.
3449
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3426
diff changeset
40 ## @end deftypefn
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
41
19826
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305)
Mike Miller <mtmiller@ieee.org>
parents: 19697
diff changeset
42 function c = hanning (m, opt)
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
43
28789
28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files.
Rik <rik@octave.org>
parents: 27984
diff changeset
44 if (nargin < 1)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5307
diff changeset
45 print_usage ();
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
46 endif
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
47
13279
984359717d71 Use common code idiom for checking whether a double value is an integer.
Rik <octave@nomad.inbox5.com>
parents: 13055
diff changeset
48 if (! (isscalar (m) && (m == fix (m)) && (m > 0)))
19826
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305)
Mike Miller <mtmiller@ieee.org>
parents: 19697
diff changeset
49 error ("hanning: M must be a positive integer");
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305)
Mike Miller <mtmiller@ieee.org>
parents: 19697
diff changeset
50 endif
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305)
Mike Miller <mtmiller@ieee.org>
parents: 19697
diff changeset
51
20026
230c1e2a678d blackman, hamming, hanning: Simplify handling of periodic window option
Mike Miller <mtmiller@octave.org>
parents: 20025
diff changeset
52 N = m - 1;
19826
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305)
Mike Miller <mtmiller@ieee.org>
parents: 19697
diff changeset
53 if (nargin == 2)
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305)
Mike Miller <mtmiller@ieee.org>
parents: 19697
diff changeset
54 switch (opt)
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305)
Mike Miller <mtmiller@ieee.org>
parents: 19697
diff changeset
55 case "periodic"
20026
230c1e2a678d blackman, hamming, hanning: Simplify handling of periodic window option
Mike Miller <mtmiller@octave.org>
parents: 20025
diff changeset
56 N = m;
19826
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305)
Mike Miller <mtmiller@ieee.org>
parents: 19697
diff changeset
57 case "symmetric"
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305)
Mike Miller <mtmiller@ieee.org>
parents: 19697
diff changeset
58 ## Default option, same as no option specified.
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305)
Mike Miller <mtmiller@ieee.org>
parents: 19697
diff changeset
59 otherwise
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305)
Mike Miller <mtmiller@ieee.org>
parents: 19697
diff changeset
60 error ('hanning: window type must be either "periodic" or "symmetric"');
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305)
Mike Miller <mtmiller@ieee.org>
parents: 19697
diff changeset
61 endswitch
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
62 endif
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
63
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
64 if (m == 1)
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
65 c = 1;
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
66 else
20231
83792dd9bcc1 Use in-place operators in m-files where possible.
Rik <rik@octave.org>
parents: 20165
diff changeset
67 m -= 1;
20026
230c1e2a678d blackman, hamming, hanning: Simplify handling of periodic window option
Mike Miller <mtmiller@octave.org>
parents: 20025
diff changeset
68 c = 0.5 - 0.5 * cos (2 * pi * (0 : m)' / N);
19826
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305)
Mike Miller <mtmiller@ieee.org>
parents: 19697
diff changeset
69 endif
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305)
Mike Miller <mtmiller@ieee.org>
parents: 19697
diff changeset
70
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
71 endfunction
13055
4e95529cbc51 codesprint: 9 tests for hanning.m
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents: 11523
diff changeset
72
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
73
21317
a4faec57f4c8 maint: remove semicolon after %!assert tests to follow Octave conventions.
Rik <rik@octave.org>
parents: 20852
diff changeset
74 %!assert (hanning (1), 1)
a4faec57f4c8 maint: remove semicolon after %!assert tests to follow Octave conventions.
Rik <rik@octave.org>
parents: 20852
diff changeset
75 %!assert (hanning (2), zeros (2,1))
a4faec57f4c8 maint: remove semicolon after %!assert tests to follow Octave conventions.
Rik <rik@octave.org>
parents: 20852
diff changeset
76 %!assert (hanning (15), flip (hanning (15)), 5*eps)
a4faec57f4c8 maint: remove semicolon after %!assert tests to follow Octave conventions.
Rik <rik@octave.org>
parents: 20852
diff changeset
77 %!assert (hanning (16), flip (hanning (16)), 5*eps)
13055
4e95529cbc51 codesprint: 9 tests for hanning.m
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents: 11523
diff changeset
78 %!test
4e95529cbc51 codesprint: 9 tests for hanning.m
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents: 11523
diff changeset
79 %! N = 15;
4e95529cbc51 codesprint: 9 tests for hanning.m
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents: 11523
diff changeset
80 %! A = hanning (N);
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
81 %! assert (A(ceil (N/2)), 1);
13055
4e95529cbc51 codesprint: 9 tests for hanning.m
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents: 11523
diff changeset
82
21317
a4faec57f4c8 maint: remove semicolon after %!assert tests to follow Octave conventions.
Rik <rik@octave.org>
parents: 20852
diff changeset
83 %!assert (hanning (15), hanning (15, "symmetric"))
a4faec57f4c8 maint: remove semicolon after %!assert tests to follow Octave conventions.
Rik <rik@octave.org>
parents: 20852
diff changeset
84 %!assert (hanning (16)(1:15), hanning (15, "periodic"))
19826
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305)
Mike Miller <mtmiller@ieee.org>
parents: 19697
diff changeset
85 %!test
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305)
Mike Miller <mtmiller@ieee.org>
parents: 19697
diff changeset
86 %! N = 16;
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305)
Mike Miller <mtmiller@ieee.org>
parents: 19697
diff changeset
87 %! A = hanning (N, "periodic");
20025
d209fbae38ae Fix tests for bartlett, blackman, hamming, and hanning
Mike Miller <mtmiller@octave.org>
parents: 19826
diff changeset
88 %! assert (A(N/2 + 1), 1);
19826
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305)
Mike Miller <mtmiller@ieee.org>
parents: 19697
diff changeset
89
28886
d8318c12d903 test: remove unnecessary BIST tests in m-files checking for excessive number of inputs.
Rik <rik@octave.org>
parents: 28789
diff changeset
90 %!error <Invalid call> hanning ()
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
91 %!error hanning (0.5)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
92 %!error hanning (-1)
14868
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents: 14363
diff changeset
93 %!error hanning (ones (1,4))
21581
6fab85c1538f maint: Follow Octave conventions for use of semicolon in BIST tests.
Rik <rik@octave.org>
parents: 21317
diff changeset
94 %!error hanning (1, "invalid")