annotate scripts/statistics/distributions/cauchy_rnd.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 3306cfcb856e
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, 1998, 2000, 2002, 2004, 2005, 2006,
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
2 ## 2007 Kurt Hornik
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
3 ##
3922
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3457
diff changeset
4 ## This file is part of Octave.
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3457
diff changeset
5 ##
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3457
diff changeset
6 ## 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
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: 7007
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: 7007
diff changeset
9 ## your option) any later version.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
10 ##
3922
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3457
diff changeset
11 ## 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
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
13 ## 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
14 ## General Public License for more details.
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
15 ##
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 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: 7007
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: 7007
diff changeset
18 ## <http://www.gnu.org/licenses/>.
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} {} cauchy_rnd (@var{lambda}, @var{sigma}, @var{r}, @var{c})
4854
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
22 ## @deftypefnx {Function File} {} cauchy_rnd (@var{lambda}, @var{sigma}, @var{sz})
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
23 ## Return an @var{r} by @var{c} or a @code{size (@var{sz})} matrix of
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
24 ## random samples from the Cauchy distribution with parameters @var{lambda}
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
25 ## and @var{sigma} which must both be scalar or of size @var{r} by @var{c}.
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
26 ##
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
27 ## 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
28 ## the common size of @var{lambda} and @var{sigma}.
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
29 ## @end deftypefn
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
30
5428
2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe]
jwe
parents: 5307
diff changeset
31 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
32 ## Description: Random deviates from the Cauchy distribution
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
33
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
34 function rnd = cauchy_rnd (l, scale, r, c)
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
35
4854
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
36 if (nargin > 1)
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
37 if (!isscalar (l) || !isscalar (scale))
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
38 [retval, l, scale] = common_size (l, scale);
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
39 if (retval > 0)
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
40 error ("cauchy_rnd: lambda and sigma must be of common size or scalar");
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
41 endif
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
42 endif
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
43 endif
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
44
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
45 if (nargin == 4)
4030
22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe]
jwe
parents: 3922
diff changeset
46 if (! (isscalar (r) && (r > 0) && (r == round (r))))
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
47 error ("cauchy_rnd: r must be a positive integer");
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
48 endif
4030
22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe]
jwe
parents: 3922
diff changeset
49 if (! (isscalar (c) && (c > 0) && (c == round (c))))
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
50 error ("cauchy_rnd: c must be a positive integer");
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
51 endif
4854
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
52 sz = [r, c];
4856
c89b9abf2ffd [project @ 2004-04-08 03:24:12 by jwe]
jwe
parents: 4854
diff changeset
53
4857
9794d526639c [project @ 2004-04-08 03:27:49 by jwe]
jwe
parents: 4856
diff changeset
54 if (any (size (l) != 1)
9794d526639c [project @ 2004-04-08 03:27:49 by jwe]
jwe
parents: 4856
diff changeset
55 && (length (size (l)) != length (sz) || any (size (l) != sz)))
4856
c89b9abf2ffd [project @ 2004-04-08 03:24:12 by jwe]
jwe
parents: 4854
diff changeset
56 error ("cauchy_rnd: lambda and sigma must be scalar or of size [r, c]");
c89b9abf2ffd [project @ 2004-04-08 03:24:12 by jwe]
jwe
parents: 4854
diff changeset
57 endif
4854
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
58 elseif (nargin == 3)
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
59 if (isscalar (r) && (r > 0))
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
60 sz = [r, r];
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
61 elseif (isvector(r) && all (r > 0))
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
62 sz = r(:)';
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
63 else
7007
6304d9ea0a30 [project @ 2007-10-11 16:26:36 by jwe]
jwe
parents: 6046
diff changeset
64 error ("cauchy_rnd: r must be a positive integer or vector");
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
65 endif
4856
c89b9abf2ffd [project @ 2004-04-08 03:24:12 by jwe]
jwe
parents: 4854
diff changeset
66
4857
9794d526639c [project @ 2004-04-08 03:27:49 by jwe]
jwe
parents: 4856
diff changeset
67 if (any (size (l) != 1)
9794d526639c [project @ 2004-04-08 03:27:49 by jwe]
jwe
parents: 4856
diff changeset
68 && (length (size (l)) != length (sz) || any (size (l) != sz)))
4856
c89b9abf2ffd [project @ 2004-04-08 03:24:12 by jwe]
jwe
parents: 4854
diff changeset
69 error ("cauchy_rnd: lambda and sigma must be scalar or of size sz");
c89b9abf2ffd [project @ 2004-04-08 03:24:12 by jwe]
jwe
parents: 4854
diff changeset
70 endif
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
71 elseif (nargin == 2)
4854
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
72 sz = size(l);
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
73 else
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5428
diff changeset
74 print_usage ();
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
75 endif
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
76
4854
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
77 if (isscalar (l) && isscalar (scale))
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
78 if (find (!(l > -Inf) | !(l < Inf) | !(scale > 0) | !(scale < Inf)))
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
79 rnd = NaN * ones (sz);
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
80 else
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
81 rnd = l - cot (pi * rand (sz)) .* scale;
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
82 endif
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
83 else
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
84 rnd = NaN * ones (sz);
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
85 k = find ((l > -Inf) & (l < Inf) & (scale > 0) & (scale < Inf));
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
86 if (any (k))
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
87 rnd(k) = l(k)(:) - cot (pi * rand (size (k))) .* scale(k)(:);
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
88 endif
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
89 endif
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
90
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
91 endfunction