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