octave_packages/m/statistics/tests/hotelling_test.m

   1 ## Copyright (C) 1996-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{pval}, @var{tsq}] =} hotelling_test (@var{x}, @var{m})
  21 ## For a sample @var{x} from a multivariate normal distribution with unknown
  22 ## mean and covariance matrix, test the null hypothesis that @code{mean
  23 ## (@var{x}) == @var{m}}.
  24 ##
  25 ## Hotelling's @math{T^2} is returned in @var{tsq}.  Under the null,
  26 ## @math{(n-p) T^2 / (p(n-1))} has an F distribution with @math{p} and
  27 ## @math{n-p} degrees of freedom, where @math{n} and @math{p} are the
  28 ## numbers of samples and variables, respectively.
  29 ##
  30 ## The p-value of the test is returned in @var{pval}.
  31 ##
  32 ## If no output argument is given, the p-value of the test is displayed.
  33 ## @end deftypefn
  34
  35 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
  36 ## Description: Test for mean of a multivariate normal
  37
  38 function [pval, Tsq] = hotelling_test (x, m)
  39
  40   if (nargin != 2)
  41     print_usage ();
  42   endif
  43
  44   if (isvector (x))
  45     if (! isscalar (m))
  46       error ("hotelling_test: if X is a vector, M must be a scalar");
  47     endif
  48     n = length (x);
  49     p = 1;
  50   elseif (ismatrix (x))
  51     [n, p] = size (x);
  52     if (n <= p)
  53       error ("hotelling_test: X must have more rows than columns");
  54     endif
  55     if (isvector (m) && length (m) == p)
  56       m = reshape (m, 1, p);
  57     else
  58       error ("hotelling_test: if X is a matrix, M must be a vector of length columns (X)");
  59     endif
  60   else
  61     error ("hotelling_test: X must be a matrix or vector");
  62   endif
  63
  64   d    = mean (x) - m;
  65   Tsq  = n * d * (cov (x) \ d');
  66   pval = 1 - fcdf ((n-p) * Tsq / (p * (n-1)), p, n-p);
  67
  68   if (nargout == 0)
  69     printf ("  pval: %g\n", pval);
  70   endif
  71
  72 endfunction