Mercurial > octave-antonio
annotate scripts/signal/bartlett.m @ 20165:f1d0f506ee78 stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed optimization, polynomial, signal script directories.
* scripts/optimization/fminbnd.m, scripts/optimization/fminsearch.m,
scripts/optimization/fminunc.m, scripts/optimization/fsolve.m,
scripts/optimization/fzero.m, scripts/optimization/glpk.m,
scripts/optimization/lsqnonneg.m, scripts/optimization/pqpnonneg.m,
scripts/optimization/qp.m, scripts/optimization/sqp.m,
scripts/polynomial/compan.m, scripts/polynomial/mkpp.m,
scripts/polynomial/mpoles.m, scripts/polynomial/pchip.m,
scripts/polynomial/poly.m, scripts/polynomial/polyaffine.m,
scripts/polynomial/polyder.m, scripts/polynomial/polyeig.m,
scripts/polynomial/polyfit.m, scripts/polynomial/polygcd.m,
scripts/polynomial/polyint.m, scripts/polynomial/polyout.m,
scripts/polynomial/polyval.m, scripts/polynomial/ppder.m,
scripts/polynomial/ppint.m, scripts/polynomial/ppjumps.m,
scripts/polynomial/ppval.m, scripts/polynomial/residue.m,
scripts/polynomial/roots.m, scripts/polynomial/spline.m,
scripts/polynomial/splinefit.m, scripts/polynomial/unmkpp.m,
scripts/signal/arch_fit.m, scripts/signal/arch_rnd.m,
scripts/signal/arma_rnd.m, scripts/signal/autoreg_matrix.m,
scripts/signal/bartlett.m, scripts/signal/blackman.m, scripts/signal/detrend.m,
scripts/signal/diffpara.m, scripts/signal/durbinlevinson.m,
scripts/signal/fftconv.m, scripts/signal/fftfilt.m, scripts/signal/fftshift.m,
scripts/signal/filter2.m, scripts/signal/freqz.m, scripts/signal/hamming.m,
scripts/signal/hanning.m, scripts/signal/hurst.m, scripts/signal/ifftshift.m,
scripts/signal/periodogram.m, scripts/signal/sinc.m, scripts/signal/sinetone.m,
scripts/signal/sinewave.m, scripts/signal/spectral_adf.m,
scripts/signal/spectral_xdf.m, scripts/signal/spencer.m, scripts/signal/stft.m,
scripts/signal/synthesis.m, scripts/signal/unwrap.m,
scripts/signal/yulewalker.m:
Update more docstrings to have one sentence summary as first line.
| author | Rik <rik@octave.org> |
|---|---|
| date | Mon, 04 May 2015 21:50:57 -0700 |
| parents | d209fbae38ae |
| children |
| rev | line source |
|---|---|
|
19697
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
19040
diff
changeset
|
1 ## Copyright (C) 1995-2015 Andreas Weingessel |
| 3426 | 2 ## |
| 3922 | 3 ## This file is part of Octave. |
| 4 ## | |
| 5 ## Octave is free software; you can redistribute it and/or modify it | |
| 6 ## under the terms of the GNU General Public License as published by | |
| 7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
| 8 ## your option) any later version. | |
| 3426 | 9 ## |
| 3922 | 10 ## Octave is distributed in the hope that it will be useful, but |
| 3191 | 11 ## WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 3426 | 13 ## General Public License for more details. |
| 14 ## | |
| 3191 | 15 ## You should have received a copy of the GNU General Public License |
| 7016 | 16 ## along with Octave; see the file COPYING. If not, see |
| 17 ## <http://www.gnu.org/licenses/>. | |
| 3191 | 18 |
| 3449 | 19 ## -*- texinfo -*- |
| 20 ## @deftypefn {Function File} {} 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
|
21 ## 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
|
22 ## @var{m}. |
| 3191 | 23 ## |
|
20165
f1d0f506ee78
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20025
diff
changeset
|
24 ## 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
|
25 ## @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
|
26 ## @cite{Discrete-Time Signal Processing}. |
| 3449 | 27 ## @end deftypefn |
| 3191 | 28 |
| 3457 | 29 ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> |
| 30 ## Description: Coefficients of the Bartlett (triangular) window | |
| 3191 | 31 |
| 32 function c = bartlett (m) | |
| 3426 | 33 |
| 3191 | 34 if (nargin != 1) |
| 6046 | 35 print_usage (); |
| 3191 | 36 endif |
| 3426 | 37 |
|
13279
984359717d71
Use common code idiom for checking whether a double value is an integer.
Rik <octave@nomad.inbox5.com>
parents:
13062
diff
changeset
|
38 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
|
39 error ("bartlett: M must be a positive integer"); |
| 3191 | 40 endif |
| 3426 | 41 |
| 3191 | 42 if (m == 1) |
| 43 c = 1; | |
| 44 else | |
| 45 m = m - 1; | |
| 46 n = fix (m / 2); | |
| 4172 | 47 c = [2*(0:n)/m, 2-2*(n+1:m)/m]'; |
| 3191 | 48 endif |
| 49 | |
| 50 endfunction | |
|
13062
b3a8b75dfec3
codesprint: 9 tests for bartlett.m
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents:
11523
diff
changeset
|
51 |
|
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
52 |
|
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
53 %!assert (bartlett (1), 1) |
|
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
54 %!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
|
55 %!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
|
56 %!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
|
57 %!test |
|
b3a8b75dfec3
codesprint: 9 tests for bartlett.m
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents:
11523
diff
changeset
|
58 %! N = 9; |
|
b3a8b75dfec3
codesprint: 9 tests for bartlett.m
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents:
11523
diff
changeset
|
59 %! A = bartlett (N); |
|
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
60 %! assert (A(ceil (N/2)), 1); |
|
13062
b3a8b75dfec3
codesprint: 9 tests for bartlett.m
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents:
11523
diff
changeset
|
61 |
|
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
62 %!error bartlett () |
|
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
63 %!error bartlett (0.5) |
|
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
64 %!error bartlett (-1) |
|
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
65 %!error bartlett (ones (1,4)) |
|
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
66 |