octave_packages/m/statistics/distributions/chi2cdf.m

   1 ## Copyright (C) 2012 Rik Wehbring
   2 ## Copyright (C) 1995-2012 Kurt Hornik
   3 ##
   4 ## This file is part of Octave.
   5 ##
   6 ## Octave is free software; you can redistribute it and/or modify it
   7 ## under the terms of the GNU General Public License as published by
   8 ## the Free Software Foundation; either version 3 of the License, or (at
   9 ## your option) any later version.
  10 ##
  11 ## Octave is distributed in the hope that it will be useful, but
  12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 ## General Public License for more details.
  15 ##
  16 ## You should have received a copy of the GNU General Public License
  17 ## along with Octave; see the file COPYING.  If not, see
  18 ## <http://www.gnu.org/licenses/>.
  19
  20 ## -*- texinfo -*-
  21 ## @deftypefn {Function File} {} chi2cdf (@var{x}, @var{n})
  22 ## For each element of @var{x}, compute the cumulative distribution
  23 ## function (CDF) at @var{x} of the chi-square distribution with @var{n}
  24 ## degrees of freedom.
  25 ## @end deftypefn
  26
  27 ## Author: TT <Teresa.Twaroch@ci.tuwien.ac.at>
  28 ## Description: CDF of the chi-square distribution
  29
  30 function cdf = chi2cdf (x, n)
  31
  32   if (nargin != 2)
  33     print_usage ();
  34   endif
  35
  36   if (!isscalar (n))
  37     [retval, x, n] = common_size (x, n);
  38     if (retval > 0)
  39       error ("chi2cdf: X and N must be of common size or scalars");
  40     endif
  41   endif
  42
  43   if (iscomplex (x) || iscomplex (n))
  44     error ("chi2cdf: X and N must not be complex");
  45   endif
  46
  47   cdf = gamcdf (x, n/2, 2);
  48
  49 endfunction
  50
  51
  52 %!shared x,y
  53 %! x = [-1 0 0.5 1 2];
  54 %! y = [0, 1 - exp(-x(2:end)/2)];
  55 %!assert(chi2cdf (x, 2*ones(1,5)), y, eps);
  56 %!assert(chi2cdf (x, 2), y, eps);
  57 %!assert(chi2cdf (x, 2*[1 0 NaN 1 1]), [y(1) NaN NaN y(4:5)], eps);
  58 %!assert(chi2cdf ([x(1:2) NaN x(4:5)], 2), [y(1:2) NaN y(4:5)], eps);
  59
  60 %% Test class of input preserved
  61 %!assert(chi2cdf ([x, NaN], 2), [y, NaN], eps);
  62 %!assert(chi2cdf (single([x, NaN]), 2), single([y, NaN]), eps("single"));
  63 %!assert(chi2cdf ([x, NaN], single(2)), single([y, NaN]), eps("single"));
  64
  65 %% Test input validation
  66 %!error chi2cdf ()
  67 %!error chi2cdf (1)
  68 %!error chi2cdf (1,2,3)
  69 %!error chi2cdf (ones(3),ones(2))
  70 %!error chi2cdf (ones(2),ones(3))
  71 %!error chi2cdf (i, 2)
  72 %!error chi2cdf (2, i)
  73