Mercurial > octave
annotate scripts/signal/bartlett.m @ 27919:1891570abac8
update Octave Project Developers copyright for the new year
In files that have the "Octave Project Developers" copyright notice,
update for 2020.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Mon, 06 Jan 2020 22:29:51 -0500 |
parents | b442ec6dda5c |
children | bd51beb6205e |
rev | line source |
---|---|
27919
1891570abac8
update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents:
27918
diff
changeset
|
1 ## 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
|
2 ## |
b442ec6dda5c
use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
3 ## See the file COPYRIGHT.md in the top-level directory of this distribution |
b442ec6dda5c
use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
4 ## or <https://octave.org/COPYRIGHT.html/>. |
b442ec6dda5c
use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
5 ## |
3426 | 6 ## |
3922 | 7 ## This file is part of Octave. |
8 ## | |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
9 ## Octave is free software: you can redistribute it and/or modify it |
3922 | 10 ## 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
|
11 ## 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
|
12 ## (at your option) any later version. |
3426 | 13 ## |
3922 | 14 ## Octave is distributed in the hope that it will be useful, but |
3191 | 15 ## WITHOUT ANY WARRANTY; without even the implied warranty of |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
16 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
17 ## GNU General Public License for more details. |
3426 | 18 ## |
3191 | 19 ## You should have received a copy of the GNU General Public License |
7016 | 20 ## 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
|
21 ## <https://www.gnu.org/licenses/>. |
3191 | 22 |
3449 | 23 ## -*- texinfo -*- |
20852
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20231
diff
changeset
|
24 ## @deftypefn {} {} bartlett (@var{m}) |
20165
f1d0f506ee78
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20025
diff
changeset
|
25 ## Return the filter coefficients of a Bartlett (triangular) window of length |
f1d0f506ee78
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20025
diff
changeset
|
26 ## @var{m}. |
3191 | 27 ## |
20165
f1d0f506ee78
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20025
diff
changeset
|
28 ## For a definition of the Bartlett window see, e.g., |
19040
0850b5212619
doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
29 ## @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
|
30 ## @cite{Discrete-Time Signal Processing}. |
3449 | 31 ## @end deftypefn |
3191 | 32 |
3457 | 33 ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> |
34 ## Description: Coefficients of the Bartlett (triangular) window | |
3191 | 35 |
36 function c = bartlett (m) | |
3426 | 37 |
3191 | 38 if (nargin != 1) |
6046 | 39 print_usage (); |
3191 | 40 endif |
3426 | 41 |
13279
984359717d71
Use common code idiom for checking whether a double value is an integer.
Rik <octave@nomad.inbox5.com>
parents:
13062
diff
changeset
|
42 if (! (isscalar (m) && (m == fix (m)) && (m > 0))) |
19827
2e556954ced8
bartlett: Reword error message for consistency
Mike Miller <mtmiller@ieee.org>
parents:
19697
diff
changeset
|
43 error ("bartlett: M must be a positive integer"); |
3191 | 44 endif |
3426 | 45 |
3191 | 46 if (m == 1) |
47 c = 1; | |
48 else | |
20231
83792dd9bcc1
Use in-place operators in m-files where possible.
Rik <rik@octave.org>
parents:
20165
diff
changeset
|
49 m -= 1; |
3191 | 50 n = fix (m / 2); |
4172 | 51 c = [2*(0:n)/m, 2-2*(n+1:m)/m]'; |
3191 | 52 endif |
53 | |
54 endfunction | |
13062
b3a8b75dfec3
codesprint: 9 tests for bartlett.m
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents:
11523
diff
changeset
|
55 |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
56 |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
57 %!assert (bartlett (1), 1) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
58 %!assert (bartlett (2), zeros (2,1)) |
20025
d209fbae38ae
Fix tests for bartlett, blackman, hamming, and hanning
Mike Miller <mtmiller@octave.org>
parents:
19827
diff
changeset
|
59 %!assert (bartlett (15), flip (bartlett (15)), 5*eps) |
d209fbae38ae
Fix tests for bartlett, blackman, hamming, and hanning
Mike Miller <mtmiller@octave.org>
parents:
19827
diff
changeset
|
60 %!assert (bartlett (16), flip (bartlett (16)), 5*eps) |
13062
b3a8b75dfec3
codesprint: 9 tests for bartlett.m
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents:
11523
diff
changeset
|
61 %!test |
b3a8b75dfec3
codesprint: 9 tests for bartlett.m
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents:
11523
diff
changeset
|
62 %! N = 9; |
b3a8b75dfec3
codesprint: 9 tests for bartlett.m
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents:
11523
diff
changeset
|
63 %! A = bartlett (N); |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
64 %! assert (A(ceil (N/2)), 1); |
13062
b3a8b75dfec3
codesprint: 9 tests for bartlett.m
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents:
11523
diff
changeset
|
65 |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
66 %!error bartlett () |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
67 %!error bartlett (0.5) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
68 %!error bartlett (-1) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
69 %!error bartlett (ones (1,4)) |