annotate scripts/deprecated/lognormal_rnd.m @ 6971:0a9d97cf2e13

[project @ 2007-10-07 19:44:53 by dbateman]
author dbateman
date Sun, 07 Oct 2007 19:44:53 +0000
parents fe226f54d259
children 93c65f2a5668
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5411
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
1 ## Copyright (C) 1995, 1996, 1997 Kurt Hornik
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
2 ##
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
4 ##
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
7 ## the Free Software Foundation; either version 2, or (at your option)
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
8 ## any later version.
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
9 ##
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
14 ##
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
17 ## Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
18 ## 02110-1301, USA.
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
19
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
20 ## -*- texinfo -*-
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
21 ## @deftypefn {Function File} {} lognormal_rnd (@var{a}, @var{v}, @var{r}, @var{c})
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
22 ## @deftypefnx {Function File} {} lognormal_rnd (@var{a}, @var{v}, @var{sz})
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
23 ## Return an @var{r} by @var{c} matrix of random samples from the
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
24 ## lognormal distribution with parameters @var{a} and @var{v}. Both
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
25 ## @var{a} and @var{v} must be scalar or of size @var{r} by @var{c}.
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
26 ## Or if @var{sz} is a vector, create a matrix of size @var{sz}.
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
27 ##
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
28 ## If @var{r} and @var{c} are omitted, the size of the result matrix is
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
29 ## the common size of @var{a} and @var{v}.
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
30 ## @end deftypefn
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
31
5428
2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe]
jwe
parents: 5411
diff changeset
32 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
5411
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
33 ## Description: Random deviates from the log normal distribution
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
34
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
35 function rnd = lognormal_rnd (varargin)
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
36
5692
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
37 if (nargin > 1)
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
38 a = varargin{2};
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
39 idx = a >= 0;
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
40 a(idx) = log (a(idx));
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
41 a(!idx) = NaN;
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
42 varargin{2} = a;
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
43 endif
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
44
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
45 if (nargin > 2)
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
46 v = varargin{3};
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
47 idx = v >= 0;
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
48 v(idx) = sqrt (v(idx));
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
49 v(!idx) = NaN;
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
50 varargin{3} = v;
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
51 endif
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
52
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
53 rnd = lognrnd (varargin{:});
5411
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
54
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
55 endfunction