octave_packages/m/statistics/distributions/unidcdf.m

   1 ## Copyright (C) 2012 Rik Wehbring
   2 ## Copyright (C) 2007-2012 David Bateman
   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} {} unidcdf (@var{x}, @var{n})
  22 ## For each element of @var{x}, compute the cumulative distribution
  23 ## function (CDF) at @var{x} of a discrete uniform distribution which assumes
  24 ## the integer values 1--@var{n} with equal probability.
  25 ## @end deftypefn
  26
  27 function cdf = unidcdf (x, n)
  28
  29   if (nargin != 2)
  30     print_usage ();
  31   endif
  32
  33   if (! isscalar (n))
  34     [retval, x, n] = common_size (x, n);
  35     if (retval > 0)
  36       error ("unidcdf: X and N must be of common size or scalars");
  37     endif
  38   endif
  39
  40   if (iscomplex (x) || iscomplex (n))
  41     error ("unidcdf: X and N must not be complex");
  42   endif
  43
  44   if (isa (x, "single") || isa (n, "single"))
  45     cdf = zeros (size (x), "single");
  46   else
  47     cdf = zeros (size (x));
  48   endif
  49
  50   knan = isnan (x) | ! (n > 0 & n == fix (n));
  51   if (any (knan(:)))
  52     cdf(knan) = NaN;
  53   endif
  54
  55   k = (x >= n) & !knan;
  56   cdf(k) = 1;
  57
  58   k = (x >= 1) & (x < n) & !knan;
  59   if (isscalar (n))
  60     cdf(k) = floor (x(k)) / n;
  61   else
  62     cdf(k) = floor (x(k)) ./ n(k);
  63   endif
  64
  65 endfunction
  66
  67
  68 %!shared x,y
  69 %! x = [0 1 2.5 10 11];
  70 %! y = [0, 0.1 0.2 1.0 1.0];
  71 %!assert(unidcdf (x, 10*ones(1,5)), y);
  72 %!assert(unidcdf (x, 10), y);
  73 %!assert(unidcdf (x, 10*[0 1 NaN 1 1]), [NaN 0.1 NaN y(4:5)]);
  74 %!assert(unidcdf ([x(1:2) NaN Inf x(5)], 10), [y(1:2) NaN 1 y(5)]);
  75
  76 %% Test class of input preserved
  77 %!assert(unidcdf ([x, NaN], 10), [y, NaN]);
  78 %!assert(unidcdf (single([x, NaN]), 10), single([y, NaN]));
  79 %!assert(unidcdf ([x, NaN], single(10)), single([y, NaN]));
  80
  81 %% Test input validation
  82 %!error unidcdf ()
  83 %!error unidcdf (1)
  84 %!error unidcdf (1,2,3)
  85 %!error unidcdf (ones(3),ones(2))
  86 %!error unidcdf (ones(2),ones(3))
  87 %!error unidcdf (i, 2)
  88 %!error unidcdf (2, i)
  89