annotate liboctave/NLFunc.h @ 7017:a1dbe9d80eee

[project @ 2007-10-12 21:27:11 by jwe]
author jwe
date Fri, 12 Oct 2007 21:27:37 +0000
parents 93c65f2a5668
children
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
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
3 Copyright (C) 1993, 1994, 1995, 1996, 1997, 2005, 2007 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
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
9 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
10 option) any later version.
3
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
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
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: 5307
diff changeset
19 <http://www.gnu.org/licenses/>.
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
20
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
382
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe]
jwe
parents: 252
diff changeset
23 #if !defined (octave_NLFunc_h)
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe]
jwe
parents: 252
diff changeset
24 #define octave_NLFunc_h 1
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe]
jwe
parents: 252
diff changeset
25
461
00f8b2242a18 [project @ 1994-06-06 00:45:57 by jwe]
jwe
parents: 450
diff changeset
26 class ColumnVector;
00f8b2242a18 [project @ 1994-06-06 00:45:57 by jwe]
jwe
parents: 450
diff changeset
27 class Matrix;
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
28
1864
e1c4dd0d503d [project @ 1996-02-04 10:43:13 by jwe]
jwe
parents: 1536
diff changeset
29 class
e1c4dd0d503d [project @ 1996-02-04 10:43:13 by jwe]
jwe
parents: 1536
diff changeset
30 NLFunc
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
31 {
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
32 public:
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
33
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1533
diff changeset
34 typedef ColumnVector (*nonlinear_fcn) (const ColumnVector&);
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1533
diff changeset
35 typedef Matrix (*jacobian_fcn) (const ColumnVector&);
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1533
diff changeset
36
1533
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
37 NLFunc (void)
1864
e1c4dd0d503d [project @ 1996-02-04 10:43:13 by jwe]
jwe
parents: 1536
diff changeset
38 : fun (0), jac (0) { }
1533
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
39
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
40 NLFunc (const nonlinear_fcn f)
1864
e1c4dd0d503d [project @ 1996-02-04 10:43:13 by jwe]
jwe
parents: 1536
diff changeset
41 : fun (f), jac (0) { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
42
1533
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
43 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
44 : fun (f), jac (j) { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
45
1533
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
46 NLFunc (const NLFunc& a)
1864
e1c4dd0d503d [project @ 1996-02-04 10:43:13 by jwe]
jwe
parents: 1536
diff changeset
47 : fun (a.fun), jac (a.jac) { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
48
1533
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
49 NLFunc& operator = (const NLFunc& a)
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
50 {
1864
e1c4dd0d503d [project @ 1996-02-04 10:43:13 by jwe]
jwe
parents: 1536
diff changeset
51 if (this != &a)
e1c4dd0d503d [project @ 1996-02-04 10:43:13 by jwe]
jwe
parents: 1536
diff changeset
52 {
e1c4dd0d503d [project @ 1996-02-04 10:43:13 by jwe]
jwe
parents: 1536
diff changeset
53 fun = a.fun;
e1c4dd0d503d [project @ 1996-02-04 10:43:13 by jwe]
jwe
parents: 1536
diff changeset
54 jac = a.jac;
e1c4dd0d503d [project @ 1996-02-04 10:43:13 by jwe]
jwe
parents: 1536
diff changeset
55 }
1533
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
56 return *this;
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
57 }
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
58
1864
e1c4dd0d503d [project @ 1996-02-04 10:43:13 by jwe]
jwe
parents: 1536
diff changeset
59 ~NLFunc (void) { }
e1c4dd0d503d [project @ 1996-02-04 10:43:13 by jwe]
jwe
parents: 1536
diff changeset
60
1533
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
61 nonlinear_fcn function (void) const { return fun; }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
62
1533
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
63 NLFunc& set_function (const nonlinear_fcn f)
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
64 {
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
65 fun = f;
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
66 return *this;
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
67 }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
68
1533
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
69 jacobian_fcn jacobian_function (void) const { return jac; }
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
70
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
71 NLFunc& set_jacobian_function (const jacobian_fcn j)
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
72 {
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
73 jac = j;
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
74 return *this;
fe059f3bae29 [project @ 1995-10-05 05:30:03 by jwe]
jwe
parents: 1315
diff changeset
75 }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
76
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
77 protected:
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
78
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
79 nonlinear_fcn fun;
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
80 jacobian_fcn jac;
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
81 };
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 #endif
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
84
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 ;;; Local Variables: ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
87 ;;; mode: C++ ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
88 ;;; End: ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
89 */