annotate scripts/special-matrix/invhilb.m @ 8920:eb63fbe60fab

update copyright notices
author John W. Eaton <jwe@octave.org>
date Sat, 07 Mar 2009 10:41:27 -0500
parents 81d6ab3ac93c
children 1bf0ce0930be
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) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2002,
8920
eb63fbe60fab update copyright notices
John W. Eaton <jwe@octave.org>
parents: 8517
diff changeset
2 ## 2004, 2005, 2006, 2007, 2008, 2009 Dirk Laurie
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
3 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
4 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
5 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
6 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
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.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
10 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
11 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
14 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
15 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
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/>.
245
16a24e76d6e0 [project @ 1993-12-03 02:00:15 by jwe]
jwe
parents: 4
diff changeset
19
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3140
diff changeset
20 ## -*- texinfo -*-
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3140
diff changeset
21 ## @deftypefn {Function File} {} invhilb (@var{n})
3889
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
22 ## Return the inverse of a Hilbert matrix of order @var{n}. This can be
5435
66ad03c58880 [project @ 2005-08-31 20:41:47 by jwe]
jwe
parents: 5307
diff changeset
23 ## computed exactly using
3889
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
24 ## @tex
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
25 ## $$\eqalign{
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
26 ## A_{ij} &= -1^{i+j} (i+j-1)
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
27 ## \left( \matrix{n+i-1 \cr n-j } \right)
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
28 ## \left( \matrix{n+j-1 \cr n-i } \right)
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
29 ## \left( \matrix{i+j-2 \cr i-2 } \right)^2 \cr
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
30 ## &= { p(i)p(j) \over (i+j-1) }
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
31 ## }$$
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
32 ## where
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
33 ## $$
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
34 ## p(k) = -1^k \left( \matrix{ k+n-1 \cr k-1 } \right)
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
35 ## \left( \matrix{ n \cr k } \right)
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
36 ##$$
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
37 ## @end tex
8517
81d6ab3ac93c Allow documentation tobe built for other formats than tex and info
sh@sh-laptop
parents: 7411
diff changeset
38 ## @ifnottex
3889
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
39 ## @example
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
40 ##
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
41 ## (i+j) /n+i-1\ /n+j-1\ /i+j-2\ 2
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
42 ## A(i,j) = -1 (i+j-1)( )( ) ( )
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
43 ## \ n-j / \ n-i / \ i-2 /
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
44 ##
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
45 ## = p(i) p(j) / (i+j-1)
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
46 ##
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
47 ## @end example
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
48 ## where
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
49 ## @example
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
50 ## k /k+n-1\ /n\
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
51 ## p(k) = -1 ( ) ( )
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
52 ## \ k-1 / \k/
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
53 ## @end example
8517
81d6ab3ac93c Allow documentation tobe built for other formats than tex and info
sh@sh-laptop
parents: 7411
diff changeset
54 ## @end ifnottex
3889
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
55 ##
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
56 ## The validity of this formula can easily be checked by expanding
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
57 ## the binomial coefficients in both formulas as factorials. It can
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
58 ## be derived more directly via the theory of Cauchy matrices:
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
59 ## see J. W. Demmel, Applied Numerical Linear Algebra, page 92.
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
60 ##
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
61 ## Compare this with the numerical calculation of @code{inverse (hilb (n))},
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3140
diff changeset
62 ## which suffers from the ill-conditioning of the Hilbert matrix, and the
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3140
diff changeset
63 ## finite precision of your computer's floating point arithmetic.
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5435
diff changeset
64 ## @seealso{hankel, vander, sylvester_matrix, hilb, toeplitz}
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3140
diff changeset
65 ## @end deftypefn
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
66
5132
5c96a48f8dc2 [project @ 2005-02-08 17:20:38 by jwe]
jwe
parents: 5053
diff changeset
67 ## Author: Dirk Laurie <dlaurie@na-net.ornl.gov>
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
68
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
69 function retval = invhilb (n)
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
70
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
71 if (nargin != 1)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5642
diff changeset
72 print_usage ();
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
73 endif
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
74
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
75 nmax = length (n);
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
76 if (nmax == 1)
3889
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
77
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
78 ## The point about the second formula above is that when vectorized,
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
79 ## p(k) is evaluated for k=1:n which involves O(n) calls to bincoeff
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
80 ## instead of O(n^2).
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
81 ##
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
82 ## We evaluate the expression as (-1)^(i+j)*(p(i)*p(j))/(i+j-1) except
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
83 ## when p(i)*p(j) would overflow. In cases where p(i)*p(j) is an exact
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
84 ## machine number, the result is also exact. Otherwise we calculate
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
85 ## (-1)^(i+j)*p(i)*(p(j)/(i+j-1)).
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
86 ##
4031
2168f4a0e88d [project @ 2002-08-10 04:22:52 by jwe]
jwe
parents: 3889
diff changeset
87 ## The Octave bincoeff routine uses transcendental functions (gammaln
3889
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
88 ## and exp) rather than multiplications, for the sake of speed.
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
89 ## However, it rounds the answer to the nearest integer, which
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
90 ## justifies the claim about exactness made above.
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
91
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
92 retval = zeros (n);
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
93 k = [1:n];
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
94 p = k .* bincoeff (k+n-1, k-1) .* bincoeff (n, k);
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
95 p(2:2:n) = -p(2:2:n);
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
96 if (n < 203)
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
97 for l = 1:n
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
98 retval(l,:) = (p(l) * p) ./ [l:l+n-1];
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
99 endfor
3889
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
100 else
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
101 for l = 1:n
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
102 retval(l,:) = p(l) * (p ./ [l:l+n-1]);
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
103 endfor
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
104 endif
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
105 else
3889
ac24529a78a0 [project @ 2002-04-04 23:03:15 by jwe]
jwe
parents: 3408
diff changeset
106 error ("invhilb: expecting scalar argument, found something else");
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
107 endif
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
108
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
109 endfunction
7411
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
110
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
111 %!test
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
112 %! result4 = [16, -120, 240, -140;
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
113 %! -120, 1200, -2700, 1680;
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
114 %! 240, -2700, 6480, -4200;
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
115 %! -140, 1680, -4200, 2800];
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
116 %!
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
117 %! assert((invhilb (1) == 1 && invhilb (2) == [4, -6; -6, 12]
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
118 %! && invhilb (4) == result4
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
119 %! && abs (invhilb (7) * hilb (7) - eye (7)) < sqrt (eps)));
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
120
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
121 %!error invhilb ([1, 2]);
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
122
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
123 %!error invhilb ();
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
124
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
125 %!error invhilb (1, 2);
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
126