octave: scripts/statistics/distributions/nbincdf.m annotate

annotate scripts/statistics/distributions/nbincdf.m @ 20174:d9341b422488 stable

doc: Update more docstrings to have one sentence summary as first line. Reviewed statistics/ and @ftp/ in scripts directory. * scripts/@ftp/ascii.m, scripts/@ftp/binary.m, scripts/@ftp/cd.m, scripts/@ftp/dir.m, scripts/@ftp/ftp.m, scripts/@ftp/mget.m, scripts/@ftp/mput.m, scripts/statistics/base/center.m, scripts/statistics/base/cloglog.m, scripts/statistics/base/cov.m, scripts/statistics/base/gls.m, scripts/statistics/base/histc.m, scripts/statistics/base/iqr.m, scripts/statistics/base/kendall.m, scripts/statistics/base/kurtosis.m, scripts/statistics/base/logit.m, scripts/statistics/base/lscov.m, scripts/statistics/base/mahalanobis.m, scripts/statistics/base/mean.m, scripts/statistics/base/meansq.m, scripts/statistics/base/median.m, scripts/statistics/base/mode.m, scripts/statistics/base/moment.m, scripts/statistics/base/ols.m, scripts/statistics/base/ppplot.m, scripts/statistics/base/prctile.m, scripts/statistics/base/probit.m, scripts/statistics/base/range.m, scripts/statistics/base/ranks.m, scripts/statistics/base/run_count.m, scripts/statistics/base/runlength.m, scripts/statistics/base/skewness.m, scripts/statistics/base/spearman.m, scripts/statistics/base/statistics.m, scripts/statistics/base/std.m, scripts/statistics/base/table.m, scripts/statistics/base/var.m, scripts/statistics/base/zscore.m, scripts/statistics/distributions/betainv.m, scripts/statistics/distributions/binoinv.m, scripts/statistics/distributions/binopdf.m, scripts/statistics/distributions/cauchy_cdf.m, scripts/statistics/distributions/cauchy_inv.m, scripts/statistics/distributions/cauchy_pdf.m, scripts/statistics/distributions/chi2cdf.m, scripts/statistics/distributions/chi2inv.m, scripts/statistics/distributions/chi2pdf.m, scripts/statistics/distributions/discrete_cdf.m, scripts/statistics/distributions/discrete_inv.m, scripts/statistics/distributions/discrete_pdf.m, scripts/statistics/distributions/empirical_cdf.m, scripts/statistics/distributions/empirical_inv.m, scripts/statistics/distributions/empirical_pdf.m, scripts/statistics/distributions/expcdf.m, scripts/statistics/distributions/expinv.m, scripts/statistics/distributions/exppdf.m, scripts/statistics/distributions/finv.m, scripts/statistics/distributions/fpdf.m, scripts/statistics/distributions/gamcdf.m, scripts/statistics/distributions/gaminv.m, scripts/statistics/distributions/gampdf.m, scripts/statistics/distributions/geoinv.m, scripts/statistics/distributions/geopdf.m, scripts/statistics/distributions/hygecdf.m, scripts/statistics/distributions/hygeinv.m, scripts/statistics/distributions/hygepdf.m, scripts/statistics/distributions/kolmogorov_smirnov_cdf.m, scripts/statistics/distributions/laplace_cdf.m, scripts/statistics/distributions/laplace_inv.m, scripts/statistics/distributions/laplace_pdf.m, scripts/statistics/distributions/logistic_inv.m, scripts/statistics/distributions/logncdf.m, scripts/statistics/distributions/logninv.m, scripts/statistics/distributions/lognpdf.m, scripts/statistics/distributions/nbincdf.m, scripts/statistics/distributions/nbininv.m, scripts/statistics/distributions/nbinpdf.m, scripts/statistics/distributions/nbinrnd.m, scripts/statistics/distributions/normcdf.m, scripts/statistics/distributions/norminv.m, scripts/statistics/distributions/normpdf.m, scripts/statistics/distributions/poisscdf.m, scripts/statistics/distributions/poissinv.m, scripts/statistics/distributions/poisspdf.m, scripts/statistics/distributions/stdnormal_cdf.m, scripts/statistics/distributions/stdnormal_pdf.m, scripts/statistics/distributions/tcdf.m, scripts/statistics/distributions/tinv.m, scripts/statistics/distributions/tpdf.m, scripts/statistics/distributions/unidcdf.m, scripts/statistics/distributions/unidinv.m, scripts/statistics/distributions/unidpdf.m, scripts/statistics/distributions/unidrnd.m, scripts/statistics/distributions/unifcdf.m, scripts/statistics/distributions/unifinv.m, scripts/statistics/distributions/wblcdf.m, scripts/statistics/distributions/wblinv.m, scripts/statistics/distributions/wblpdf.m, scripts/statistics/distributions/wienrnd.m, scripts/statistics/models/private/logistic_regression_derivatives.m, scripts/statistics/models/private/logistic_regression_likelihood.m, scripts/statistics/tests/anova.m, scripts/statistics/tests/chisquare_test_homogeneity.m, scripts/statistics/tests/chisquare_test_independence.m, scripts/statistics/tests/cor_test.m, scripts/statistics/tests/f_test_regression.m, scripts/statistics/tests/hotelling_test.m, scripts/statistics/tests/kolmogorov_smirnov_test.m, scripts/statistics/tests/kolmogorov_smirnov_test_2.m, scripts/statistics/tests/kruskal_wallis_test.m, scripts/statistics/tests/manova.m, scripts/statistics/tests/mcnemar_test.m, scripts/statistics/tests/prop_test_2.m, scripts/statistics/tests/run_test.m, scripts/statistics/tests/sign_test.m, scripts/statistics/tests/t_test.m, scripts/statistics/tests/t_test_2.m, scripts/statistics/tests/t_test_regression.m, scripts/statistics/tests/u_test.m, scripts/statistics/tests/var_test.m, scripts/statistics/tests/welch_test.m, scripts/statistics/tests/wilcoxon_test.m, scripts/statistics/tests/z_test.m, scripts/statistics/tests/z_test_2.m: Update more docstrings to have one sentence summary as first line.

author	Rik <rik@octave.org>
date	Sun, 10 May 2015 16:07:41 -0700
parents	9fc020886ae9
children	516bb87ea72e

rev	line source
14138 72c96de7a403 maint: update copyright notices for 2012 John W. Eaton <jwe@octave.org> parents: 13171 diff changeset	1 ## Copyright (C) 2012 Rik Wehbring
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19593 diff changeset	2 ## Copyright (C) 1995-2015 Kurt Hornik
6349 859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	3 ##
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	4 ## This file is part of Octave.
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	5 ##
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	6 ## Octave is free software; you can redistribute it and/or modify it
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	7 ## under the terms of the GNU General Public License as published by
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6349 diff changeset	8 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6349 diff changeset	9 ## your option) any later version.
6349 859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	10 ##
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	11 ## Octave is distributed in the hope that it will be useful, but
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	14 ## General Public License for more details.
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	15 ##
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	16 ## You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6349 diff changeset	17 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6349 diff changeset	18 ## <http://www.gnu.org/licenses/>.
6349 859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	19
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	20 ## -- texinfo --
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	21 ## @deftypefn {Function File} {} nbincdf (@var{x}, @var{n}, @var{p})
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	22 ## For each element of @var{x}, compute the cumulative distribution function
20174 d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	23 ## (CDF) at @var{x} of the negative binomial distribution with parameters
d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	24 ## @var{n} and @var{p}.
6349 859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	25 ##
20174 d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	26 ## When @var{n} is integer this is the Pascal distribution.
d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	27 ## When @var{n} is extended to real numbers this is the Polya distribution.
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	28 ##
20174 d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	29 ## The number of failures in a Bernoulli experiment with success probability
d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	30 ## @var{p} before the @var{n}-th success follows this distribution.
6349 859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	31 ## @end deftypefn
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	32
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	33 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	34 ## Description: CDF of the Pascal (negative binomial) distribution
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	35
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	36 function cdf = nbincdf (x, n, p)
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	37
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	38 if (nargin != 3)
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	39 print_usage ();
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	40 endif
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	41
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	42 if (! isscalar (n) \|\| ! isscalar (p))
6349 859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	43 [retval, x, n, p] = common_size (x, n, p);
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	44 if (retval > 0)
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	45 error ("nbincdf: X, N, and P must be of common size or scalars");
6349 859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	46 endif
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	47 endif
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	48
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	49 if (iscomplex (x) \|\| iscomplex (n) \|\| iscomplex (p))
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	50 error ("nbincdf: X, N, and P must not be complex");
6349 859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	51 endif
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	52
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	53 if (isa (x, "single") \|\| isa (n, "single") \|\| isa (p, "single"))
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	54 cdf = zeros (size (x), "single");
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	55 else
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	56 cdf = zeros (size (x));
6349 859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	57 endif
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	58
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	59 k = (isnan (x) \| isnan (n) \| (n < 1) \| (n == Inf)
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	60 \| (p < 0) \| (p > 1) \| isnan (p));
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	61 cdf(k) = NaN;
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	62
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	63 k = (x == Inf) & (n > 0) & (n < Inf) & (p >= 0) & (p <= 1);
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	64 cdf(k) = 1;
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	65
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	66 k = ((x >= 0) & (x < Inf) & (x == fix (x))
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	67 & (n > 0) & (n < Inf) & (p > 0) & (p <= 1));
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	68 if (isscalar (n) && isscalar (p))
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	69 cdf(k) = 1 - betainc (1-p, x(k)+1, n);
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	70 else
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	71 cdf(k) = 1 - betainc (1-p(k), x(k)+1, n(k));
6349 859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	72 endif
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	73
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman] dbateman parents: diff changeset	74 endfunction
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	75
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	76
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	77 %!shared x,y
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	78 %! x = [-1 0 1 2 Inf];
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	79 %! y = [0 1/2 3/4 7/8 1];
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	80 %!assert (nbincdf (x, ones (1,5), 0.5*ones (1,5)), y)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	81 %!assert (nbincdf (x, 1, 0.5*ones (1,5)), y)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	82 %!assert (nbincdf (x, ones (1,5), 0.5), y)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	83 %!assert (nbincdf ([x(1:3) 0 x(5)], [0 1 NaN 1.5 Inf], 0.5), [NaN 1/2 NaN nbinpdf(0,1.5,0.5) NaN], eps)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	84 %!assert (nbincdf (x, 1, 0.5*[-1 NaN 4 1 1]), [NaN NaN NaN y(4:5)])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	85 %!assert (nbincdf ([x(1:2) NaN x(4:5)], 1, 0.5), [y(1:2) NaN y(4:5)])
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	86
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	87 ## Test class of input preserved
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	88 %!assert (nbincdf ([x, NaN], 1, 0.5), [y, NaN])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	89 %!assert (nbincdf (single ([x, NaN]), 1, 0.5), single ([y, NaN]))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	90 %!assert (nbincdf ([x, NaN], single (1), 0.5), single ([y, NaN]))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	91 %!assert (nbincdf ([x, NaN], 1, single (0.5)), single ([y, NaN]))
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	92
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	93 ## Test input validation
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	94 %!error nbincdf ()
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	95 %!error nbincdf (1)
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	96 %!error nbincdf (1,2)
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	97 %!error nbincdf (1,2,3,4)
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	98 %!error nbincdf (ones (3), ones (2), ones (2))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	99 %!error nbincdf (ones (2), ones (3), ones (2))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	100 %!error nbincdf (ones (2), ones (2), ones (3))
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	101 %!error nbincdf (i, 2, 2)
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	102 %!error nbincdf (2, i, 2)
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	103 %!error nbincdf (2, 2, i)
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	104

Mercurial > octave

annotate scripts/statistics/distributions/nbincdf.m @ 20174:d9341b422488 stable