octave_packages/m/statistics/tests/z_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{z}] =} z_test_2 (@var{x}, @var{y}, @var{v_x}, @var{v_y}, @var{alt})
  21 ## For two samples @var{x} and @var{y} from normal distributions with
  22 ## unknown means and known variances @var{v_x} and @var{v_y}, perform a
  23 ## Z-test of the hypothesis of equal means.  Under the null, the test
  24 ## statistic @var{z} follows a standard normal distribution.
  25 ##
  26 ## With the optional argument string @var{alt}, the alternative of
  27 ## interest can be selected.  If @var{alt} is @code{"!="} or
  28 ## @code{"<>"}, the null is tested against the two-sided alternative
  29 ## @code{mean (@var{x}) != mean (@var{y})}.  If alt is @code{">"}, the
  30 ## one-sided alternative @code{mean (@var{x}) > mean (@var{y})} is used.
  31 ## Similarly for @code{"<"}, the one-sided alternative @code{mean
  32 ## (@var{x}) < mean (@var{y})} is used.  The default is the two-sided
  33 ## case.
  34 ##
  35 ## The p-value of the test is returned in @var{pval}.
  36 ##
  37 ## If no output argument is given, the p-value of the test is displayed
  38 ## along with some information.
  39 ## @end deftypefn
  40
  41 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
  42 ## Description: Compare means of two normal samples with known variances
  43
  44 function [pval, z] = z_test_2 (x, y, v_x, v_y, alt)
  45
  46   if ((nargin < 4) || (nargin > 5))
  47     print_usage ();
  48   endif
  49
  50   if (! (isvector (x) && isvector (y)))
  51     error("z_test_2: both X and Y must be vectors");
  52   elseif (! (isscalar (v_x) && (v_x > 0)
  53              && isscalar (v_y) && (v_y > 0)))
  54     error ("z_test_2: both V_X and V_Y must be positive scalars");
  55   endif
  56
  57   n_x  = length (x);
  58   n_y  = length (y);
  59   mu_x = sum (x) / n_x;
  60   mu_y = sum (y) / n_y;
  61   z    = (mu_x - mu_y) / sqrt (v_x / n_x + v_y / n_y);
  62   cdf  = stdnormal_cdf (z);
  63
  64   if (nargin == 4)
  65     alt = "!=";
  66   endif
  67
  68   if (! ischar (alt))
  69     error ("z_test_2: ALT must be a string");
  70   elseif (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 ("z_test_2: option %s not recognized", alt);
  78   endif
  79
  80   if (nargout == 0)
  81     s = cstrcat ("Two-sample Z-test of mean(x) == mean(y) against ",
  82                 "mean(x) %s mean(y),\n",
  83                 "with known var(x) == %g and var(y) == %g:\n",
  84                 "  pval = %g\n");
  85     printf (s, alt, v_x, v_y, pval);
  86   endif
  87
  88 endfunction