octave_packages/m/statistics/base/logit.m

   1 ## Copyright (C) 1995-2012 Kurt Hornik
   2 ##
   3 ## This file is part of Octave.
   4 ##
   5 ## Octave is free software; you can redistribute it and/or modify it
   6 ## under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   9 ##
  10 ## Octave is distributed in the hope that it will be useful, but
  11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 ## General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn {Function File} {} logit (@var{p})
  21 ## For each component of @var{p}, return the logit of @var{p} defined as
  22 ## @tex
  23 ## $$
  24 ## {\rm logit}(p) = \log\Big({p \over 1-p}\Big)
  25 ## $$
  26 ## @end tex
  27 ## @ifnottex
  28 ##
  29 ## @example
  30 ## logit (@var{p}) = log (@var{p} / (1-@var{p}))
  31 ## @end example
  32 ##
  33 ## @end ifnottex
  34 ## @seealso{logistic_cdf}
  35 ## @end deftypefn
  36
  37 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
  38 ## Description: Logit transformation
  39
  40 function y = logit (p)
  41
  42   if (nargin != 1)
  43     print_usage ();
  44   endif
  45
  46   y = logistic_inv (p);
  47
  48 endfunction
  49
  50
  51 %!test
  52 %! p = [0.01:0.01:0.99];
  53 %! assert(logit (p), log (p ./ (1-p)), 25*eps)
  54
  55 %!assert(logit ([-1, 0, 0.5, 1, 2]), [NaN, -Inf, 0, +Inf, NaN])
  56
  57 %% Test input validation
  58 %!error logit ()
  59 %!error logit (1, 2)