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