annotate scripts/statistics/distributions/exponential_rnd.m @ 5307:4c8a2e4e0717

[project @ 2005-04-26 19:24:27 by jwe]
author jwe
date Tue, 26 Apr 2005 19:24:47 +0000
parents a0997c4d1d54
children
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) 1995, 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: 3457
diff changeset
3 ## This file is part of Octave.
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3457
diff changeset
4 ##
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3457
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: 3457
diff changeset
6 ## under the terms of the GNU General Public License as published by
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
7 ## the Free Software Foundation; either version 2, or (at your option)
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
8 ## 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: 3457
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
3922
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3457
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
5307
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 4862
diff changeset
17 ## Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 4862
diff changeset
18 ## 02110-1301, USA.
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
19
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
20 ## -*- texinfo -*-
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
21 ## @deftypefn {Function File} {} exponential_rnd (@var{lambda}, @var{r}, @var{c})
4862
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4859
diff changeset
22 ## @deftypefnx {Function File} {} exponential_rnd (@var{lambda}, @var{sz})
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
23 ## Return an @var{r} by @var{c} matrix of random samples from the
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
24 ## exponential distribution with parameter @var{lambda}, which must be a
4859
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
25 ## scalar or of size @var{r} by @var{c}. Or if @var{sz} is a vector,
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
26 ## create a matrix of size @var{sz}.
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
27 ##
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
28 ## If @var{r} and @var{c} are omitted, the size of the result matrix is
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
29 ## the size of @var{lambda}.
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
30 ## @end deftypefn
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
31
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
32 ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at>
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
33 ## Description: Random deviates from the exponential distribution
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
34
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
35 function rnd = exponential_rnd (l, r, c)
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
36
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
37 if (nargin == 3)
4030
22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe]
jwe
parents: 3922
diff changeset
38 if (! (isscalar (r) && (r > 0) && (r == round (r))))
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
39 error ("exponential_rnd: r must be a positive integer");
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
40 endif
4030
22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe]
jwe
parents: 3922
diff changeset
41 if (! (isscalar (c) && (c > 0) && (c == round (c))))
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
42 error ("exponential_rnd: c must be a positive integer");
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
43 endif
4859
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
44 sz = [r, c];
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
45
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
46 if (any (size (l) != 1) &&
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
47 ((length (size (nl)) != length (sz)) || any (size (l) != sz)))
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
48 error ("exponential_rnd: lambda must be scalar or of size [r, c]");
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
49 endif
4859
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
50 elseif (nargin == 2)
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
51 if (isscalar (r) && (r > 0))
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
52 sz = [r, r];
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
53 elseif (isvector(r) && all (r > 0))
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
54 sz = r(:)';
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
55 else
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
56 error ("exponential_rnd: r must be a postive integer or vector");
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
57 endif
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
58
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
59 if (any (size (l) != 1) &&
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
60 ((length (size (l)) != length (sz)) || any (size (l) != sz)))
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
61 error ("exponential_rnd: lambda must be scalar or of size sz");
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
62 endif
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
63 elseif (nargin == 1)
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
64 sz = size (l);
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
65 else
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
66 usage ("exponential_rnd (lambda, r, c)");
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
67 endif
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
68
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
69
4859
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
70 if (isscalar (l))
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
71 if ((l > 0) && (l < Inf))
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
72 rnd = - log (1 - rand (sz)) ./ l;
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
73 else
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
74 rnd = NaN * ones (sz);
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
75 endif
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
76 else
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
77 rnd = zeros (sz);
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
78 k = find (!(l > 0) | !(l < Inf));
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
79 if (any (k))
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
80 rnd(k) = NaN;
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
81 endif
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
82 k = find ((l > 0) & (l < Inf));
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
83 if (any (k))
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
84 rnd(k) = - log (1 - rand (size (k))) ./ l(k);
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
85 endif
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
86 endif
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
87
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
88 endfunction