annotate scripts/deprecated/lognormal_inv.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 8e5371d47da6
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, 2005, 2006, 2007 Kurt Hornik
5411
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
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5692
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: 5692
diff changeset
8 ## your option) any later version.
5411
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
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5692
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: 5692
diff changeset
17 ## <http://www.gnu.org/licenses/>.
5411
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
18
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
20 ## @deftypefn {Function File} {} lognormal_inv (@var{x}, @var{a}, @var{v})
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
21 ## For each element of @var{x}, compute the quantile (the inverse of the
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
22 ## CDF) at @var{x} of the lognormal distribution with parameters @var{a}
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
23 ## and @var{v}. If a random variable follows this distribution, its
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
24 ## logarithm is normally distributed with mean @code{log (@var{a})} and
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
25 ## variance @var{v}.
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
26 ##
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
27 ## Default values are @var{a} = 1, @var{v} = 1.
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
28 ## @end deftypefn
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
29
5428
2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe]
jwe
parents: 5411
diff changeset
30 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
5411
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
31 ## Description: Quantile function of the log normal distribution
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
32
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
33 function inv = lognormal_inv (varargin)
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
34
5692
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
35 if (nargin > 1)
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
36 a = varargin{2};
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
37 idx = a >= 0;
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
38 a(idx) = log (a(idx));
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
39 a(!idx) = NaN;
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
40 varargin{2} = a;
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
41 endif
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
42
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
43 if (nargin > 2)
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
44 v = varargin{3};
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
45 idx = v >= 0;
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
46 v(idx) = sqrt (v(idx));
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
47 v(!idx) = NaN;
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
48 varargin{3} = v;
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
49 endif
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
50
fe226f54d259 [project @ 2006-03-17 17:02:32 by jwe]
jwe
parents: 5428
diff changeset
51 inv = logninv (varargin{:});
5411
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
52
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
53 endfunction