annotate liboctave/NLFunc.h @ 5915:b2e1be30c8e9 ss-2-9-7

[project @ 2006-07-28 18:08:56 by jwe]
author jwe
date Fri, 28 Jul 2006 18:08:56 +0000
parents 4c8a2e4e0717
children 93c65f2a5668
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
1 /*
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
2
2847
8b262e771614 [project @ 1997-03-27 16:18:26 by jwe]
jwe
parents: 1993
diff changeset
3 Copyright (C) 1996, 1997 John W. Eaton
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
4
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
6
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
9 Free Software Foundation; either version 2, or (at your option) any
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
10 later version.
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
11
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
15 for more details.
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
16
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
18 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: 2847
diff changeset
19 Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 2847
diff changeset
20 02110-1301, USA.
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
21
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
22 */
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
23
382
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe]
jwe
parents: 252
diff changeset
24 #if !defined (octave_NLFunc_h)
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe]
jwe
parents: 252
diff changeset
25 #define octave_NLFunc_h 1
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe]
jwe
parents: 252
diff changeset
26
461
00f8b2242a18 [project @ 1994-06-06 00:45:57 by jwe]
jwe
parents: 450
diff changeset
27 class ColumnVector;
00f8b2242a18 [project @ 1994-06-06 00:45:57 by jwe]
jwe
parents: 450
diff changeset
28 class Matrix;
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
29
1864
e1c4dd0d503d [project @ 1996-02-04 10:43:13 by jwe]
jwe
parents: 1536
diff changeset
30 class
e1c4dd0d503d [project @ 1996-02-04 10:43:13 by jwe]
jwe
parents: 1536
diff changeset
31 NLFunc
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
32 {
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
33 public:
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
34
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1533
diff changeset
35 typedef ColumnVector (*nonlinear_fcn) (const ColumnVector&);
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1533
diff changeset
36 typedef Matrix (*jacobian_fcn) (const ColumnVector&);
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1533
diff changeset
37
1533
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
38 NLFunc (void)
1864
e1c4dd0d503d [project @ 1996-02-04 10:43:13 by jwe]
jwe
parents: 1536
diff changeset
39 : fun (0), jac (0) { }
1533
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
40
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
41 NLFunc (const nonlinear_fcn f)
1864
e1c4dd0d503d [project @ 1996-02-04 10:43:13 by jwe]
jwe
parents: 1536
diff changeset
42 : fun (f), jac (0) { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
43
1533
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
44 NLFunc (const nonlinear_fcn f, const jacobian_fcn j)
1864
e1c4dd0d503d [project @ 1996-02-04 10:43:13 by jwe]
jwe
parents: 1536
diff changeset
45 : fun (f), jac (j) { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
46
1533
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
47 NLFunc (const NLFunc& a)
1864
e1c4dd0d503d [project @ 1996-02-04 10:43:13 by jwe]
jwe
parents: 1536
diff changeset
48 : fun (a.fun), jac (a.jac) { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
49
1533
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
50 NLFunc& operator = (const NLFunc& a)
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
51 {
1864
e1c4dd0d503d [project @ 1996-02-04 10:43:13 by jwe]
jwe
parents: 1536
diff changeset
52 if (this != &a)
e1c4dd0d503d [project @ 1996-02-04 10:43:13 by jwe]
jwe
parents: 1536
diff changeset
53 {
e1c4dd0d503d [project @ 1996-02-04 10:43:13 by jwe]
jwe
parents: 1536
diff changeset
54 fun = a.fun;
e1c4dd0d503d [project @ 1996-02-04 10:43:13 by jwe]
jwe
parents: 1536
diff changeset
55 jac = a.jac;
e1c4dd0d503d [project @ 1996-02-04 10:43:13 by jwe]
jwe
parents: 1536
diff changeset
56 }
1533
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
57 return *this;
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
58 }
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
59
1864
e1c4dd0d503d [project @ 1996-02-04 10:43:13 by jwe]
jwe
parents: 1536
diff changeset
60 ~NLFunc (void) { }
e1c4dd0d503d [project @ 1996-02-04 10:43:13 by jwe]
jwe
parents: 1536
diff changeset
61
1533
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
62 nonlinear_fcn function (void) const { return fun; }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
63
1533
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
64 NLFunc& set_function (const nonlinear_fcn f)
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
65 {
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
66 fun = f;
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
67 return *this;
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
68 }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
69
1533
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
70 jacobian_fcn jacobian_function (void) const { return jac; }
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
71
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
72 NLFunc& set_jacobian_function (const jacobian_fcn j)
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
73 {
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
74 jac = j;
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
75 return *this;
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
76 }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
77
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
78 protected:
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
79
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
80 nonlinear_fcn fun;
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
81 jacobian_fcn jac;
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
82 };
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
83
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
84 #endif
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
85
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
86 /*
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
87 ;;; Local Variables: ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
88 ;;; mode: C++ ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
89 ;;; End: ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
90 */