changeset 12495:4675ce154a55

Correctly refer to "discrete uniform" distribution in documentation.
author Rik <octave@nomad.inbox5.com>
date Wed, 02 Mar 2011 20:38:27 -0800
parents ce831dc80bdb
children 245b5efb07c2
files doc/ChangeLog doc/interpreter/stats.txi scripts/ChangeLog scripts/statistics/distributions/unidcdf.m scripts/statistics/distributions/unidinv.m scripts/statistics/distributions/unidpdf.m scripts/statistics/distributions/unidrnd.m
diffstat 7 files changed, 31 insertions(+), 12 deletions(-) [+]
line wrap: on
line diff
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,8 @@
+2010-03-02  Rik  <octave@nomad.inbox5.com>
+
+	* interpreter/stats.txi: Correctly refer to discrete uniform 
+	distribution in documentation. 
+
 2011-03-01  Jordi GutiƩrrez Hermoso  <jordigh@gmail.com>
 
 	* interpreter/dynamic.txi: Make it clear that <octave/oct.h> is
--- a/doc/interpreter/stats.txi
+++ b/doc/interpreter/stats.txi
@@ -205,18 +205,18 @@
 &F            && fpdf           && fcdf          && finv&\cr
 &Gamma        && gampdf         && gamcdf        && gaminv&\cr
 &Geometric    && geopdf         && geocdf        && geoinv&\cr
-&Hypergeometric            && hygepdf      && hygecdf       && hygeinv&\cr
+&Hypergeometric  && hygepdf     && hygecdf       && hygeinv&\cr
 &Kolmogorov Smirnov && {\it Not Available} && kolmogorov\_&& {\it Not Available}&\cr
 &             &&                && smirnov\_cdf &&&\cr
-&Laplace      && laplace\_pdf    && laplace\_cdf   && laplace\_inv&\cr
-&Logistic     && logistic\_pdf   && logistic\_cdf  && logistic\_inv&\cr
+&Laplace      && laplace\_pdf   && laplace\_cdf  && laplace\_inv&\cr
+&Logistic     && logistic\_pdf  && logistic\_cdf && logistic\_inv&\cr
 &Log-Normal   && lognpdf        && logncdf       && logninv&\cr
 &Univariate Normal && normpdf   && normcdf       && norminv&\cr
 &Pascal       && nbinpdf        && nbincdf       && nbininv&\cr
 &Poisson      && poisspdf       && poisscdf      && poissinv&\cr
 &Standard Normal && stdnormal\_pdf  && stdnormal\_cdf && stdnormal\_inv&\cr
 &t (Student)  && tpdf           && tcdf          && tinv&\cr
-&Univariate Discrete && unidpdf && unidcdf       && unidinv&\cr
+&Uniform Discrete && unidpdf    && unidcdf       && unidinv&\cr
 &Uniform      && unifpdf        && unifcdf       && unifinv&\cr
 &Weibull      && wblpdf         && wblcdf        && wblinv&\cr
 \noalign{\hrule height 0.6pt}
--- a/scripts/ChangeLog
+++ b/scripts/ChangeLog
@@ -1,3 +1,10 @@
+2010-03-02  Rik  <octave@nomad.inbox5.com>
+
+	* statistics/distributions/unidcdf.m,
+	statistics/distributions/unidinv.m, statistics/distributions/unidpdf.m,
+	statistics/distributions/unidrnd.m: Correctly refer to distribution as
+	discrete uniform in docstring.
+
 2011-03-02  Konstantinos Poulios  <logari81@gmail.com>
 
 	* plot/subplot.m: Remove redundant calls.
--- a/scripts/statistics/distributions/unidcdf.m
+++ b/scripts/statistics/distributions/unidcdf.m
@@ -19,8 +19,10 @@
 ## -*- texinfo -*-
 ## @deftypefn {Function File} {} unidcdf (@var{x}, @var{v})
 ## For each element of @var{x}, compute the cumulative distribution
-## function (CDF) at @var{x} of a univariate discrete distribution which
-## assumes the values in @var{v} with equal probability.
+## function (CDF) at @var{x} of a discrete uniform distribution which
+## assumes the values in @var{v} with equal probability.  
+## If @var{v} is a scalar then @code{1/@var{v}} is the probability of a
+## single element.
 ## @end deftypefn
 
 function cdf = unidcdf (x, v)
@@ -36,4 +38,5 @@
   endif
 
   cdf = discrete_cdf (x, v, ones(size(v)));
+
 endfunction
--- a/scripts/statistics/distributions/unidinv.m
+++ b/scripts/statistics/distributions/unidinv.m
@@ -19,8 +19,10 @@
 ## -*- texinfo -*-
 ## @deftypefn {Function File} {} unidinv (@var{x}, @var{v})
 ## For each component of @var{x}, compute the quantile (the inverse of
-## the CDF) at @var{x} of the univariate discrete distribution which assumes the
-## values in @var{v} with equal probability
+## the CDF) at @var{x} of the discrete uniform distribution which assumes the
+## values in @var{v} with equal probability. 
+## If @var{v} is a scalar then @code{1/@var{v}} is the probability of a
+## single element.
 ## @end deftypefn
 
 function inv = unidinv (x, v)
--- a/scripts/statistics/distributions/unidpdf.m
+++ b/scripts/statistics/distributions/unidpdf.m
@@ -19,8 +19,10 @@
 ## -*- texinfo -*-
 ## @deftypefn {Function File} {} unidpdf (@var{x}, @var{v})
 ## For each element of @var{x}, compute the probability density function
-## (PDF) at @var{x} of a univariate discrete distribution which assumes
+## (PDF) at @var{x} of a discrete uniform distribution which assumes
 ## the values in @var{v} with equal probability.
+## If @var{v} is a scalar then @code{1/@var{v}} is the probability of a
+## single element.
 ## @end deftypefn
 
 function pdf = unidpdf (x, v)
--- a/scripts/statistics/distributions/unidrnd.m
+++ b/scripts/statistics/distributions/unidrnd.m
@@ -20,9 +20,9 @@
 ## @deftypefn  {Function File} {} unidrnd (@var{mx});
 ## @deftypefnx {Function File} {} unidrnd (@var{mx}, @var{v});
 ## @deftypefnx {Function File} {} unidrnd (@var{mx}, @var{m}, @var{n}, @dots{});
-## Return random values from discrete uniform distribution, with maximum
-## value(s) given by the integer @var{mx}, which may be a scalar or
-## multi-dimensional array.
+## Return random values from a discrete uniform distribution with maximum
+## value(s) given by the integer @var{mx} (which may be a scalar or
+## multi-dimensional array).
 ##
 ## If @var{mx} is a scalar, the size of the result is specified by
 ## the vector @var{v}, or by the optional arguments @var{m}, @var{n},