octave_packages/m/statistics/distributions/normcdf.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} {} normcdf (@var{x})
  22 ## @deftypefnx {Function File} {} normcdf (@var{x}, @var{mu}, @var{sigma})
  23 ## For each element of @var{x}, compute the cumulative distribution
  24 ## function (CDF) at @var{x} of the normal distribution with mean
  25 ## @var{mu} and standard deviation @var{sigma}.
  26 ##
  27 ## Default values are @var{mu} = 0, @var{sigma} = 1.
  28 ## @end deftypefn
  29
  30 ## Author: TT <Teresa.Twaroch@ci.tuwien.ac.at>
  31 ## Description: CDF of the normal distribution
  32
  33 function cdf = normcdf (x, mu = 0, sigma = 1)
  34
  35   if (nargin != 1 && nargin != 3)
  36     print_usage ();
  37   endif
  38
  39   if (!isscalar (mu) || !isscalar (sigma))
  40     [retval, x, mu, sigma] = common_size (x, mu, sigma);
  41     if (retval > 0)
  42       error ("normcdf: X, MU, and SIGMA must be of common size or scalars");
  43     endif
  44   endif
  45
  46   if (iscomplex (x) || iscomplex (mu) || iscomplex (sigma))
  47     error ("normcdf: X, MU, and SIGMA must not be complex");
  48   endif
  49
  50   if (isa (x, "single") || isa (mu, "single") || isa (sigma, "single"));
  51     cdf = zeros (size (x), "single");
  52   else
  53     cdf = zeros (size (x));
  54   endif
  55
  56   if (isscalar (mu) && isscalar (sigma))
  57     if (!isinf (mu) && !isnan (mu) && (sigma > 0) && (sigma < Inf))
  58       cdf = stdnormal_cdf ((x - mu) / sigma);
  59     else
  60       cdf = NaN (size (x), class (cdf));
  61     endif
  62   else
  63     k = isinf (mu) | isnan (mu) | !(sigma > 0) | !(sigma < Inf);
  64     cdf(k) = NaN;
  65
  66     k = ! k;
  67     cdf(k) = stdnormal_cdf ((x(k) - mu(k)) ./ sigma(k));
  68   endif
  69
  70 endfunction
  71
  72
  73 %!shared x,y
  74 %! x = [-Inf 1 2 Inf];
  75 %! y = [0, 0.5, 1/2*(1+erf(1/sqrt(2))), 1];
  76 %!assert(normcdf (x, ones(1,4), ones(1,4)), y);
  77 %!assert(normcdf (x, 1, ones(1,4)), y);
  78 %!assert(normcdf (x, ones(1,4), 1), y);
  79 %!assert(normcdf (x, [0 -Inf NaN Inf], 1), [y(1) NaN NaN NaN]);
  80 %!assert(normcdf (x, 1, [Inf NaN -1 0]), [NaN NaN NaN NaN]);
  81 %!assert(normcdf ([x(1:2) NaN x(4)], 1, 1), [y(1:2) NaN y(4)]);
  82
  83 %% Test class of input preserved
  84 %!assert(normcdf ([x, NaN], 1, 1), [y, NaN]);
  85 %!assert(normcdf (single([x, NaN]), 1, 1), single([y, NaN]), eps("single"));
  86 %!assert(normcdf ([x, NaN], single(1), 1), single([y, NaN]), eps("single"));
  87 %!assert(normcdf ([x, NaN], 1, single(1)), single([y, NaN]), eps("single"));
  88
  89 %% Test input validation
  90 %!error normcdf ()
  91 %!error normcdf (1,2)
  92 %!error normcdf (1,2,3,4)
  93 %!error normcdf (ones(3),ones(2),ones(2))
  94 %!error normcdf (ones(2),ones(3),ones(2))
  95 %!error normcdf (ones(2),ones(2),ones(3))
  96 %!error normcdf (i, 2, 2)
  97 %!error normcdf (2, i, 2)
  98 %!error normcdf (2, 2, i)
  99