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