annotate scripts/polynomial/polyfit.m @ 6046:34f96dd5441b

[project @ 2006-10-10 16:10:25 by jwe]
author jwe
date Tue, 10 Oct 2006 16:10:31 +0000
parents 2a16423e4aa0
children 045038e0108a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3092
4bb976b250bf [project @ 1997-10-17 07:48:48 by jwe]
jwe
parents: 3091
diff changeset
1 ## Copyright (C) 1996, 1997 John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
2 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
6 ## under the terms of the GNU General Public License as published by
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
7 ## the Free Software Foundation; either version 2, or (at your option)
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
8 ## any later version.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
15 ## You should have received a copy of the GNU General Public License
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
5307
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 4491
diff changeset
17 ## Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 4491
diff changeset
18 ## 02110-1301, USA.
2303
5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe]
jwe
parents: 2261
diff changeset
19
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3246
diff changeset
20 ## -*- texinfo -*-
4491
96a25f032846 [project @ 2003-08-28 21:01:21 by jwe]
jwe
parents: 4030
diff changeset
21 ## @deftypefn {Function File} {[@var{p}, @var{s}] =} polyfit (@var{x}, @var{y}, @var{n})
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3246
diff changeset
22 ## Return the coefficients of a polynomial @var{p}(@var{x}) of degree
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3418
diff changeset
23 ## @var{n} that minimizes
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3246
diff changeset
24 ## @iftex
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3246
diff changeset
25 ## @tex
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3246
diff changeset
26 ## $$
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3246
diff changeset
27 ## \sum_{i=1}^N (p(x_i) - y_i)^2
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3246
diff changeset
28 ## $$
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3246
diff changeset
29 ## @end tex
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3246
diff changeset
30 ## @end iftex
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3246
diff changeset
31 ## @ifinfo
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3246
diff changeset
32 ## @code{sumsq (p(x(i)) - y(i))},
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3246
diff changeset
33 ## @end ifinfo
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3246
diff changeset
34 ## to best fit the data in the least squares sense.
3418
ca92c9d3f882 [project @ 2000-01-12 03:07:47 by jwe]
jwe
parents: 3368
diff changeset
35 ##
4491
96a25f032846 [project @ 2003-08-28 21:01:21 by jwe]
jwe
parents: 4030
diff changeset
36 ## The polynomial coefficients are returned in a row vector.
96a25f032846 [project @ 2003-08-28 21:01:21 by jwe]
jwe
parents: 4030
diff changeset
37 ##
96a25f032846 [project @ 2003-08-28 21:01:21 by jwe]
jwe
parents: 4030
diff changeset
38 ## If two output arguments are requested, the second is a structure
96a25f032846 [project @ 2003-08-28 21:01:21 by jwe]
jwe
parents: 4030
diff changeset
39 ## containing the following fields:
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3418
diff changeset
40 ##
4491
96a25f032846 [project @ 2003-08-28 21:01:21 by jwe]
jwe
parents: 4030
diff changeset
41 ## @table @code
96a25f032846 [project @ 2003-08-28 21:01:21 by jwe]
jwe
parents: 4030
diff changeset
42 ## @item R
96a25f032846 [project @ 2003-08-28 21:01:21 by jwe]
jwe
parents: 4030
diff changeset
43 ## The Cholesky factor of the Vandermonde matrix used to compute the
96a25f032846 [project @ 2003-08-28 21:01:21 by jwe]
jwe
parents: 4030
diff changeset
44 ## polynomial coefficients.
96a25f032846 [project @ 2003-08-28 21:01:21 by jwe]
jwe
parents: 4030
diff changeset
45 ## @item X
96a25f032846 [project @ 2003-08-28 21:01:21 by jwe]
jwe
parents: 4030
diff changeset
46 ## The Vandermonde matrix used to compute the polynomial coefficients.
96a25f032846 [project @ 2003-08-28 21:01:21 by jwe]
jwe
parents: 4030
diff changeset
47 ## @item df
96a25f032846 [project @ 2003-08-28 21:01:21 by jwe]
jwe
parents: 4030
diff changeset
48 ## The degrees of freedom.
96a25f032846 [project @ 2003-08-28 21:01:21 by jwe]
jwe
parents: 4030
diff changeset
49 ## @item normr
96a25f032846 [project @ 2003-08-28 21:01:21 by jwe]
jwe
parents: 4030
diff changeset
50 ## The norm of the residuals.
96a25f032846 [project @ 2003-08-28 21:01:21 by jwe]
jwe
parents: 4030
diff changeset
51 ## @item yf
96a25f032846 [project @ 2003-08-28 21:01:21 by jwe]
jwe
parents: 4030
diff changeset
52 ## The values of the polynomial for each value of @var{x}.
96a25f032846 [project @ 2003-08-28 21:01:21 by jwe]
jwe
parents: 4030
diff changeset
53 ## @end table
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3246
diff changeset
54 ## @end deftypefn
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
55
5428
2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe]
jwe
parents: 5395
diff changeset
56 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
2312
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
57 ## Created: 13 December 1994
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
58 ## Adapted-By: jwe
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
59
4491
96a25f032846 [project @ 2003-08-28 21:01:21 by jwe]
jwe
parents: 4030
diff changeset
60 function [p, s, mu] = polyfit (x, y, n)
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
61
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
62
2261
1b6e1629fb91 [project @ 1996-05-23 00:52:07 by jwe]
jwe
parents:
diff changeset
63 if (nargin != 3)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5428
diff changeset
64 print_usage ();
2261
1b6e1629fb91 [project @ 1996-05-23 00:52:07 by jwe]
jwe
parents:
diff changeset
65 endif
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
66
4030
22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe]
jwe
parents: 3426
diff changeset
67 if (! (isvector (x) && isvector (y) && size (x) == size (y)))
2261
1b6e1629fb91 [project @ 1996-05-23 00:52:07 by jwe]
jwe
parents:
diff changeset
68 error ("polyfit: x and y must be vectors of the same size");
1b6e1629fb91 [project @ 1996-05-23 00:52:07 by jwe]
jwe
parents:
diff changeset
69 endif
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
70
4030
22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe]
jwe
parents: 3426
diff changeset
71 if (! (isscalar (n) && n >= 0 && ! isinf (n) && n == round (n)))
2261
1b6e1629fb91 [project @ 1996-05-23 00:52:07 by jwe]
jwe
parents:
diff changeset
72 error ("polyfit: n must be a nonnegative integer");
1b6e1629fb91 [project @ 1996-05-23 00:52:07 by jwe]
jwe
parents:
diff changeset
73 endif
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
74
3091
b06dcbb6b3b1 [project @ 1997-10-10 16:26:47 by jwe]
jwe
parents: 3069
diff changeset
75 y_is_row_vector = (rows (y) == 1);
b06dcbb6b3b1 [project @ 1997-10-10 16:26:47 by jwe]
jwe
parents: 3069
diff changeset
76
2261
1b6e1629fb91 [project @ 1996-05-23 00:52:07 by jwe]
jwe
parents:
diff changeset
77 l = length (x);
1b6e1629fb91 [project @ 1996-05-23 00:52:07 by jwe]
jwe
parents:
diff changeset
78 x = reshape (x, l, 1);
1b6e1629fb91 [project @ 1996-05-23 00:52:07 by jwe]
jwe
parents:
diff changeset
79 y = reshape (y, l, 1);
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
80
4491
96a25f032846 [project @ 2003-08-28 21:01:21 by jwe]
jwe
parents: 4030
diff changeset
81 X = (x * ones (1, n+1)) .^ (ones (l, 1) * (n : -1 : 0));
2261
1b6e1629fb91 [project @ 1996-05-23 00:52:07 by jwe]
jwe
parents:
diff changeset
82
3190
70eb3f4136cd [project @ 1998-10-19 22:37:56 by jwe]
jwe
parents: 3105
diff changeset
83 p = X \ y;
3091
b06dcbb6b3b1 [project @ 1997-10-10 16:26:47 by jwe]
jwe
parents: 3069
diff changeset
84
4491
96a25f032846 [project @ 2003-08-28 21:01:21 by jwe]
jwe
parents: 4030
diff changeset
85 if (nargout > 1)
96a25f032846 [project @ 2003-08-28 21:01:21 by jwe]
jwe
parents: 4030
diff changeset
86
96a25f032846 [project @ 2003-08-28 21:01:21 by jwe]
jwe
parents: 4030
diff changeset
87 yf = X*p;
3105
f936c7f5074f [project @ 1997-11-19 04:36:17 by jwe]
jwe
parents: 3092
diff changeset
88
f936c7f5074f [project @ 1997-11-19 04:36:17 by jwe]
jwe
parents: 3092
diff changeset
89 if (y_is_row_vector)
4491
96a25f032846 [project @ 2003-08-28 21:01:21 by jwe]
jwe
parents: 4030
diff changeset
90 s.yf = yf.';
96a25f032846 [project @ 2003-08-28 21:01:21 by jwe]
jwe
parents: 4030
diff changeset
91 else
96a25f032846 [project @ 2003-08-28 21:01:21 by jwe]
jwe
parents: 4030
diff changeset
92 s.yf = yf;
3105
f936c7f5074f [project @ 1997-11-19 04:36:17 by jwe]
jwe
parents: 3092
diff changeset
93 endif
3091
b06dcbb6b3b1 [project @ 1997-10-10 16:26:47 by jwe]
jwe
parents: 3069
diff changeset
94
4491
96a25f032846 [project @ 2003-08-28 21:01:21 by jwe]
jwe
parents: 4030
diff changeset
95 [s.R, dummy] = chol (X'*X);
96a25f032846 [project @ 2003-08-28 21:01:21 by jwe]
jwe
parents: 4030
diff changeset
96 s.X = X;
96a25f032846 [project @ 2003-08-28 21:01:21 by jwe]
jwe
parents: 4030
diff changeset
97 s.df = l - n - 1;
96a25f032846 [project @ 2003-08-28 21:01:21 by jwe]
jwe
parents: 4030
diff changeset
98 s.normr = norm (yf - y);
2261
1b6e1629fb91 [project @ 1996-05-23 00:52:07 by jwe]
jwe
parents:
diff changeset
99
1b6e1629fb91 [project @ 1996-05-23 00:52:07 by jwe]
jwe
parents:
diff changeset
100 endif
1b6e1629fb91 [project @ 1996-05-23 00:52:07 by jwe]
jwe
parents:
diff changeset
101
5395
8db4eb48f546 [project @ 2005-06-16 20:19:18 by jwe]
jwe
parents: 5307
diff changeset
102 ## Return value should be a row vector.
8db4eb48f546 [project @ 2005-06-16 20:19:18 by jwe]
jwe
parents: 5307
diff changeset
103
8db4eb48f546 [project @ 2005-06-16 20:19:18 by jwe]
jwe
parents: 5307
diff changeset
104 p = p.';
8db4eb48f546 [project @ 2005-06-16 20:19:18 by jwe]
jwe
parents: 5307
diff changeset
105
2261
1b6e1629fb91 [project @ 1996-05-23 00:52:07 by jwe]
jwe
parents:
diff changeset
106 endfunction