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