octave_packages/m/statistics/distributions/logistic_inv.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} {} logistic_inv (@var{x})
  22 ## For each element of @var{x}, compute the quantile (the inverse of
  23 ## the CDF) at @var{x} of the logistic distribution.
  24 ## @end deftypefn
  25
  26 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
  27 ## Description: Quantile function of the logistic distribution
  28
  29 function inv = logistic_inv (x)
  30
  31   if (nargin != 1)
  32     print_usage ();
  33   endif
  34
  35   if (iscomplex (x))
  36     error ("logistic_inv: X must not be complex");
  37   endif
  38
  39   if (isa (x, "single"))
  40     inv = NaN (size (x), "single");
  41   else
  42     inv = NaN (size (x));
  43   endif
  44
  45   k = (x == 0);
  46   inv(k) = -Inf;
  47
  48   k = (x == 1);
  49   inv(k) = Inf;
  50
  51   k = (x > 0) & (x < 1);
  52   inv(k) = - log (1 ./ x(k) - 1);
  53
  54 endfunction
  55
  56
  57 %!shared x
  58 %! x = [-1 0 0.5 1 2];
  59 %!assert(logistic_inv (x), [NaN -Inf 0 Inf NaN]);
  60
  61 %% Test class of input preserved
  62 %!assert(logistic_inv ([x, NaN]), [NaN -Inf 0 Inf NaN NaN]);
  63 %!assert(logistic_inv (single([x, NaN])), single([NaN -Inf 0 Inf NaN NaN]));
  64
  65 %% Test input validation
  66 %!error logistic_inv ()
  67 %!error logistic_inv (1,2)
  68 %!error logistic_inv (i)
  69