annotate liboctave/NLEqn.h @ 1993:1b57120c997b

[project @ 1996-03-03 01:16:15 by jwe]
author jwe
date Sun, 03 Mar 1996 01:16:15 +0000
parents d5ba1bd06584
children 8b262e771614
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
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
3 Copyright (C) 1996 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
1315
611d403c7f3d [project @ 1995-06-25 19:56:32 by jwe]
jwe
parents: 1296
diff changeset
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
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: 296
diff changeset
23 #if !defined (octave_NLEqn_h)
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe]
jwe
parents: 296
diff changeset
24 #define octave_NLEqn_h 1
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe]
jwe
parents: 296
diff changeset
25
1296
f93b7fa5e113 [project @ 1995-05-01 18:30:08 by jwe]
jwe
parents: 1011
diff changeset
26 #if defined (__GNUG__)
f93b7fa5e113 [project @ 1995-05-01 18:30:08 by jwe]
jwe
parents: 1011
diff changeset
27 #pragma interface
f93b7fa5e113 [project @ 1995-05-01 18:30:08 by jwe]
jwe
parents: 1011
diff changeset
28 #endif
f93b7fa5e113 [project @ 1995-05-01 18:30:08 by jwe]
jwe
parents: 1011
diff changeset
29
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
30 #include <cfloat>
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
31 #include <cmath>
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
32
465
4caf8fbeb778 [project @ 1994-06-06 01:05:09 by jwe]
jwe
parents: 384
diff changeset
33 #include "dColVector.h"
238
780cbbc57b7c [project @ 1993-11-30 20:23:04 by jwe]
jwe
parents: 3
diff changeset
34 #include "NLFunc.h"
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
35
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
36 class
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
37 NLEqn_options
289
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 252
diff changeset
38 {
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
39 public:
289
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 252
diff changeset
40
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
41 NLEqn_options (void)
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
42 : x_tolerance (::sqrt (DBL_EPSILON)) { }
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
43
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
44 NLEqn_options (const NLEqn_options& opt)
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
45 : x_tolerance (opt.x_tolerance) { }
289
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 252
diff changeset
46
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
47 NLEqn_options& operator = (const NLEqn_options& opt)
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
48 {
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
49 if (this != &opt)
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
50 x_tolerance = opt.x_tolerance;
289
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 252
diff changeset
51
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
52 return *this;
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
53 }
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
54
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
55 ~NLEqn_options (void) { }
289
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 252
diff changeset
56
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
57 void set_default_options (void) { x_tolerance = ::sqrt (DBL_EPSILON); }
289
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 252
diff changeset
58
1872
d5ba1bd06584 [project @ 1996-02-04 12:52:14 by jwe]
jwe
parents: 1865
diff changeset
59 void set_options (const NLEqn_options& opt)
d5ba1bd06584 [project @ 1996-02-04 12:52:14 by jwe]
jwe
parents: 1865
diff changeset
60 { x_tolerance = opt.x_tolerance; }
d5ba1bd06584 [project @ 1996-02-04 12:52:14 by jwe]
jwe
parents: 1865
diff changeset
61
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
62 void set_tolerance (double val)
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
63 { x_tolerance = (val > 0.0) ? val : ::sqrt (DBL_EPSILON); }
289
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 252
diff changeset
64
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
65 double tolerance (void) { return x_tolerance; }
289
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 252
diff changeset
66
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
67 private:
289
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 252
diff changeset
68
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 252
diff changeset
69 double x_tolerance;
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 252
diff changeset
70 };
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 252
diff changeset
71
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
72 class
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
73 NLEqn : public NLFunc, public NLEqn_options
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
74 {
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
75 public:
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
76
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
77 NLEqn (void)
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
78 : NLFunc (), NLEqn_options (), x () { }
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
79
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
80 NLEqn (const ColumnVector& xx, const NLFunc f)
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
81 : NLFunc (f), NLEqn_options (), x (xx) { }
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
82
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
83 NLEqn (const NLEqn& a)
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
84 : NLFunc (a.fun, a.jac), NLEqn_options (), x (a.x) { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
85
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
86 NLEqn& operator = (const NLEqn& a)
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
87 {
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
88 if (this != &a)
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
89 {
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
90 NLFunc::operator = (a);
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
91 NLEqn_options::operator = (a);
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
92
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
93 x = a.x;
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
94 }
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
95 return *this;
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
96 }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
97
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
98 ~NLEqn (void) { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
99
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
100 void set_states (const ColumnVector& xx) { x = xx; }
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
101
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
102 ColumnVector states (void) const { return x; }
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
103
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
104 int size (void) const { return x.capacity (); }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
105
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
106 ColumnVector solve (void)
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
107 {
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
108 int info;
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
109 return solve (info);
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
110 }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
111
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
112 ColumnVector solve (const ColumnVector& xvec)
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
113 {
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
114 set_states (xvec);
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
115 int info;
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
116 return solve (info);
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
117 }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
118
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
119 ColumnVector solve (const ColumnVector& xvec, int& info)
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
120 {
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
121 set_states (xvec);
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
122 return solve (info);
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
123 }
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
124
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
125 ColumnVector solve (int& info);
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
126
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
127 private:
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
128
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
129 ColumnVector x;
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
130
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
131 void error (const char* msg);
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
132 };
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
133
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
134 #endif
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
135
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
136 /*
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
137 ;;; Local Variables: ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
138 ;;; mode: C++ ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
139 ;;; End: ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
140 */