home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / octa21fb.zip / octave / SCRIPTS.ZIP / scripts / statistics / base / ols.m < prev    next >
Encoding:
Text File  |  1999-11-20  |  2.8 KB  |  106 lines
  1. ## Copyright (C) 1996, 1997 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 2, or (at your option)
  8. ## 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, write to the Free
  17. ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  18. ## 02111-1307, USA.
  19.  
  20. ##  -*- texinfo -*-
  21. ## @deftypefn {Function File} {[@var{beta}, @var{sigma}, @var{r}] =} ols (@var{y}, @var{x})
  22. ## Ordinary least squares estimation for the multivariate model
  23. ## @iftex
  24. ## @tex
  25. ## $y = x b + e$
  26. ## with
  27. ## $\bar{e} = 0$, and cov(vec($e$)) = kron ($s, I$)
  28. ## @end tex
  29. ## @end iftex
  30. ## @ifinfo
  31. ## @code{@var{y} = @var{x}*@var{b} + @var{e}} with
  32. ## @code{mean (@var{e}) = 0} and @code{cov (vec (@var{e})) = kron (@var{s},
  33. ## @var{I})}.
  34. ## @end ifinfo
  35. ##  where
  36. ## @iftex
  37. ## @tex
  38. ## $y$ is a $t \times p$ matrix, $x$ is a $t \times k$ matrix, 
  39. ## $b$ is a $k \times p$ matrix, and $e$ is a $t \times p$ matrix.
  40. ## @end tex
  41. ## @end iftex
  42. ## @ifinfo
  43. ## @var{y} is a @var{t} by @var{p} matrix, @var{X} is a @var{t} by @var{k}
  44. ## matrix, @var{B} is a @var{k} by @var{p} matrix, and @var{e} is a @var{t}
  45. ## by @var{p} matrix.
  46. ## @end ifinfo
  47. ## 
  48. ## Each row of @var{y} and @var{x} is an observation and each column a
  49. ## variable.
  50. ## 
  51. ## The return values @var{beta}, @var{sigma}, and @var{r} are defined as
  52. ## follows.
  53. ## 
  54. ## @table @var
  55. ## @item beta
  56. ## The OLS estimator for @var{b}, @code{@var{beta} = pinv (@var{x}) *
  57. ## @var{y}}, where @code{pinv (@var{x})} denotes the pseudoinverse of
  58. ## @var{x}.
  59. ## 
  60. ## @item sigma
  61. ## The OLS estimator for the matrix @var{s},
  62. ## 
  63. ## @example
  64. ## @group
  65. ## @var{sigma} = (@var{y}-@var{x}*@var{beta})'
  66. ##   * (@var{y}-@var{x}*@var{beta})
  67. ##   / (@var{t}-rank(@var{x}))
  68. ## @end group
  69. ## @end example
  70. ## 
  71. ## @item r
  72. ## The matrix of OLS residuals, @code{@var{r} = @var{y} - @var{x} *
  73. ## @var{beta}}.
  74. ## @end table
  75. ## @end deftypefn
  76.  
  77. ## Author: Teresa Twaroch <twaroch@ci.tuwien.ac.at>
  78. ## Created: May 1993
  79. ## Adapted-By: jwe
  80.  
  81. function [BETA, SIGMA, R] = ols (Y, X)
  82.  
  83.   if (nargin != 2)
  84.     error("usage : [BETA, SIGMA [, R]] = ols (Y, X)");
  85.   endif
  86.  
  87.   [nr, nc] = size (X);
  88.   [ry, cy] = size (Y);
  89.   if (nr != ry)
  90.     error ("ols: incorrect matrix dimensions");
  91.   endif
  92.  
  93.   Z = X' * X;
  94.   r = rank (Z);
  95.  
  96.   if (r == nc)
  97.     BETA = inv (Z) * X' * Y;
  98.   else
  99.     BETA = pinv (X) * Y;
  100.   endif
  101.  
  102.   R = Y - X * BETA;
  103.   SIGMA = R' * R / (nr - r);
  104.  
  105. endfunction
  106.