annotate scripts/specfun/ellipke.m @ 20818:9d2023d1a63c

binoinv.m: Implement binary search algorithm for 28X performance increase (bug #34363). * binoinv.m: Call new functions scalar_binoinv or vector_binoinv to calculate binoinv. If there are still uncalculated values then call bin_search_binoinv to perform binary search for remaining values. Add more BIST tests. * binoinv.m (scalar_binoinv): New subfunction to calculate binoinv for scalar x. Stops when x > 1000. * binoinv.m (vector_binoinv): New subfunction to calculate binoinv for scalar x. Stops when x > 1000.
author Lachlan Andrew <lachlanbis@gmail.com>
date Sun, 11 Oct 2015 19:49:40 -0700
parents 8c4317b8f7c5
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17744
d63878346099 maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents: 17371
diff changeset
1 ## Copyright (C) 2001, 2013 David Billinghurst
d63878346099 maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents: 17371
diff changeset
2 ## Copyright (C) 2001, 2013 Paul Kienzle
d63878346099 maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents: 17371
diff changeset
3 ## Copyright (C) 2003, 2013 Jaakko Ruohio
16584
2f766ceeb03e Add ellipj, ellipke, and expint functions from Octave Forge
Mike Miller <mtmiller@ieee.org>
parents:
diff changeset
4 ##
16586
f423873d3275 Style fixes for ellipj.cc, ellipke.m, and expint.m
Mike Miller <mtmiller@ieee.org>
parents: 16585
diff changeset
5 ## This file is part of Octave.
f423873d3275 Style fixes for ellipj.cc, ellipke.m, and expint.m
Mike Miller <mtmiller@ieee.org>
parents: 16585
diff changeset
6 ##
f423873d3275 Style fixes for ellipj.cc, ellipke.m, and expint.m
Mike Miller <mtmiller@ieee.org>
parents: 16585
diff changeset
7 ## Octave is free software; you can redistribute it and/or modify it
f423873d3275 Style fixes for ellipj.cc, ellipke.m, and expint.m
Mike Miller <mtmiller@ieee.org>
parents: 16585
diff changeset
8 ## under the terms of the GNU General Public License as published by
f423873d3275 Style fixes for ellipj.cc, ellipke.m, and expint.m
Mike Miller <mtmiller@ieee.org>
parents: 16585
diff changeset
9 ## the Free Software Foundation; either version 3 of the License, or (at
f423873d3275 Style fixes for ellipj.cc, ellipke.m, and expint.m
Mike Miller <mtmiller@ieee.org>
parents: 16585
diff changeset
10 ## your option) any later version.
16584
2f766ceeb03e Add ellipj, ellipke, and expint functions from Octave Forge
Mike Miller <mtmiller@ieee.org>
parents:
diff changeset
11 ##
16586
f423873d3275 Style fixes for ellipj.cc, ellipke.m, and expint.m
Mike Miller <mtmiller@ieee.org>
parents: 16585
diff changeset
12 ## Octave is distributed in the hope that it will be useful, but
f423873d3275 Style fixes for ellipj.cc, ellipke.m, and expint.m
Mike Miller <mtmiller@ieee.org>
parents: 16585
diff changeset
13 ## WITHOUT ANY WARRANTY; without even the implied warranty of
f423873d3275 Style fixes for ellipj.cc, ellipke.m, and expint.m
Mike Miller <mtmiller@ieee.org>
parents: 16585
diff changeset
14 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
f423873d3275 Style fixes for ellipj.cc, ellipke.m, and expint.m
Mike Miller <mtmiller@ieee.org>
parents: 16585
diff changeset
15 ## General Public License for more details.
16584
2f766ceeb03e Add ellipj, ellipke, and expint functions from Octave Forge
Mike Miller <mtmiller@ieee.org>
parents:
diff changeset
16 ##
16586
f423873d3275 Style fixes for ellipj.cc, ellipke.m, and expint.m
Mike Miller <mtmiller@ieee.org>
parents: 16585
diff changeset
17 ## You should have received a copy of the GNU General Public License
f423873d3275 Style fixes for ellipj.cc, ellipke.m, and expint.m
Mike Miller <mtmiller@ieee.org>
parents: 16585
diff changeset
18 ## along with Octave; see the file COPYING. If not, see
f423873d3275 Style fixes for ellipj.cc, ellipke.m, and expint.m
Mike Miller <mtmiller@ieee.org>
parents: 16585
diff changeset
19 ## <http://www.gnu.org/licenses/>.
16584
2f766ceeb03e Add ellipj, ellipke, and expint functions from Octave Forge
Mike Miller <mtmiller@ieee.org>
parents:
diff changeset
20
2f766ceeb03e Add ellipj, ellipke, and expint functions from Octave Forge
Mike Miller <mtmiller@ieee.org>
parents:
diff changeset
21 ## -*- texinfo -*-
17370
c7c0dad2f9ac doc: Use Octave citation style for references in ellipj, ellipke.
Rik <rik@octave.org>
parents: 17336
diff changeset
22 ## @deftypefn {Function File} {@var{k} =} ellipke (@var{m})
c7c0dad2f9ac doc: Use Octave citation style for references in ellipj, ellipke.
Rik <rik@octave.org>
parents: 17336
diff changeset
23 ## @deftypefnx {Function File} {@var{k} =} ellipke (@var{m}, @var{tol})
16586
f423873d3275 Style fixes for ellipj.cc, ellipke.m, and expint.m
Mike Miller <mtmiller@ieee.org>
parents: 16585
diff changeset
24 ## @deftypefnx {Function File} {[@var{k}, @var{e}] =} ellipke (@dots{})
17370
c7c0dad2f9ac doc: Use Octave citation style for references in ellipj, ellipke.
Rik <rik@octave.org>
parents: 17336
diff changeset
25 ## Compute complete elliptic integrals of the first K(@var{m}) and second
16587
a3fdd6041e64 Fix ellipj, ellipke, and expint docstrings
Mike Miller <mtmiller@ieee.org>
parents: 16586
diff changeset
26 ## E(@var{m}) kind.
16584
2f766ceeb03e Add ellipj, ellipke, and expint functions from Octave Forge
Mike Miller <mtmiller@ieee.org>
parents:
diff changeset
27 ##
17371
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
28 ## @var{m} must be a scalar or real array with -Inf @leq{} @var{m} @leq{} 1.
17370
c7c0dad2f9ac doc: Use Octave citation style for references in ellipj, ellipke.
Rik <rik@octave.org>
parents: 17336
diff changeset
29 ##
19287
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
30 ## The optional input @var{tol} controls the stopping tolerance of the
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
31 ## algorithm and defaults to @code{eps (class (@var{m}))}. The tolerance can
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
32 ## be increased to compute a faster, less accurate approximation.
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
33 ##
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
34 ## When called with one output only elliptic integrals of the first kind are
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
35 ## returned.
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
36 ##
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
37 ## Mathematical Note:
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
38 ##
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
39 ## Elliptic integrals of the first kind are defined as
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
40 ##
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
41 ## @tex
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
42 ## $$
20530
8c4317b8f7c5 ellipke.m: Use correct definition of elliptic integral in documentation (bug #45522).
Rik <rik@octave.org>
parents: 20465
diff changeset
43 ## {\rm K} (m) = \int_0^1 {dt \over \sqrt{(1 - t^2) (1 - m t^2)}}
19287
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
44 ## $$
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
45 ## @end tex
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
46 ## @ifnottex
16586
f423873d3275 Style fixes for ellipj.cc, ellipke.m, and expint.m
Mike Miller <mtmiller@ieee.org>
parents: 16585
diff changeset
47 ##
19287
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
48 ## @example
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
49 ## @group
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
50 ## 1
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
51 ## / dt
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
52 ## K (m) = | ------------------------------
20530
8c4317b8f7c5 ellipke.m: Use correct definition of elliptic integral in documentation (bug #45522).
Rik <rik@octave.org>
parents: 20465
diff changeset
53 ## / sqrt ((1 - t^2)*(1 - m*t^2))
19287
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
54 ## 0
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
55 ## @end group
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
56 ## @end example
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
57 ##
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
58 ## @end ifnottex
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
59 ##
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
60 ## Elliptic integrals of the second kind are defined as
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
61 ##
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
62 ## @tex
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
63 ## $$
20530
8c4317b8f7c5 ellipke.m: Use correct definition of elliptic integral in documentation (bug #45522).
Rik <rik@octave.org>
parents: 20465
diff changeset
64 ## {\rm E} (m) = \int_0^1 {\sqrt{1 - m t^2} \over \sqrt{1 - t^2}} dt
19287
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
65 ## $$
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
66 ## @end tex
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
67 ## @ifnottex
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
68 ##
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
69 ## @example
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
70 ## @group
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
71 ## 1
20530
8c4317b8f7c5 ellipke.m: Use correct definition of elliptic integral in documentation (bug #45522).
Rik <rik@octave.org>
parents: 20465
diff changeset
72 ## / sqrt (1 - m*t^2)
19287
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
73 ## E (m) = | ------------------ dt
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
74 ## / sqrt (1 - t^2)
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
75 ## 0
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
76 ## @end group
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
77 ## @end example
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
78 ##
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
79 ## @end ifnottex
16584
2f766ceeb03e Add ellipj, ellipke, and expint functions from Octave Forge
Mike Miller <mtmiller@ieee.org>
parents:
diff changeset
80 ##
19232
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 17744
diff changeset
81 ## Reference: Milton @nospell{Abramowitz} and Irene A. @nospell{Stegun},
17370
c7c0dad2f9ac doc: Use Octave citation style for references in ellipj, ellipke.
Rik <rik@octave.org>
parents: 17336
diff changeset
82 ## @cite{Handbook of Mathematical Functions}, Chapter 17, Dover, 1965.
16584
2f766ceeb03e Add ellipj, ellipke, and expint functions from Octave Forge
Mike Miller <mtmiller@ieee.org>
parents:
diff changeset
83 ## @seealso{ellipj}
2f766ceeb03e Add ellipj, ellipke, and expint functions from Octave Forge
Mike Miller <mtmiller@ieee.org>
parents:
diff changeset
84 ## @end deftypefn
2f766ceeb03e Add ellipj, ellipke, and expint functions from Octave Forge
Mike Miller <mtmiller@ieee.org>
parents:
diff changeset
85
16768
e2de3c8882be copyright notice fixes
John W. Eaton <jwe@octave.org>
parents: 16587
diff changeset
86 ## Author: David Billinghurst <David.Billinghurst@riotinto.com>
e2de3c8882be copyright notice fixes
John W. Eaton <jwe@octave.org>
parents: 16587
diff changeset
87 ## Author: Paul Kienzle <pkienzle@users.sf.net>
e2de3c8882be copyright notice fixes
John W. Eaton <jwe@octave.org>
parents: 16587
diff changeset
88 ## Author: Jaakko Ruohio
e2de3c8882be copyright notice fixes
John W. Eaton <jwe@octave.org>
parents: 16587
diff changeset
89
19287
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
90 function [k, e] = ellipke (m, tol = [])
16584
2f766ceeb03e Add ellipj, ellipke, and expint functions from Octave Forge
Mike Miller <mtmiller@ieee.org>
parents:
diff changeset
91
2f766ceeb03e Add ellipj, ellipke, and expint functions from Octave Forge
Mike Miller <mtmiller@ieee.org>
parents:
diff changeset
92 if (nargin < 1 || nargin > 2)
16586
f423873d3275 Style fixes for ellipj.cc, ellipke.m, and expint.m
Mike Miller <mtmiller@ieee.org>
parents: 16585
diff changeset
93 print_usage ();
16584
2f766ceeb03e Add ellipj, ellipke, and expint functions from Octave Forge
Mike Miller <mtmiller@ieee.org>
parents:
diff changeset
94 endif
2f766ceeb03e Add ellipj, ellipke, and expint functions from Octave Forge
Mike Miller <mtmiller@ieee.org>
parents:
diff changeset
95
19287
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
96 sz = size (m);
17371
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
97 if (! isreal (m))
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
98 error ("ellipke: M must be real");
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
99 elseif (any (m > 1))
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
100 error ("ellipke: M must be <= 1");
16584
2f766ceeb03e Add ellipj, ellipke, and expint functions from Octave Forge
Mike Miller <mtmiller@ieee.org>
parents:
diff changeset
101 endif
19794
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19287
diff changeset
102
19287
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
103 if (isempty (tol))
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
104 tol = eps (class (m));
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
105 elseif (! (isreal (tol) && isscalar (tol) && tol > 0))
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
106 error ("ellipke: TOL must be a real scalar > 0")
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
107 endif
16584
2f766ceeb03e Add ellipj, ellipke, and expint functions from Octave Forge
Mike Miller <mtmiller@ieee.org>
parents:
diff changeset
108
19287
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
109 k = e = zeros (sz);
16586
f423873d3275 Style fixes for ellipj.cc, ellipke.m, and expint.m
Mike Miller <mtmiller@ieee.org>
parents: 16585
diff changeset
110
17371
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
111 ## Handle extreme values
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
112 idx_1 = (m == 1);
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
113 k(idx_1) = Inf;
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
114 e(idx_1) = 1;
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
115
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
116 idx_neginf = (m == -Inf);
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
117 k(idx_neginf) = 0;
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
118 e(idx_neginf) = Inf;
16584
2f766ceeb03e Add ellipj, ellipke, and expint functions from Octave Forge
Mike Miller <mtmiller@ieee.org>
parents:
diff changeset
119
2f766ceeb03e Add ellipj, ellipke, and expint functions from Octave Forge
Mike Miller <mtmiller@ieee.org>
parents:
diff changeset
120 ## Arithmetic-Geometric Mean (AGM) algorithm
2f766ceeb03e Add ellipj, ellipke, and expint functions from Octave Forge
Mike Miller <mtmiller@ieee.org>
parents:
diff changeset
121 ## ( Abramowitz and Stegun, Section 17.6 )
17371
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
122 Nmax = 16;
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
123 idx = !idx_1 & !idx_neginf;
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
124 if (any (idx))
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
125 idx_neg = find (m < 0 & !idx_neginf);
16586
f423873d3275 Style fixes for ellipj.cc, ellipke.m, and expint.m
Mike Miller <mtmiller@ieee.org>
parents: 16585
diff changeset
126 mult_k = 1./sqrt (1 - m(idx_neg));
f423873d3275 Style fixes for ellipj.cc, ellipke.m, and expint.m
Mike Miller <mtmiller@ieee.org>
parents: 16585
diff changeset
127 mult_e = sqrt (1 - m(idx_neg));
17371
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
128 m(idx_neg) = -m(idx_neg) ./ (1 - m(idx_neg));
16586
f423873d3275 Style fixes for ellipj.cc, ellipke.m, and expint.m
Mike Miller <mtmiller@ieee.org>
parents: 16585
diff changeset
129 b = sqrt (1 - m(idx));
20465
507ccf8f10ed ellipke.m: Modify to accept row vectors (bug #45283).
Michele Zaffalon <michele.zaffalon@bruker.com>
parents: 19794
diff changeset
130 a = ones (size (b));
16586
f423873d3275 Style fixes for ellipj.cc, ellipke.m, and expint.m
Mike Miller <mtmiller@ieee.org>
parents: 16585
diff changeset
131 c = sqrt (m(idx));
16584
2f766ceeb03e Add ellipj, ellipke, and expint functions from Octave Forge
Mike Miller <mtmiller@ieee.org>
parents:
diff changeset
132 f = 0.5;
17371
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
133 sum = f*c.^2;
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
134 n = 2;
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
135 do
16586
f423873d3275 Style fixes for ellipj.cc, ellipke.m, and expint.m
Mike Miller <mtmiller@ieee.org>
parents: 16585
diff changeset
136 t = (a + b)/2;
f423873d3275 Style fixes for ellipj.cc, ellipke.m, and expint.m
Mike Miller <mtmiller@ieee.org>
parents: 16585
diff changeset
137 c = (a - b)/2;
19287
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
138 b = sqrt (a .* b);
16584
2f766ceeb03e Add ellipj, ellipke, and expint functions from Octave Forge
Mike Miller <mtmiller@ieee.org>
parents:
diff changeset
139 a = t;
17371
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
140 f *= 2;
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
141 sum += f*c.^2;
19287
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
142 until (all (c./a < tol) || (++n > Nmax))
17371
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
143 if (n >= Nmax)
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
144 error ("ellipke: algorithm did not converge in %d iterations", Nmax);
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
145 endif
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
146 k(idx) = 0.5*pi ./ a;
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
147 e(idx) = 0.5*pi*(1 - sum) ./ a;
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
148 k(idx_neg) = mult_k .* k(idx_neg);
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
149 e(idx_neg) = mult_e .* e(idx_neg);
16584
2f766ceeb03e Add ellipj, ellipke, and expint functions from Octave Forge
Mike Miller <mtmiller@ieee.org>
parents:
diff changeset
150 endif
2f766ceeb03e Add ellipj, ellipke, and expint functions from Octave Forge
Mike Miller <mtmiller@ieee.org>
parents:
diff changeset
151
2f766ceeb03e Add ellipj, ellipke, and expint functions from Octave Forge
Mike Miller <mtmiller@ieee.org>
parents:
diff changeset
152 endfunction
2f766ceeb03e Add ellipj, ellipke, and expint functions from Octave Forge
Mike Miller <mtmiller@ieee.org>
parents:
diff changeset
153
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 16933
diff changeset
154
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 16933
diff changeset
155 ## Test complete elliptic functions of first and second kind
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 16933
diff changeset
156 ## against "exact" solution from Mathematica 3.0
16584
2f766ceeb03e Add ellipj, ellipke, and expint functions from Octave Forge
Mike Miller <mtmiller@ieee.org>
parents:
diff changeset
157 %!test
19287
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
158 %! m = [0.0, 0.01; 0.1, 0.5; 0.9, 0.99; 1.0, 0.0];
16586
f423873d3275 Style fixes for ellipj.cc, ellipke.m, and expint.m
Mike Miller <mtmiller@ieee.org>
parents: 16585
diff changeset
159 %! [k,e] = ellipke (m);
16584
2f766ceeb03e Add ellipj, ellipke, and expint functions from Octave Forge
Mike Miller <mtmiller@ieee.org>
parents:
diff changeset
160 %!
19287
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
161 %! k_exp = [1.5707963267948966192, 1.5747455615173559527
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
162 %! 1.6124413487202193982, 1.8540746773013719184
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
163 %! 2.5780921133481731882, 3.6956373629898746778
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
164 %! Inf , 1.5707963267948966192 ];
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
165 %! e_exp = [1.5707963267948966192, 1.5668619420216682912
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
166 %! 1.5307576368977632025, 1.3506438810476755025
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
167 %! 1.1047747327040733261, 1.0159935450252239356
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
168 %! 1.0 , 1.5707963267948966192 ];
16586
f423873d3275 Style fixes for ellipj.cc, ellipke.m, and expint.m
Mike Miller <mtmiller@ieee.org>
parents: 16585
diff changeset
169 %! assert (k, k_exp, 8*eps);
f423873d3275 Style fixes for ellipj.cc, ellipke.m, and expint.m
Mike Miller <mtmiller@ieee.org>
parents: 16585
diff changeset
170 %! assert (e, e_exp, 8*eps);
16585
1a3bfb14b5da Add and fix tests for ellipj, ellipke, and expint
Mike Miller <mtmiller@ieee.org>
parents: 16584
diff changeset
171
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 16933
diff changeset
172 ## Test against A&S Table 17.1
16585
1a3bfb14b5da Add and fix tests for ellipj, ellipke, and expint
Mike Miller <mtmiller@ieee.org>
parents: 16584
diff changeset
173 %!test
1a3bfb14b5da Add and fix tests for ellipj, ellipke, and expint
Mike Miller <mtmiller@ieee.org>
parents: 16584
diff changeset
174 %! m = [0:5:50]'/100;
1a3bfb14b5da Add and fix tests for ellipj, ellipke, and expint
Mike Miller <mtmiller@ieee.org>
parents: 16584
diff changeset
175 %! k_exp = [1.570796326794897;
1a3bfb14b5da Add and fix tests for ellipj, ellipke, and expint
Mike Miller <mtmiller@ieee.org>
parents: 16584
diff changeset
176 %! 1.591003453790792;
1a3bfb14b5da Add and fix tests for ellipj, ellipke, and expint
Mike Miller <mtmiller@ieee.org>
parents: 16584
diff changeset
177 %! 1.612441348720219;
1a3bfb14b5da Add and fix tests for ellipj, ellipke, and expint
Mike Miller <mtmiller@ieee.org>
parents: 16584
diff changeset
178 %! 1.635256732264580;
1a3bfb14b5da Add and fix tests for ellipj, ellipke, and expint
Mike Miller <mtmiller@ieee.org>
parents: 16584
diff changeset
179 %! 1.659623598610528;
1a3bfb14b5da Add and fix tests for ellipj, ellipke, and expint
Mike Miller <mtmiller@ieee.org>
parents: 16584
diff changeset
180 %! 1.685750354812596;
1a3bfb14b5da Add and fix tests for ellipj, ellipke, and expint
Mike Miller <mtmiller@ieee.org>
parents: 16584
diff changeset
181 %! 1.713889448178791;
1a3bfb14b5da Add and fix tests for ellipj, ellipke, and expint
Mike Miller <mtmiller@ieee.org>
parents: 16584
diff changeset
182 %! 1.744350597225613;
1a3bfb14b5da Add and fix tests for ellipj, ellipke, and expint
Mike Miller <mtmiller@ieee.org>
parents: 16584
diff changeset
183 %! 1.777519371491253;
1a3bfb14b5da Add and fix tests for ellipj, ellipke, and expint
Mike Miller <mtmiller@ieee.org>
parents: 16584
diff changeset
184 %! 1.813883936816983;
1a3bfb14b5da Add and fix tests for ellipj, ellipke, and expint
Mike Miller <mtmiller@ieee.org>
parents: 16584
diff changeset
185 %! 1.854074677301372 ];
1a3bfb14b5da Add and fix tests for ellipj, ellipke, and expint
Mike Miller <mtmiller@ieee.org>
parents: 16584
diff changeset
186 %! e_exp = [1.570796327;
1a3bfb14b5da Add and fix tests for ellipj, ellipke, and expint
Mike Miller <mtmiller@ieee.org>
parents: 16584
diff changeset
187 %! 1.550973352;
1a3bfb14b5da Add and fix tests for ellipj, ellipke, and expint
Mike Miller <mtmiller@ieee.org>
parents: 16584
diff changeset
188 %! 1.530757637;
1a3bfb14b5da Add and fix tests for ellipj, ellipke, and expint
Mike Miller <mtmiller@ieee.org>
parents: 16584
diff changeset
189 %! 1.510121831;
1a3bfb14b5da Add and fix tests for ellipj, ellipke, and expint
Mike Miller <mtmiller@ieee.org>
parents: 16584
diff changeset
190 %! 1.489035058;
1a3bfb14b5da Add and fix tests for ellipj, ellipke, and expint
Mike Miller <mtmiller@ieee.org>
parents: 16584
diff changeset
191 %! 1.467462209;
1a3bfb14b5da Add and fix tests for ellipj, ellipke, and expint
Mike Miller <mtmiller@ieee.org>
parents: 16584
diff changeset
192 %! 1.445363064;
1a3bfb14b5da Add and fix tests for ellipj, ellipke, and expint
Mike Miller <mtmiller@ieee.org>
parents: 16584
diff changeset
193 %! 1.422691133;
1a3bfb14b5da Add and fix tests for ellipj, ellipke, and expint
Mike Miller <mtmiller@ieee.org>
parents: 16584
diff changeset
194 %! 1.399392139;
1a3bfb14b5da Add and fix tests for ellipj, ellipke, and expint
Mike Miller <mtmiller@ieee.org>
parents: 16584
diff changeset
195 %! 1.375401972;
1a3bfb14b5da Add and fix tests for ellipj, ellipke, and expint
Mike Miller <mtmiller@ieee.org>
parents: 16584
diff changeset
196 %! 1.350643881 ];
1a3bfb14b5da Add and fix tests for ellipj, ellipke, and expint
Mike Miller <mtmiller@ieee.org>
parents: 16584
diff changeset
197 %! [k,e] = ellipke (m);
1a3bfb14b5da Add and fix tests for ellipj, ellipke, and expint
Mike Miller <mtmiller@ieee.org>
parents: 16584
diff changeset
198 %! assert (k, k_exp, 1e-15);
1a3bfb14b5da Add and fix tests for ellipj, ellipke, and expint
Mike Miller <mtmiller@ieee.org>
parents: 16584
diff changeset
199 %! assert (e, e_exp, 1e-8);
1a3bfb14b5da Add and fix tests for ellipj, ellipke, and expint
Mike Miller <mtmiller@ieee.org>
parents: 16584
diff changeset
200
17371
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
201 ## Test negative values against "exact" solution from Mathematica.
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
202 %! m = [-0.01; -1; -5; -100; -1000; -Inf];
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
203 %! [k,e] = ellipke (m);
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
204 %!
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
205 %! k_exp = [1.5668912730681963584;
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
206 %! 1.3110287771460599052;
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
207 %! 0.9555039270640439337;
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
208 %! 0.3682192486091410329;
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
209 %! 0.1530293349884987857;
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
210 %! 0];
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
211 %! e_exp = [1.5747159850169884130;
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
212 %! 1.9100988945138560089;
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
213 %! 2.8301982463458773125;
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
214 %! 10.209260919814572009;
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
215 %! 31.707204053711259719;
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
216 %! Inf ];
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
217 %! assert (k, k_exp, 8*eps);
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
218 %! assert (e, e_exp, 8*eps (e_exp));
f9e8544ce66d ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 17370
diff changeset
219
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 16933
diff changeset
220 ## Test input validation
16585
1a3bfb14b5da Add and fix tests for ellipj, ellipke, and expint
Mike Miller <mtmiller@ieee.org>
parents: 16584
diff changeset
221 %!error ellipke ()
1a3bfb14b5da Add and fix tests for ellipj, ellipke, and expint
Mike Miller <mtmiller@ieee.org>
parents: 16584
diff changeset
222 %!error ellipke (1,2,3)
19287
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
223 %!error <M must be real> ellipke (1i)
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
224 %!error <M must be .= 1> ellipke (2)
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
225 %!error <TOL must be a real scalar . 0> ellipke (1, i)
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
226 %!error <TOL must be a real scalar . 0> ellipke (1, [1 1])
4cf81bccaf1c ellipke.m: Overhaul function.
Rik <rik@octave.org>
parents: 19232
diff changeset
227 %!error <TOL must be a real scalar . 0> ellipke (1, -1)
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 16933
diff changeset
228