home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / octa21eb.zip / octave / SCRIPTS.ZIP / scripts / statistics / tests / z_test.m < prev   
Text File  |  1997-06-01  |  3KB  |  84 lines
  1. ## Copyright (C) 1995, 1996, 1997  Kurt Hornik
  2. ## 
  3. ## This program is free software; you can redistribute it and/or modify
  4. ## it under the terms of the GNU General Public License as published by
  5. ## the Free Software Foundation; either version 2, or (at your option)
  6. ## any later version.
  7. ## 
  8. ## This program is distributed in the hope that it will be useful, but
  9. ## WITHOUT ANY WARRANTY; without even the implied warranty of
  10. ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11. ## General Public License for more details. 
  12. ## 
  13. ## You should have received a copy of the GNU General Public License
  14. ## along with this file.  If not, write to the Free Software Foundation,
  15. ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  16.  
  17. ## usage:  [pval, z] = z_test (x, m, v [, alt])
  18. ##
  19. ## Perform a Z-test of the null hypothesis mean(x) == m for a sample x 
  20. ## from a normal distribution with unknown mean and known variance v. 
  21. ## Under the null, the test statistic z follows a standard normal
  22. ## distribution.
  23. ##
  24. ## With the optional argument string alt, the alternative of interest
  25. ## can be selected.  
  26. ## If alt is "!=" or "<>", the null is tested against the two-sided
  27. ## alternative mean(x) != m.
  28. ## If alt is ">", the one-sided alternative mean(x) > m is considered, 
  29. ## similarly for "<".  
  30. ## The default is the two-sided case.
  31. ##
  32. ## pval is the p-value of the test.
  33. ##  
  34. ## If no output argument is given, the p-value of the test is displayed
  35. ## along with some information. 
  36.  
  37. ## Author:  KH <Kurt.Hornik@ci.tuwien.ac.at>
  38. ## Description:  Test for mean of a normal sample with known variance
  39.  
  40. function [pval, z] = z_test (x, m, v, alt)
  41.   
  42.   if ((nargin < 3) || (nargin > 4))
  43.     usage ("[pval, z] = z_test (x, m, v [, alt])");
  44.   endif
  45.     
  46.   if (! is_vector (x))
  47.     error ("z_test:  x must be a vector.");
  48.   endif
  49.   if (! is_scalar (m))
  50.     error ("z_test:  m must be a scalar.");
  51.   endif
  52.   if (! (is_scalar (v) && (v > 0)))
  53.     error ("z_test:  v must be a positive scalar.");
  54.   endif
  55.   
  56.   n = length (x);
  57.   z = sqrt (n/v) * (sum (x) / n - m);
  58.   cdf = stdnormal_cdf (z);
  59.   
  60.   if (nargin == 3)
  61.     alt = "!=";
  62.   endif
  63.  
  64.   if (! isstr (alt))
  65.     error ("z_test:  alt must be a string");
  66.   elseif (strcmp (alt, "!=") || strcmp (alt, "<>"))
  67.     pval = 2 * min (cdf, 1 - cdf);
  68.   elseif (strcmp (alt, ">"))
  69.     pval = 1 - cdf;
  70.   elseif (strcmp (alt, "<"))
  71.     pval = cdf;
  72.   else
  73.     error (sprintf ("z_test:  option %s not recognized", alt));
  74.   endif
  75.   
  76.   if (nargout == 0)
  77.     s = strcat ("Z-test of mean(x) == %g against mean(x) %s %g,\n",
  78.               "with known var(x) == %g:\n",
  79.               "  pval = %g\n");
  80.     printf (s, m, alt, m, v, pval);
  81.   endif
  82.  
  83. endfunction
  84.