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