annotate scripts/statistics/distributions/nbinpdf.m @ 7017:a1dbe9d80eee

[project @ 2007-10-12 21:27:11 by jwe]
author jwe
date Fri, 12 Oct 2007 21:27:37 +0000
parents 93c65f2a5668
children 95c3e38098bf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
1 ## Copyright (C) 1995, 1996, 1997, 2007 Kurt Hornik
6349
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
2 ##
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
3 ## This file is part of Octave.
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
4 ##
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
5 ## 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
6 ## 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
7 ## 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
8 ## your option) any later version.
6349
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
9 ##
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
10 ## 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
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
13 ## General Public License for more details.
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
14 ##
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
15 ## 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
16 ## 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
17 ## <http://www.gnu.org/licenses/>.
6349
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
18
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
19 ## -*- texinfo -*-
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
20 ## @deftypefn {Function File} {} nbinpdf (@var{x}, @var{n}, @var{p})
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
21 ## For each element of @var{x}, compute the probability density function
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
22 ## (PDF) at @var{x} of the Pascal (negative binomial) distribution with
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
23 ## parameters @var{n} and @var{p}.
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
24 ##
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
25 ## The number of failures in a Bernoulli experiment with success
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
26 ## probability @var{p} before the @var{n}-th success follows this
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
27 ## distribution.
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
28 ## @end deftypefn
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
29
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
30 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
31 ## Description: PDF of the Pascal (negative binomial) distribution
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 function pdf = nbinpdf (x, n, p)
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
34
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
35 if (nargin != 3)
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
36 print_usage ();
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
37 endif
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
38
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
39 if (!isscalar(n) || !isscalar(p))
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
40 [retval, x, n, p] = common_size (x, n, p);
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
41 if (retval > 0)
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
42 error ("nbinpdf: x, n and p must be of common size or scalar");
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
43 endif
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
44 endif
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
45
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
46 pdf = zeros (size (x));
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
47
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
48 k = find (isnan (x) | (n < 1) | (n == Inf) | (n != round (n))
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
49 | (p < 0) | (p > 1));
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
50 if (any (k))
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
51 pdf(k) = NaN;
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
52 endif
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
53
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
54 ## Just for the fun of it ...
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
55 k = find ((x == Inf) & (n > 0) & (n < Inf) & (n == round (n))
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
56 & (p == 0));
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
57 if (any (k))
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
58 pdf(k) = 1;
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
59 endif
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
60
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
61 k = find ((x >= 0) & (x < Inf) & (x == round (x)) & (n > 0)
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
62 & (n < Inf) & (n == round (n)) & (p > 0) & (p <= 1));
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
63 if (any (k))
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
64 if (isscalar (n) && isscalar (p))
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
65 pdf(k) = bincoeff (-n, x(k)) .* (p ^ n) .* ((p - 1) .^ x(k));
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
66 else
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
67 pdf(k) = bincoeff (-n(k), x(k)) .* (p(k) .^ n(k)) .* ((p(k) - 1) .^ x(k));
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
68 endif
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
69 endif
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
70
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
71 endfunction