annotate scripts/special-matrix/vander.m @ 10791:3140cb7a05a1

Add spellchecker scripts for Octave and run spellcheck of documentation interpreter/doccheck: New directory for spelling/grammar scripts. interpreter/doccheck/README: Instructions for using scripts. interpreter/doccheck/spellcheck: Script to spellcheck a Texinfo file. interpreter/doccheck/aspell.conf: GNU Aspell configuration file for Octave documentation. interpreter/doccheck/aspell-octave.en.pws: Private Aspell dictionary. interpreter/doccheck/add_to_aspell_dict: Script to add new Octave-specific words to private Aspell dictionary. interpreter/octave.texi: New @nospell macro which forces Aspell to ignore the word marked by the macro. interpreter/mk_doc_cache.m: Skip new @nospell macro when building doc_cache.
author Rik <octave@nomad.inbox5.com>
date Sat, 17 Jul 2010 19:53:01 -0700
parents f0c3d3fc4903
children 693e22af08ae
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 John W. Eaton
9104
e0250e2b60ed optimize vander
Jaroslav Hajek <highegg@gmail.com>
parents: 9041
diff changeset
3 ## Copyright (C) 2009 VZLU Prague
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
5 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
6 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
7 ## 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
8 ## 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
9 ## 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
10 ## your option) any later version.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
11 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
12 ## 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
13 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
14 ## 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
15 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
16 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
17 ## 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
18 ## 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
19 ## <http://www.gnu.org/licenses/>.
245
16a24e76d6e0 [project @ 1993-12-03 02:00:15 by jwe]
jwe
parents: 4
diff changeset
20
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3140
diff changeset
21 ## -*- texinfo -*-
10791
3140cb7a05a1 Add spellchecker scripts for Octave and run spellcheck of documentation
Rik <octave@nomad.inbox5.com>
parents: 9211
diff changeset
22 ## @deftypefn {Function File} {} vander (@var{c})
3140cb7a05a1 Add spellchecker scripts for Octave and run spellcheck of documentation
Rik <octave@nomad.inbox5.com>
parents: 9211
diff changeset
23 ## @deftypefnx {Function File} {} vander (@var{c}, @var{n})
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3140
diff changeset
24 ## Return the Vandermonde matrix whose next to last column is @var{c}.
9137
eebc7f8e7398 extend vander to allow specified number of columns
Jaroslav Hajek <highegg@gmail.com>
parents: 9104
diff changeset
25 ## If @var{n} is specified, it determines the number of columns;
eebc7f8e7398 extend vander to allow specified number of columns
Jaroslav Hajek <highegg@gmail.com>
parents: 9104
diff changeset
26 ## otherwise, @var{n} is taken to be equal to the length of @var{c}.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
27 ##
5016
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4030
diff changeset
28 ## A Vandermonde matrix has the form:
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3140
diff changeset
29 ## @tex
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3140
diff changeset
30 ## $$
5016
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4030
diff changeset
31 ## \left[\matrix{c_1^{n-1} & \cdots & c_1^2 & c_1 & 1 \cr
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4030
diff changeset
32 ## c_2^{n-1} & \cdots & c_2^2 & c_2 & 1 \cr
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4030
diff changeset
33 ## \vdots & \ddots & \vdots & \vdots & \vdots \cr
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4030
diff changeset
34 ## c_n^{n-1} & \cdots & c_n^2 & c_n & 1 }\right]
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3140
diff changeset
35 ## $$
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3140
diff changeset
36 ## @end tex
8517
81d6ab3ac93c Allow documentation tobe built for other formats than tex and info
sh@sh-laptop
parents: 7411
diff changeset
37 ## @ifnottex
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
38 ##
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3140
diff changeset
39 ## @example
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3140
diff changeset
40 ## @group
9041
853f96e8008f Cleanup documentation file matrix.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
41 ## c(1)^(n-1) @dots{} c(1)^2 c(1) 1
853f96e8008f Cleanup documentation file matrix.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
42 ## c(2)^(n-1) @dots{} c(2)^2 c(2) 1
5016
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4030
diff changeset
43 ## . . . . .
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4030
diff changeset
44 ## . . . . .
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4030
diff changeset
45 ## . . . . .
9041
853f96e8008f Cleanup documentation file matrix.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
46 ## c(n)^(n-1) @dots{} c(n)^2 c(n) 1
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3140
diff changeset
47 ## @end group
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3140
diff changeset
48 ## @end example
8517
81d6ab3ac93c Allow documentation tobe built for other formats than tex and info
sh@sh-laptop
parents: 7411
diff changeset
49 ## @end ifnottex
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5307
diff changeset
50 ## @seealso{hankel, sylvester_matrix, hilb, invhilb, toeplitz}
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3140
diff changeset
51 ## @end deftypefn
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
52
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
53 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
54
9137
eebc7f8e7398 extend vander to allow specified number of columns
Jaroslav Hajek <highegg@gmail.com>
parents: 9104
diff changeset
55 function retval = vander (c, n)
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
56
9137
eebc7f8e7398 extend vander to allow specified number of columns
Jaroslav Hajek <highegg@gmail.com>
parents: 9104
diff changeset
57 if (nargin == 1)
eebc7f8e7398 extend vander to allow specified number of columns
Jaroslav Hajek <highegg@gmail.com>
parents: 9104
diff changeset
58 n = length (c);
eebc7f8e7398 extend vander to allow specified number of columns
Jaroslav Hajek <highegg@gmail.com>
parents: 9104
diff changeset
59 elseif (nargin != 2)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5642
diff changeset
60 print_usage ();
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
61 endif
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
62
4030
22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe]
jwe
parents: 3885
diff changeset
63 if (isvector (c))
9137
eebc7f8e7398 extend vander to allow specified number of columns
Jaroslav Hajek <highegg@gmail.com>
parents: 9104
diff changeset
64 retval = zeros (length (c), n, class (c));
9104
e0250e2b60ed optimize vander
Jaroslav Hajek <highegg@gmail.com>
parents: 9041
diff changeset
65 ## avoiding many ^s appears to be faster for n >= 100.
e0250e2b60ed optimize vander
Jaroslav Hajek <highegg@gmail.com>
parents: 9041
diff changeset
66 d = 1;
e0250e2b60ed optimize vander
Jaroslav Hajek <highegg@gmail.com>
parents: 9041
diff changeset
67 c = c(:);
e0250e2b60ed optimize vander
Jaroslav Hajek <highegg@gmail.com>
parents: 9041
diff changeset
68 for i = n:-1:1
e0250e2b60ed optimize vander
Jaroslav Hajek <highegg@gmail.com>
parents: 9041
diff changeset
69 retval(:,i) = d;
e0250e2b60ed optimize vander
Jaroslav Hajek <highegg@gmail.com>
parents: 9041
diff changeset
70 d = c .* d;
e0250e2b60ed optimize vander
Jaroslav Hajek <highegg@gmail.com>
parents: 9041
diff changeset
71 endfor
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
72 else
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
73 error ("vander: argument must be a vector");
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
74 endif
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
75
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
76 endfunction
7387
b429b21abdd4 [project @ 2008-01-15 21:43:11 by jwe]
jwe
parents: 7017
diff changeset
77
b429b21abdd4 [project @ 2008-01-15 21:43:11 by jwe]
jwe
parents: 7017
diff changeset
78 %!test
b429b21abdd4 [project @ 2008-01-15 21:43:11 by jwe]
jwe
parents: 7017
diff changeset
79 %! c = [0,1,2,3];
b429b21abdd4 [project @ 2008-01-15 21:43:11 by jwe]
jwe
parents: 7017
diff changeset
80 %! expect = [0,0,0,1; 1,1,1,1; 8,4,2,1; 27,9,3,1];
b429b21abdd4 [project @ 2008-01-15 21:43:11 by jwe]
jwe
parents: 7017
diff changeset
81 %! result = vander(c);
b429b21abdd4 [project @ 2008-01-15 21:43:11 by jwe]
jwe
parents: 7017
diff changeset
82 %! assert(expect, result);
7411
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7387
diff changeset
83
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7387
diff changeset
84 %!assert((vander (1) == 1 && vander ([1, 2, 3]) == vander ([1; 2; 3])
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7387
diff changeset
85 %! && vander ([1, 2, 3]) == [1, 1, 1; 4, 2, 1; 9, 3, 1]
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7387
diff changeset
86 %! && vander ([1, 2, 3]*i) == [-1, i, 1; -4, 2i, 1; -9, 3i, 1]));
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7387
diff changeset
87
9140
c309e028185e vander.m: update tests
John W. Eaton <jwe@octave.org>
parents: 9137
diff changeset
88 %!assert(vander (2, 3), [4, 2, 1])
c309e028185e vander.m: update tests
John W. Eaton <jwe@octave.org>
parents: 9137
diff changeset
89 %!assert(vander ([2, 3], 3), [4, 2, 1; 9, 3, 1])
c309e028185e vander.m: update tests
John W. Eaton <jwe@octave.org>
parents: 9137
diff changeset
90
7411
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7387
diff changeset
91 %!error vander ([1, 2; 3, 4]);
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7387
diff changeset
92
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7387
diff changeset
93 %!error vander ();
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7387
diff changeset
94
9140
c309e028185e vander.m: update tests
John W. Eaton <jwe@octave.org>
parents: 9137
diff changeset
95 %!error vander (1, 2, 3);
7411
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7387
diff changeset
96