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