annotate scripts/specfun/erfinv.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 8a3b2ccc4e11
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, 1999, 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: 3408
diff changeset
3 ##
3922
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3872
diff changeset
4 ## This file is part of Octave.
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3872
diff changeset
5 ##
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3872
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: 3872
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: 6046
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: 6046
diff changeset
9 ## your option) any later version.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
10 ##
3922
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3872
diff changeset
11 ## Octave is distributed in the hope that it will be useful, but
2537
80b982e7f4b1 [project @ 1996-11-19 21:15:06 by jwe]
jwe
parents:
diff changeset
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
80b982e7f4b1 [project @ 1996-11-19 21:15:06 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: 3408
diff changeset
14 ## General Public License for more details.
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
15 ##
2537
80b982e7f4b1 [project @ 1996-11-19 21:15:06 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: 6046
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: 6046
diff changeset
18 ## <http://www.gnu.org/licenses/>.
2537
80b982e7f4b1 [project @ 1996-11-19 21:15:06 by jwe]
jwe
parents:
diff changeset
19
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3266
diff changeset
20 ## -*- texinfo -*-
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3266
diff changeset
21 ## @deftypefn {Mapping Function} {} erfinv (@var{z})
3599
b8fa63b7ea79 [project @ 2000-02-23 22:48:08 by jwe]
jwe
parents: 3426
diff changeset
22 ## Computes the inverse of the error function.
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5428
diff changeset
23 ## @seealso{erf, erfc}
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3266
diff changeset
24 ## @end deftypefn
2537
80b982e7f4b1 [project @ 1996-11-19 21:15:06 by jwe]
jwe
parents:
diff changeset
25
5428
2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe]
jwe
parents: 5307
diff changeset
26 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
2537
80b982e7f4b1 [project @ 1996-11-19 21:15:06 by jwe]
jwe
parents:
diff changeset
27 ## Created: 27 September 1994
80b982e7f4b1 [project @ 1996-11-19 21:15:06 by jwe]
jwe
parents:
diff changeset
28 ## Adapted-By: jwe
80b982e7f4b1 [project @ 1996-11-19 21:15:06 by jwe]
jwe
parents:
diff changeset
29
3266
3add30d33bd0 [project @ 1999-09-03 17:15:40 by jwe]
jwe
parents: 2968
diff changeset
30 function [y, iterations] = erfinv (x)
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
31
2537
80b982e7f4b1 [project @ 1996-11-19 21:15:06 by jwe]
jwe
parents:
diff changeset
32 if (nargin != 1)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5642
diff changeset
33 print_usage ();
2537
80b982e7f4b1 [project @ 1996-11-19 21:15:06 by jwe]
jwe
parents:
diff changeset
34 endif
3266
3add30d33bd0 [project @ 1999-09-03 17:15:40 by jwe]
jwe
parents: 2968
diff changeset
35
3add30d33bd0 [project @ 1999-09-03 17:15:40 by jwe]
jwe
parents: 2968
diff changeset
36 maxit = 100;
3add30d33bd0 [project @ 1999-09-03 17:15:40 by jwe]
jwe
parents: 2968
diff changeset
37 tol = eps;
3add30d33bd0 [project @ 1999-09-03 17:15:40 by jwe]
jwe
parents: 2968
diff changeset
38
3add30d33bd0 [project @ 1999-09-03 17:15:40 by jwe]
jwe
parents: 2968
diff changeset
39 iterations = 0;
3add30d33bd0 [project @ 1999-09-03 17:15:40 by jwe]
jwe
parents: 2968
diff changeset
40
4844
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4077
diff changeset
41 sz = size (x);
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4077
diff changeset
42 nel = numel (x);
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4077
diff changeset
43
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4077
diff changeset
44 x = reshape (x, nel, 1);
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4077
diff changeset
45 y = zeros (nel, 1);
3266
3add30d33bd0 [project @ 1999-09-03 17:15:40 by jwe]
jwe
parents: 2968
diff changeset
46
4077
b5267e631ba8 [project @ 2002-09-27 22:48:46 by jwe]
jwe
parents: 3922
diff changeset
47 i = find ((x < -1) | (x > 1) | isnan(x));
2537
80b982e7f4b1 [project @ 1996-11-19 21:15:06 by jwe]
jwe
parents:
diff changeset
48 if any (i)
80b982e7f4b1 [project @ 1996-11-19 21:15:06 by jwe]
jwe
parents:
diff changeset
49 y(i) = NaN * ones (length (i), 1);
80b982e7f4b1 [project @ 1996-11-19 21:15:06 by jwe]
jwe
parents:
diff changeset
50 endif
80b982e7f4b1 [project @ 1996-11-19 21:15:06 by jwe]
jwe
parents:
diff changeset
51
2621
337a09dd1c06 [project @ 1997-01-24 21:49:41 by jwe]
jwe
parents: 2537
diff changeset
52 t = find (x == -1);
2663
00b2eff19bf5 [project @ 1997-02-08 21:58:49 by jwe]
jwe
parents: 2621
diff changeset
53 y (t) = (-Inf) * ones (size (t));
2621
337a09dd1c06 [project @ 1997-01-24 21:49:41 by jwe]
jwe
parents: 2537
diff changeset
54
337a09dd1c06 [project @ 1997-01-24 21:49:41 by jwe]
jwe
parents: 2537
diff changeset
55 t = find (x == 1);
337a09dd1c06 [project @ 1997-01-24 21:49:41 by jwe]
jwe
parents: 2537
diff changeset
56 y (t) = Inf * ones (size (t));
3266
3add30d33bd0 [project @ 1999-09-03 17:15:40 by jwe]
jwe
parents: 2968
diff changeset
57
2537
80b982e7f4b1 [project @ 1996-11-19 21:15:06 by jwe]
jwe
parents:
diff changeset
58 i = find ((x > -1) & (x < 1));
80b982e7f4b1 [project @ 1996-11-19 21:15:06 by jwe]
jwe
parents:
diff changeset
59 if any (i)
2968
e330cb788508 [project @ 1997-05-15 17:40:29 by jwe]
jwe
parents: 2813
diff changeset
60 s = sqrt (pi) / 2;
2537
80b982e7f4b1 [project @ 1996-11-19 21:15:06 by jwe]
jwe
parents:
diff changeset
61 z_old = ones (length (i), 1);
3266
3add30d33bd0 [project @ 1999-09-03 17:15:40 by jwe]
jwe
parents: 2968
diff changeset
62 z_new = sqrt (-log (1 - abs (x(i)))) .* sign (x(i));
3599
b8fa63b7ea79 [project @ 2000-02-23 22:48:08 by jwe]
jwe
parents: 3426
diff changeset
63 while (any (abs (erf (z_new) - x(i)) > tol * abs (x(i))))
2537
80b982e7f4b1 [project @ 1996-11-19 21:15:06 by jwe]
jwe
parents:
diff changeset
64 z_old = z_new;
2813
d45d48b3dcde [project @ 1997-03-13 22:39:15 by jwe]
jwe
parents: 2663
diff changeset
65 z_new = z_old - (erf (z_old) - x(i)) .* exp (z_old.^2) * s;
3266
3add30d33bd0 [project @ 1999-09-03 17:15:40 by jwe]
jwe
parents: 2968
diff changeset
66 if (++iterations > maxit)
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
67 warning ("erfinv: iteration limit exceeded");
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
68 break;
3266
3add30d33bd0 [project @ 1999-09-03 17:15:40 by jwe]
jwe
parents: 2968
diff changeset
69 endif
2537
80b982e7f4b1 [project @ 1996-11-19 21:15:06 by jwe]
jwe
parents:
diff changeset
70 endwhile
80b982e7f4b1 [project @ 1996-11-19 21:15:06 by jwe]
jwe
parents:
diff changeset
71 y(i) = z_new;
80b982e7f4b1 [project @ 1996-11-19 21:15:06 by jwe]
jwe
parents:
diff changeset
72 endif
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
73
4844
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4077
diff changeset
74 y = reshape (y, sz);
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
75
2537
80b982e7f4b1 [project @ 1996-11-19 21:15:06 by jwe]
jwe
parents:
diff changeset
76 endfunction