annotate scripts/statistics/distributions/normal_inv.m @ 4854:4b0f3b055331

[project @ 2004-04-07 02:37:05 by jwe]
author jwe
date Wed, 07 Apr 2004 02:38:06 +0000
parents c0532bbaefd7
children 4c8a2e4e0717
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: 3456
diff changeset
3 ## This file is part of Octave.
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3456
diff changeset
4 ##
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3456
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: 3456
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: 3456
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: 3456
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3456
diff changeset
17 ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3456
diff changeset
18 ## 02111-1307, 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} {} normal_inv (@var{x}, @var{m}, @var{v})
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
22 ## For each element of @var{x}, compute the quantile (the inverse of the
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
23 ## CDF) at @var{x} of the normal distribution with mean @var{m} and
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
24 ## variance @var{v}.
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
25 ##
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
26 ## Default values are @var{m} = 0, @var{v} = 1.
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
27 ## @end deftypefn
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
28
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
29 ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at>
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
30 ## Description: Quantile function of the normal distribution
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
31
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
32 function inv = normal_inv (x, m, v)
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
33
4854
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4079
diff changeset
34 if (nargin != 1 && nargin != 3)
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
35 usage ("normal_inv (x, m, v)");
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
36 endif
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
37
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
38 if (nargin == 1)
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
39 m = 0;
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
40 v = 1;
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
41 endif
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
42
4854
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4079
diff changeset
43 if (!isscalar (m) || !isscalar(v))
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4079
diff changeset
44 [retval, x, m, v] = common_size (x, m, v);
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4079
diff changeset
45 if (retval > 0)
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4079
diff changeset
46 error ("normal_inv: x, m and v must be of common size or scalars");
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4079
diff changeset
47 endif
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
48 endif
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
49
4854
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4079
diff changeset
50 sz = size (x);
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4079
diff changeset
51 inv = zeros (sz);
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
52
4854
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4079
diff changeset
53 if (isscalar (m) && isscalar(v))
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4079
diff changeset
54 if (find (isinf (m) | isnan (m) | !(v > 0) | !(v < Inf)))
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4079
diff changeset
55 inv = NaN * ones (sz);
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4079
diff changeset
56 else
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4079
diff changeset
57 inv = m + sqrt (v) .* stdnormal_inv (x);
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4079
diff changeset
58 endif
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4079
diff changeset
59 else
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4079
diff changeset
60 k = find (isinf (m) | isnan (m) | !(v > 0) | !(v < Inf));
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4079
diff changeset
61 if (any (k))
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4079
diff changeset
62 inv(k) = NaN;
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4079
diff changeset
63 endif
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
64
4854
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4079
diff changeset
65 k = find (!isinf (m) & !isnan (m) & (v > 0) & (v < Inf));
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4079
diff changeset
66 if (any (k))
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4079
diff changeset
67 inv(k) = m(k) + sqrt (v(k)) .* stdnormal_inv (x(k));
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4079
diff changeset
68 endif
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
69 endif
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
70
4079
c0532bbaefd7 [project @ 2002-09-30 19:08:09 by jwe]
jwe
parents: 3922
diff changeset
71 k = find ((v == 0) & (x > 0) & (x < 1));
c0532bbaefd7 [project @ 2002-09-30 19:08:09 by jwe]
jwe
parents: 3922
diff changeset
72 if (any (k))
c0532bbaefd7 [project @ 2002-09-30 19:08:09 by jwe]
jwe
parents: 3922
diff changeset
73 inv(k) = m(k);
c0532bbaefd7 [project @ 2002-09-30 19:08:09 by jwe]
jwe
parents: 3922
diff changeset
74 endif
c0532bbaefd7 [project @ 2002-09-30 19:08:09 by jwe]
jwe
parents: 3922
diff changeset
75
c0532bbaefd7 [project @ 2002-09-30 19:08:09 by jwe]
jwe
parents: 3922
diff changeset
76 inv((v == 0) & (x == 0)) = -Inf;
c0532bbaefd7 [project @ 2002-09-30 19:08:09 by jwe]
jwe
parents: 3922
diff changeset
77 inv((v == 0) & (x == 1)) = Inf;
c0532bbaefd7 [project @ 2002-09-30 19:08:09 by jwe]
jwe
parents: 3922
diff changeset
78
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
79 endfunction