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