octave_packages/m/statistics/distributions/empirical_cdf.m

   1 ## Copyright (C) 2012 Rik Wehbring
   2 ## Copyright (C) 1996-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} {} empirical_cdf (@var{x}, @var{data})
  22 ## For each element of @var{x}, compute the cumulative distribution
  23 ## function (CDF) at @var{x} of the empirical distribution obtained from
  24 ## the univariate sample @var{data}.
  25 ## @end deftypefn
  26
  27 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
  28 ## Description: CDF of the empirical distribution
  29
  30 function cdf = empirical_cdf (x, data)
  31
  32   if (nargin != 2)
  33     print_usage ();
  34   endif
  35
  36   if (! isvector (data))
  37     error ("empirical_cdf: DATA must be a vector");
  38   endif
  39
  40   cdf = discrete_cdf (x, data, ones (size (data)));
  41
  42 endfunction
  43
  44
  45 %!shared x,v,y
  46 %! x = [-1 0.1 1.1 1.9 3];
  47 %! v = 0.1:0.2:1.9;
  48 %! y = [0 0.1 0.6 1 1];
  49 %!assert(empirical_cdf (x, v), y, eps);
  50 %!assert(empirical_cdf ([x(1) NaN x(3:5)], v), [0 NaN 0.6 1 1], eps);
  51
  52 %% Test class of input preserved
  53 %!assert(empirical_cdf ([x, NaN], v), [y, NaN], eps);
  54 %!assert(empirical_cdf (single([x, NaN]), v), single([y, NaN]), eps);
  55 %!assert(empirical_cdf ([x, NaN], single(v)), single([y, NaN]), eps);
  56
  57 %% Test input validation
  58 %!error empirical_cdf ()
  59 %!error empirical_cdf (1)
  60 %!error empirical_cdf (1,2,3)
  61 %!error empirical_cdf (1, ones(2))
  62