octave_packages/m/statistics/tests/t_test_2.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{pval}, @var{t}, @var{df}] =} t_test_2 (@var{x}, @var{y}, @var{alt})
  21 ## For two samples x and y from normal distributions with unknown means
  22 ## and unknown equal variances, perform a two-sample t-test of the null
  23 ## hypothesis of equal means.  Under the null, the test statistic
  24 ## @var{t} follows a Student distribution with @var{df} degrees of
  25 ## freedom.
  26 ##
  27 ## With the optional argument string @var{alt}, the alternative of
  28 ## interest can be selected.  If @var{alt} is @code{"!="} or
  29 ## @code{"<>"}, the null is tested against the two-sided alternative
  30 ## @code{mean (@var{x}) != mean (@var{y})}.  If @var{alt} is @code{">"},
  31 ## the one-sided alternative @code{mean (@var{x}) > mean (@var{y})} is
  32 ## used.  Similarly for @code{"<"}, the one-sided alternative @code{mean
  33 ## (@var{x}) < mean (@var{y})} is used.  The default is the two-sided
  34 ## case.
  35 ##
  36 ## The p-value of the test is returned in @var{pval}.
  37 ##
  38 ## If no output argument is given, the p-value of the test is displayed.
  39 ## @end deftypefn
  40
  41 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
  42 ## Description: Student's two-sample t test
  43
  44 function [pval, t, df] = t_test_2 (x, y, alt)
  45
  46   if ((nargin < 2) || (nargin > 3))
  47         print_usage ();
  48   endif
  49
  50   if (! (isvector (x) && isvector (y)))
  51     error ("t_test_2: both X and Y must be vectors");
  52   endif
  53
  54   n_x  = length (x);
  55   n_y  = length (y);
  56   df   = n_x + n_y - 2;
  57   mu_x = sum (x) / n_x;
  58   mu_y = sum (y) / n_y;
  59   v    = sumsq (x - mu_x) + sumsq (y - mu_y);
  60   t    = (mu_x - mu_y) * sqrt ((n_x * n_y * df) / (v * (n_x + n_y)));
  61   cdf  = tcdf (t, df);
  62
  63   if (nargin == 2)
  64     alt = "!=";
  65   endif
  66
  67   if (! ischar (alt))
  68     error ("t_test_2: ALT must be a string");
  69   endif
  70   if (strcmp (alt, "!=") || strcmp (alt, "<>"))
  71     pval = 2 * min (cdf, 1 - cdf);
  72   elseif strcmp (alt, ">")
  73     pval = 1 - cdf;
  74   elseif strcmp (alt, "<")
  75     pval = cdf;
  76   else
  77     error ("t_test_2: option %s not recognized", alt);
  78   endif
  79
  80   if (nargout == 0)
  81     printf ("  pval: %g\n", pval);
  82   endif
  83
  84 endfunction