annotate scripts/statistics/distributions/logistic_rnd.m @ 5457:c6dc1ccd83a9

[project @ 2005-09-19 19:23:35 by jwe]
author jwe
date Mon, 19 Sep 2005 19:26:00 +0000
parents 2a16423e4aa0
children 34f96dd5441b
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} {} logistic_rnd (@var{r}, @var{c})
4862
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4859
diff changeset
22 ## @deftypefnx {Function File} {} logistic_rnd (@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 numbers from the
5457
c6dc1ccd83a9 [project @ 2005-09-19 19:23:35 by jwe]
jwe
parents: 5428
diff changeset
24 ## logistic distribution. Or if @var{sz} is a vector, create a matrix of
4859
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
25 ## @var{sz}.
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
26 ## @end deftypefn
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
27
5428
2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe]
jwe
parents: 5307
diff changeset
28 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
29 ## Description: Random deviates from the logistic distribution
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
30
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
31 function rnd = logistic_rnd (r, c)
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
32
4859
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
33
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
34 if (nargin == 2)
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
35 if (! (isscalar (r) && (r > 0) && (r == round (r))))
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
36 error ("logistic_rnd: r must be a positive integer");
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
37 endif
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
38 if (! (isscalar (c) && (c > 0) && (c == round (c))))
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
39 error ("logistic_rnd: c must be a positive integer");
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
40 endif
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
41 sz = [r, c];
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
42 elseif (nargin == 1)
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
43 if (isscalar (r) && (r > 0))
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
44 sz = [r, r];
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
45 elseif (isvector(r) && all (r > 0))
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
46 sz = r(:)';
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
47 else
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
48 error ("logistic_rnd: r must be a postive integer or vector");
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
49 endif
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
50 else
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
51 usage ("logistic_rnd (r, c)");
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
52 endif
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
53
4859
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
54 rnd = - log (1 ./ rand (sz) - 1);
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
55
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
56 endfunction