Mercurial > hg > octave-nkf
annotate scripts/signal/diffpara.m @ 20038:9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Try to trim long lines to < 80 chars.
Use '##' for single line comments.
Use '(...)' around tests for if/elseif/switch/while.
Abut cell indexing operator '{' next to variable.
Abut array indexing operator '(' next to variable.
Use space between negation operator '!' and following expression.
Use two newlines between endfunction and start of %!test or %!demo code.
Remove unnecessary parens grouping between short-circuit operators.
Remove stray extra spaces (typos) between variables and assignment operators.
Remove stray extra spaces from ends of lines.
| author | Rik <rik@octave.org> |
|---|---|
| date | Mon, 23 Feb 2015 14:54:39 -0800 |
| parents | 4197fc428c7d |
| children | f1d0f506ee78 |
| rev | line source |
|---|---|
|
19898
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
19232
diff
changeset
|
1 ## Copyright (C) 1995-2015 Friedrich Leisch |
| 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 -*- |
| 6547 | 20 ## @deftypefn {Function File} {[@var{d}, @var{dd}] =} diffpara (@var{x}, @var{a}, @var{b}) |
| 3449 | 21 ## Return the estimator @var{d} for the differencing parameter of an |
| 3191 | 22 ## integrated time series. |
| 23 ## | |
| 3499 | 24 ## The frequencies from @math{[2*pi*a/t, 2*pi*b/T]} are used for the |
| 25 ## estimation. If @var{b} is omitted, the interval | |
| 26 ## @math{[2*pi/T, 2*pi*a/T]} is used. If both @var{b} and @var{a} are | |
| 27 ## omitted then @math{a = 0.5 * sqrt (T)} and @math{b = 1.5 * sqrt (T)} | |
| 28 ## is used, where @math{T} is the sample size. If @var{x} is a matrix, | |
| 29 ## the differencing parameter of each column is estimated. | |
| 3191 | 30 ## |
| 3449 | 31 ## The estimators for all frequencies in the intervals |
| 3499 | 32 ## described above is returned in @var{dd}. The value of @var{d} is |
| 33 ## simply the mean of @var{dd}. | |
| 3191 | 34 ## |
|
19232
0850b5212619
doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
35 ## Reference: @nospell{P.J. Brockwell & R.A. Davis}. @cite{Time Series: |
|
10791
3140cb7a05a1
Add spellchecker scripts for Octave and run spellcheck of documentation
Rik <octave@nomad.inbox5.com>
parents:
7017
diff
changeset
|
36 ## Theory and Methods}. Springer 1987. |
| 3449 | 37 ## @end deftypefn |
| 3426 | 38 |
| 3457 | 39 ## Author: FL <Friedrich.Leisch@ci.tuwien.ac.at> |
| 40 ## Description: Estimate the fractional differencing parameter | |
| 3191 | 41 |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10791
diff
changeset
|
42 function [d, dd] = diffpara (x, a, b) |
| 3426 | 43 |
|
20038
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19898
diff
changeset
|
44 if (nargin < 1 || nargin > 3) |
| 6046 | 45 print_usage (); |
|
20038
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19898
diff
changeset
|
46 endif |
|
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19898
diff
changeset
|
47 |
|
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19898
diff
changeset
|
48 if (isvector (x)) |
|
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19898
diff
changeset
|
49 n = length (x); |
|
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19898
diff
changeset
|
50 k = 1; |
|
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19898
diff
changeset
|
51 x = reshape (x, n, 1); |
| 3191 | 52 else |
|
20038
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19898
diff
changeset
|
53 [n, k] = size (x); |
|
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19898
diff
changeset
|
54 endif |
|
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19898
diff
changeset
|
55 if (nargin == 1) |
|
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19898
diff
changeset
|
56 a = 0.5 * sqrt (n); |
|
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19898
diff
changeset
|
57 b = 1.5 * sqrt (n); |
|
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19898
diff
changeset
|
58 elseif (nargin == 2) |
|
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19898
diff
changeset
|
59 b = a; |
|
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19898
diff
changeset
|
60 a = 1; |
| 3191 | 61 endif |
| 3426 | 62 |
| 4030 | 63 if (! (isscalar (a) && isscalar (b))) |
|
11472
1740012184f9
Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents:
11469
diff
changeset
|
64 error ("diffpara: A and B must be scalars"); |
| 3191 | 65 endif |
| 3426 | 66 |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10791
diff
changeset
|
67 dd = zeros (b - a + 1, k); |
| 3426 | 68 |
| 3191 | 69 for l = 1:k |
| 3426 | 70 |
| 3191 | 71 w = 2 * pi * (1 : n-1) / n; |
| 3426 | 72 |
| 3457 | 73 x = 2 * log (abs (1 - exp (-i*w))); |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10791
diff
changeset
|
74 y = log (periodogram (x(2:n,l))); |
| 3426 | 75 |
| 3191 | 76 x = center (x); |
| 77 y = center (y); | |
| 3426 | 78 |
| 3191 | 79 for m = a:b |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10791
diff
changeset
|
80 dd(m-a+1) = - x(1:m) * y(1:m) / sumsq (x(1:m)); |
| 3191 | 81 endfor |
| 3426 | 82 |
| 3191 | 83 endfor |
| 3426 | 84 |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10791
diff
changeset
|
85 d = mean (dd); |
| 3426 | 86 |
| 3191 | 87 endfunction |
| 88 |