annotate scripts/statistics/distributions/discrete_inv.m @ 7016:93c65f2a5668

[project @ 2007-10-12 06:40:56 by jwe]
author jwe
date Fri, 12 Oct 2007 06:41:26 +0000
parents 34f96dd5441b
children a1dbe9d80eee
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
1 ## Copyright (C) 1996, 1997 Kurt Hornik
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
2 ##
3922
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3456
diff changeset
3 ## This file is part of Octave.
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3456
diff changeset
4 ##
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3456
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3456
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: 6046
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: 6046
diff changeset
8 ## your option) any later version.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
9 ##
3922
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3456
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
13 ## General Public License for more details.
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
14 ##
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
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: 6046
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: 6046
diff changeset
17 ## <http://www.gnu.org/licenses/>.
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
18
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
19 ## -*- texinfo -*-
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
20 ## @deftypefn {Function File} {} discrete_inv (@var{x}, @var{v}, @var{p})
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
21 ## For each component of @var{x}, compute the quantile (the inverse of
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
22 ## the CDF) at @var{x} of the univariate distribution which assumes the
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
23 ## values in @var{v} with probabilities @var{p}.
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
24 ## @end deftypefn
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
25
5428
2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe]
jwe
parents: 5307
diff changeset
26 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
27 ## Description: Quantile function of a discrete distribution
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
28
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
29 function inv = discrete_inv (x, v, p)
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
30
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
31 if (nargin != 3)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5428
diff changeset
32 print_usage ();
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
33 endif
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
34
4859
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4778
diff changeset
35 sz = size (x);
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
36
4030
22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe]
jwe
parents: 3922
diff changeset
37 if (! isvector (v))
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
38 error ("discrete_inv: v must be a vector");
4030
22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe]
jwe
parents: 3922
diff changeset
39 elseif (! isvector (p) || (length (p) != length (v)))
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
40 error ("discrete_inv: p must be a vector with length (v) elements");
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
41 elseif (! (all (p >= 0) && any (p)))
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
42 error ("discrete_inv: p must be a nonzero, nonnegative vector");
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
43 endif
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
44
4859
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4778
diff changeset
45 n = numel (x);
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
46 x = reshape (x, 1, n);
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
47 m = length (v);
4778
567c8e2d2438 [project @ 2004-02-17 00:35:43 by jwe]
jwe
parents: 4030
diff changeset
48 v = sort (v);
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
49 s = reshape (cumsum (p / sum (p)), m, 1);
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
50
4778
567c8e2d2438 [project @ 2004-02-17 00:35:43 by jwe]
jwe
parents: 4030
diff changeset
51 ## Allow storage allocated for P to be reclaimed.
567c8e2d2438 [project @ 2004-02-17 00:35:43 by jwe]
jwe
parents: 4030
diff changeset
52 p = [];
567c8e2d2438 [project @ 2004-02-17 00:35:43 by jwe]
jwe
parents: 4030
diff changeset
53
4859
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4778
diff changeset
54 inv = NaN * ones (sz);
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
55 if (any (k = find (x == 0)))
4859
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4778
diff changeset
56 inv(k) = -Inf;
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
57 endif
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
58 if (any (k = find (x == 1)))
4859
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4778
diff changeset
59 inv(k) = v(m) * ones (size (k));
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
60 endif
4778
567c8e2d2438 [project @ 2004-02-17 00:35:43 by jwe]
jwe
parents: 4030
diff changeset
61
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
62 if (any (k = find ((x > 0) & (x < 1))))
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
63 n = length (k);
4778
567c8e2d2438 [project @ 2004-02-17 00:35:43 by jwe]
jwe
parents: 4030
diff changeset
64
567c8e2d2438 [project @ 2004-02-17 00:35:43 by jwe]
jwe
parents: 4030
diff changeset
65 ## The following loop is a space/time tradeoff in favor of space,
567c8e2d2438 [project @ 2004-02-17 00:35:43 by jwe]
jwe
parents: 4030
diff changeset
66 ## since the dataset may be large.
567c8e2d2438 [project @ 2004-02-17 00:35:43 by jwe]
jwe
parents: 4030
diff changeset
67 ##
567c8e2d2438 [project @ 2004-02-17 00:35:43 by jwe]
jwe
parents: 4030
diff changeset
68 ## Vectorized code is:
567c8e2d2438 [project @ 2004-02-17 00:35:43 by jwe]
jwe
parents: 4030
diff changeset
69 ##
4859
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4778
diff changeset
70 ## inv(k) = v(sum ((ones (m, 1) * x(k)) > (s * ones (1, n))) + 1);
4778
567c8e2d2438 [project @ 2004-02-17 00:35:43 by jwe]
jwe
parents: 4030
diff changeset
71
567c8e2d2438 [project @ 2004-02-17 00:35:43 by jwe]
jwe
parents: 4030
diff changeset
72 for q = 1:n
4859
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4778
diff changeset
73 inv(k(q)) = v(sum (x(k(q)) > s) + 1);
4778
567c8e2d2438 [project @ 2004-02-17 00:35:43 by jwe]
jwe
parents: 4030
diff changeset
74 endfor
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
75 endif
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
76
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
77 endfunction
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
78
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
79