Mercurial > octave-nkf
annotate scripts/signal/sinc.m @ 20200: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 | 4197fc428c7d |
| children | b0f7ee81d974 |
| rev | line source |
|---|---|
|
19731
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
17744
diff
changeset
|
1 ## Copyright (C) 1994-2015 John W. Eaton |
| 2313 | 2 ## |
| 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. | |
| 2313 | 9 ## |
| 10 ## Octave is distributed in the hope that it will be useful, but | |
| 11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 13 ## General Public License for more details. | |
| 14 ## | |
| 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/>. | |
| 2303 | 18 |
| 3367 | 19 ## -*- texinfo -*- |
| 20 ## @deftypefn {Function File} {} sinc (@var{x}) | |
|
20200
f1d0f506ee78
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
21 ## Compute the sinc function. |
|
f1d0f506ee78
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
22 ## |
| 3367 | 23 ## Return |
| 24 ## @tex | |
| 25 ## $ \sin (\pi x)/(\pi x)$. | |
| 26 ## @end tex | |
|
8517
81d6ab3ac93c
Allow documentation tobe built for other formats than tex and info
sh@sh-laptop
parents:
7125
diff
changeset
|
27 ## @ifnottex |
|
14868
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
28 ## sin (pi*x) / (pi*x). |
|
8517
81d6ab3ac93c
Allow documentation tobe built for other formats than tex and info
sh@sh-laptop
parents:
7125
diff
changeset
|
29 ## @end ifnottex |
| 3367 | 30 ## @end deftypefn |
| 559 | 31 |
| 3367 | 32 ## Author: jwe ??? |
| 2314 | 33 |
| 2311 | 34 function result = sinc (x) |
| 559 | 35 |
| 7125 | 36 if (nargin != 1) |
| 37 print_usage (); | |
| 38 endif | |
| 39 | |
| 3486 | 40 result = ones (size (x)); |
| 559 | 41 |
| 3486 | 42 i = (x != 0); |
| 559 | 43 |
| 4807 | 44 if (any (i(:))) |
| 3486 | 45 t = pi * x(i); |
| 46 result(i) = sin (t) ./ t; | |
| 559 | 47 endif |
| 48 | |
| 49 endfunction | |
|
12816
cd59f5271941
codesprint: Wrote 4 tests for sinc.m
Giles Anderson <agander@gmail.com>
parents:
11523
diff
changeset
|
50 |
|
cd59f5271941
codesprint: Wrote 4 tests for sinc.m
Giles Anderson <agander@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 %!assert (sinc (0), 1) |
|
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
53 %!assert (sinc (1), 0,1e-6) |
|
12816
cd59f5271941
codesprint: Wrote 4 tests for sinc.m
Giles Anderson <agander@gmail.com>
parents:
11523
diff
changeset
|
54 %!assert (sinc (1/2), 2/pi, 1e-6) |
|
cd59f5271941
codesprint: Wrote 4 tests for sinc.m
Giles Anderson <agander@gmail.com>
parents:
11523
diff
changeset
|
55 |
|
cd59f5271941
codesprint: Wrote 4 tests for sinc.m
Giles Anderson <agander@gmail.com>
parents:
11523
diff
changeset
|
56 %!error sinc() |
|
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
57 |