]> Creatis software - CreaPhase.git/blob - octave_packages/m/signal/arch_fit.m
update packages
[CreaPhase.git] / octave_packages / m / signal / arch_fit.m
1 ## Copyright (C) 1995-2012 Kurt Hornik
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
7 ## the Free Software Foundation; either version 3 of the License, or (at
8 ## your option) any later version.
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
16 ## along with Octave; see the file COPYING.  If not, see
17 ## <http://www.gnu.org/licenses/>.
18
19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {[@var{a}, @var{b}] =} arch_fit (@var{y}, @var{x}, @var{p}, @var{iter}, @var{gamma}, @var{a0}, @var{b0})
21 ## Fit an ARCH regression model to the time series @var{y} using the
22 ## scoring algorithm in Engle's original ARCH paper.  The model is
23 ##
24 ## @example
25 ## @group
26 ## y(t) = b(1) * x(t,1) + @dots{} + b(k) * x(t,k) + e(t),
27 ## h(t) = a(1) + a(2) * e(t-1)^2 + @dots{} + a(p+1) * e(t-p)^2
28 ## @end group
29 ## @end example
30 ##
31 ## @noindent
32 ## in which @math{e(t)} is @math{N(0, h(t))}, given a time-series vector
33 ## @var{y} up to time @math{t-1} and a matrix of (ordinary) regressors
34 ## @var{x} up to @math{t}.  The order of the regression of the residual
35 ## variance is specified by @var{p}.
36 ##
37 ## If invoked as @code{arch_fit (@var{y}, @var{k}, @var{p})} with a
38 ## positive integer @var{k}, fit an ARCH(@var{k}, @var{p}) process,
39 ## i.e., do the above with the @math{t}-th row of @var{x} given by
40 ##
41 ## @example
42 ## [1, y(t-1), @dots{}, y(t-k)]
43 ## @end example
44 ##
45 ## Optionally, one can specify the number of iterations @var{iter}, the
46 ## updating factor @var{gamma}, and initial values @math{a0} and
47 ## @math{b0} for the scoring algorithm.
48 ## @end deftypefn
49
50 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
51 ## Description: Fit an ARCH regression model
52
53 function [a, b] = arch_fit (y, x, p, iter, gamma, a0, b0)
54
55   if ((nargin < 3) || (nargin == 6) || (nargin > 7))
56     print_usage ();
57   endif
58
59   if (! (isvector (y)))
60     error ("arch_fit: Y must be a vector");
61   endif
62
63   T   = length (y);
64   y   = reshape (y, T, 1);
65   [rx, cx] = size (x);
66   if ((rx == 1) && (cx == 1))
67     x = autoreg_matrix (y, x);
68   elseif (! (rx == T))
69     error ("arch_fit: either rows (X) == length (Y), or X is a scalar");
70   endif
71
72   [T, k] = size (x);
73
74   if (nargin == 7)
75     a   = a0;
76     b   = b0;
77     e   = y - x * b;
78   else
79     [b, v_b, e] = ols (y, x);
80     a   = [v_b, (zeros (1, p))]';
81     if (nargin < 5)
82       gamma = 0.1;
83       if (nargin < 4)
84         iter = 50;
85       endif
86     endif
87   endif
88
89   esq = e.^2;
90   Z   = autoreg_matrix (esq, p);
91
92   for i = 1 : iter;
93     h    = Z * a;
94     tmp  = esq ./ h.^2 - 1 ./ h;
95     s    = 1 ./ h(1:T-p);
96     for j = 1 : p;
97       s = s - a(j+1) * tmp(j+1:T-p+j);
98     endfor
99     r    = 1 ./ h(1:T-p);
100     for j = 1:p;
101       r = r + 2 * h(j+1:T-p+j).^2 .* esq(1:T-p);
102     endfor
103     r   = sqrt (r);
104     X_tilde = x(1:T-p, :) .* (r * ones (1,k));
105     e_tilde = e(1:T-p) .*s ./ r;
106     delta_b = inv (X_tilde' * X_tilde) * X_tilde' * e_tilde;
107     b   = b + gamma * delta_b;
108     e   = y - x * b;
109     esq = e .^ 2;
110     Z   = autoreg_matrix (esq, p);
111     h   = Z * a;
112     f   = esq ./ h - ones(T,1);
113     Z_tilde = Z ./ (h * ones (1, p+1));
114     delta_a = inv (Z_tilde' * Z_tilde) * Z_tilde' * f;
115     a   = a + gamma * delta_a;
116   endfor
117
118 endfunction