octave_packages/m/statistics/base/gls.m

   1 ## Copyright (C) 1996-2012 John W. Eaton
   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{beta}, @var{v}, @var{r}] =} gls (@var{y}, @var{x}, @var{o})
  21 ## Generalized least squares estimation for the multivariate model
  22 ## @tex
  23 ## $y = x b + e$
  24 ## with $\bar{e} = 0$ and cov(vec($e$)) = $(s^2)o$,
  25 ## @end tex
  26 ## @ifnottex
  27 ## @w{@math{y = x*b + e}} with @math{mean (e) = 0} and
  28 ## @math{cov (vec (e)) = (s^2) o},
  29 ## @end ifnottex
  30 ##  where
  31 ## @tex
  32 ## $y$ is a $t \times p$ matrix, $x$ is a $t \times k$ matrix, $b$ is a $k
  33 ## \times p$ matrix, $e$ is a $t \times p$ matrix, and $o$ is a $tp \times
  34 ## tp$ matrix.
  35 ## @end tex
  36 ## @ifnottex
  37 ## @math{y} is a @math{t} by @math{p} matrix, @math{x} is a @math{t} by
  38 ## @math{k} matrix, @math{b} is a @math{k} by @math{p} matrix, @math{e}
  39 ## is a @math{t} by @math{p} matrix, and @math{o} is a @math{t*p} by
  40 ## @math{t*p} matrix.
  41 ## @end ifnottex
  42 ##
  43 ## @noindent
  44 ## Each row of @var{y} and @var{x} is an observation and each column a
  45 ## variable.  The return values @var{beta}, @var{v}, and @var{r} are
  46 ## defined as follows.
  47 ##
  48 ## @table @var
  49 ## @item beta
  50 ## The GLS estimator for @math{b}.
  51 ##
  52 ## @item v
  53 ## The GLS estimator for @math{s^2}.
  54 ##
  55 ## @item r
  56 ## The matrix of GLS residuals, @math{r = y - x*beta}.
  57 ## @end table
  58 ## @seealso{ols}
  59 ## @end deftypefn
  60
  61 ## Author: Teresa Twaroch <twaroch@ci.tuwien.ac.at>
  62 ## Created: May 1993
  63 ## Adapted-By: jwe
  64
  65 function [beta, v, r] = gls (y, x, o)
  66
  67   if (nargin != 3)
  68     print_usage ();
  69   endif
  70
  71   if (! (isnumeric (x) && isnumeric (y) && isnumeric (o)))
  72     error ("gls: X, Y, and O must be numeric matrices or vectors");
  73   endif
  74
  75   if (ndims (x) != 2 || ndims (y) != 2 || ndims (o) != 2)
  76     error ("gls: X, Y and O must be 2-D matrices or vectors");
  77   endif
  78
  79   [rx, cx] = size (x);
  80   [ry, cy] = size (y);
  81   [ro, co] = size (o);
  82   if (rx != ry)
  83     error ("gls: number of rows of X and Y must be equal");
  84   endif
  85   if (!issquare (o) || ro != ry*cy)
  86     error ("gls: matrix O must be square matrix with rows = rows (Y) * cols (Y)");
  87   endif
  88
  89   if (isinteger (x))
  90     x = double (x);
  91   endif
  92   if (isinteger (y))
  93     y = double (y);
  94   endif
  95   if (isinteger (o))
  96     o = double (o);
  97   endif
  98
  99   ## Start of algorithm
 100   o = o^(-1/2);
 101   z = kron (eye (cy), x);
 102   z = o * z;
 103   y1 = o * reshape (y, ry*cy, 1);
 104   u = z' * z;
 105   r = rank (u);
 106
 107   if (r == cx*cy)
 108     b = inv (u) * z' * y1;
 109   else
 110     b = pinv (z) * y1;
 111   endif
 112
 113   beta = reshape (b, cx, cy);
 114
 115   if (isargout (2) || isargout (3))
 116     r = y - x * beta;
 117     if (isargout (2))
 118       v = (reshape (r, ry*cy, 1))' * (o^2) * reshape (r, ry*cy, 1) / (rx*cy - r);
 119     endif
 120   endif
 121
 122 endfunction
 123
 124
 125 %!test
 126 %! x = [1:5]';
 127 %! y = 3*x + 2;
 128 %! x = [x, ones(5,1)];
 129 %! o = diag (ones (5,1));
 130 %! assert (gls (y,x,o), [3; 2], 50*eps);
 131
 132 %% Test input validation
 133 %!error gls ()
 134 %!error gls (1)
 135 %!error gls (1, 2)
 136 %!error gls (1, 2, 3, 4)
 137 %!error gls ([true, true], [1, 2], ones (2))
 138 %!error gls ([1, 2], [true, true], ones (2))
 139 %!error gls ([1, 2], [1, 2], true (2))
 140 %!error gls (ones (2,2,2), ones (2,2), ones (4,4))
 141 %!error gls (ones (2,2), ones (2,2,2), ones (4,4))
 142 %!error gls (ones (2,2), ones (2,2), ones (4,4,4))
 143 %!error gls (ones(1,2), ones(2,2), ones (2,2))
 144 %!error gls (ones(2,2), ones(2,2), ones (2,2))
 145