octave_packages/m/statistics/distributions/logistic_pdf.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} {} logistic_pdf (@var{x})
  21 ## For each element of @var{x}, compute the PDF at @var{x} of the
  22 ## logistic distribution.
  23 ## @end deftypefn
  24
  25 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
  26 ## Description: PDF of the logistic distribution
  27
  28 function pdf = logistic_pdf (x)
  29
  30   if (nargin != 1)
  31     print_usage ();
  32   endif
  33
  34   if (iscomplex (x))
  35     error ("logistic_pdf: X must not be complex");
  36   endif
  37
  38   cdf = logistic_cdf (x);
  39   pdf = cdf .* (1 - cdf);
  40
  41 endfunction
  42
  43
  44 %!shared x,y
  45 %! x = [-Inf -log(4) 0 log(4) Inf];
  46 %! y = [0, 0.16, 1/4, 0.16, 0];
  47 %!assert(logistic_pdf ([x, NaN]), [y, NaN], eps);
  48
  49 %% Test class of input preserved
  50 %!assert(logistic_pdf (single([x, NaN])), single([y, NaN]), eps ("single"));
  51
  52 %% Test input validation
  53 %!error logistic_pdf ()
  54 %!error logistic_pdf (1,2)
  55 %!error logistic_pdf (i)
  56