octave_packages/m/statistics/distributions/geocdf.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} {} geocdf (@var{x}, @var{p})
  22 ## For each element of @var{x}, compute the cumulative distribution function
  23 ## (CDF) at @var{x} of the geometric distribution with parameter @var{p}.
  24 ## @end deftypefn
  25
  26 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
  27 ## Description: CDF of the geometric distribution
  28
  29 function cdf = geocdf (x, p)
  30
  31   if (nargin != 2)
  32     print_usage ();
  33   endif
  34
  35   if (!isscalar (p))
  36     [retval, x, p] = common_size (x, p);
  37     if (retval > 0)
  38       error ("geocdf: X and P must be of common size or scalars");
  39     endif
  40   endif
  41
  42   if (iscomplex (x) || iscomplex (p))
  43     error ("geocdf: X and P must not be complex");
  44   endif
  45
  46   if (isa (x, "single") || isa (p, "single"))
  47     cdf = zeros (size (x), "single");
  48   else
  49     cdf = zeros (size (x));
  50   endif
  51
  52   k = isnan (x) | !(p >= 0) | !(p <= 1);
  53   cdf(k) = NaN;
  54
  55   k = (x == Inf) & (p >= 0) & (p <= 1);
  56   cdf(k) = 1;
  57
  58   k = (x >= 0) & (x < Inf) & (x == fix (x)) & (p > 0) & (p <= 1);
  59   if (isscalar (p))
  60     cdf(k) = 1 - ((1 - p) .^ (x(k) + 1));
  61   else
  62     cdf(k) = 1 - ((1 - p(k)) .^ (x(k) + 1));
  63   endif
  64
  65 endfunction
  66
  67
  68 %!shared x,y
  69 %! x = [-1 0 1 Inf];
  70 %! y = [0 0.5 0.75 1];
  71 %!assert(geocdf (x, 0.5*ones(1,4)), y);
  72 %!assert(geocdf (x, 0.5), y);
  73 %!assert(geocdf (x, 0.5*[-1 NaN 4 1]), [NaN NaN NaN y(4)]);
  74 %!assert(geocdf ([x(1:2) NaN x(4)], 0.5), [y(1:2) NaN y(4)]);
  75
  76 %% Test class of input preserved
  77 %!assert(geocdf ([x, NaN], 0.5), [y, NaN]);
  78 %!assert(geocdf (single([x, NaN]), 0.5), single([y, NaN]));
  79 %!assert(geocdf ([x, NaN], single(0.5)), single([y, NaN]));
  80
  81 %% Test input validation
  82 %!error geocdf ()
  83 %!error geocdf (1)
  84 %!error geocdf (1,2,3)
  85 %!error geocdf (ones(3),ones(2))
  86 %!error geocdf (ones(2),ones(3))
  87 %!error geocdf (i, 2)
  88 %!error geocdf (2, i)
  89