octave-nkf: scripts/statistics/distributions/geopdf.m annotate

annotate scripts/statistics/distributions/geopdf.m @ 20384: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

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
19898 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	2 ## Copyright (C) 1995-2015 Kurt Hornik
5410 56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	3 ##
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	4 ## This file is part of Octave.
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	5 ##
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	6 ## Octave is free software; you can redistribute it and/or modify it
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe 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: 6046 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: 6046 diff changeset	9 ## your option) any later version.
5410 56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	10 ##
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	11 ## Octave is distributed in the hope that it will be useful, but
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	14 ## General Public License for more details.
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	15 ##
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe 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: 6046 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: 6046 diff changeset	18 ## <http://www.gnu.org/licenses/>.
5410 56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	19
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	20 ## -- texinfo --
5411 bee21f388110 [project @ 2005-07-13 17:53:44 by jwe] jwe parents: 5410 diff changeset	21 ## @deftypefn {Function File} {} geopdf (@var{x}, @var{p})
20384 d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 20038 diff changeset	22 ## For each element of @var{x}, compute the probability density function (PDF)
d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 20038 diff changeset	23 ## at @var{x} of the geometric distribution with parameter @var{p}.
17401 6643f21e27f3 doc: Document the form of the geometric distribution being used (II) in geo* functions. Rik <rik@octave.org> parents: 14363 diff changeset	24 ##
6643f21e27f3 doc: Document the form of the geometric distribution being used (II) in geo* functions. Rik <rik@octave.org> parents: 14363 diff changeset	25 ## The geometric distribution models the number of failures (@var{x}-1) of a
6643f21e27f3 doc: Document the form of the geometric distribution being used (II) in geo* functions. Rik <rik@octave.org> parents: 14363 diff changeset	26 ## Bernoulli trial with probability @var{p} before the first success (@var{x}).
5410 56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	27 ## @end deftypefn
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	28
5428 2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe] jwe parents: 5411 diff changeset	29 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
5410 56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	30 ## Description: PDF of the geometric distribution
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	31
5411 bee21f388110 [project @ 2005-07-13 17:53:44 by jwe] jwe parents: 5410 diff changeset	32 function pdf = geopdf (x, p)
5410 56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	33
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	34 if (nargin != 2)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5428 diff changeset	35 print_usage ();
5410 56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	36 endif
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	37
20038 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19898 diff changeset	38 if (! isscalar (p))
5410 56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	39 [retval, x, p] = common_size (x, p);
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	40 if (retval > 0)
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	41 error ("geopdf: X and P must be of common size or scalars");
5410 56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	42 endif
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	43 endif
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	44
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	45 if (iscomplex (x) \|\| iscomplex (p))
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	46 error ("geopdf: X and P must not be complex");
5410 56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	47 endif
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	48
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	49 if (isa (x, "single") \|\| isa (p, "single"))
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	50 pdf = zeros (size (x), "single");
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	51 else
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	52 pdf = zeros (size (x));
5410 56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	53 endif
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	54
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	55 k = isnan (x) \| (x == Inf) \| !(p >= 0) \| !(p <= 1);
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	56 pdf(k) = NaN;
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	57
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	58 k = (x >= 0) & (x < Inf) & (x == fix (x)) & (p > 0) & (p <= 1);
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	59 if (isscalar (p))
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	60 pdf(k) = p * ((1 - p) .^ x(k));
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	61 else
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	62 pdf(k) = p(k) .* ((1 - p(k)) .^ x(k));
5410 56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	63 endif
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	64
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	65 endfunction
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	66
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	67
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	68 %!shared x,y
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	69 %! x = [-1 0 1 Inf];
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	70 %! y = [0, 1/2, 1/4, NaN];
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	71 %!assert (geopdf (x, 0.5*ones (1,4)), y)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	72 %!assert (geopdf (x, 0.5), y)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	73 %!assert (geopdf (x, 0.5*[-1 NaN 4 1]), [NaN NaN NaN y(4)])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	74 %!assert (geopdf ([x, NaN], 0.5), [y, NaN])
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	75
20038 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19898 diff changeset	76 ## 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	77 %!assert (geopdf (single ([x, NaN]), 0.5), single ([y, NaN]), 5*eps ("single"))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	78 %!assert (geopdf ([x, NaN], single (0.5)), single ([y, NaN]), 5*eps ("single"))
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	79
20038 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19898 diff changeset	80 ## Test input validation
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	81 %!error geopdf ()
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	82 %!error geopdf (1)
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	83 %!error geopdf (1,2,3)
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	84 %!error geopdf (ones (3), ones (2))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	85 %!error geopdf (ones (2), ones (3))
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	86 %!error geopdf (i, 2)
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	87 %!error geopdf (2, i)
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	88

Mercurial > hg > octave-nkf

annotate scripts/statistics/distributions/geopdf.m @ 20384:d9341b422488 stable