annotate liboctave/NLEqn.h @ 5536:f16c05db6250 ss-2-9-4

[project @ 2005-11-11 19:53:51 by jwe]
author jwe
date Fri, 11 Nov 2005 19:53:52 +0000
parents 4c8a2e4e0717
children 143b556ce725
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: 5275
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: 5275
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: 296
diff changeset
24 #if !defined (octave_NLEqn_h)
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe]
jwe
parents: 296
diff changeset
25 #define octave_NLEqn_h 1
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe]
jwe
parents: 296
diff changeset
26
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
27 #include <cfloat>
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
28 #include <cmath>
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
29
3998
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents: 3971
diff changeset
30 #include "NLEqn-opts.h"
289
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 252
diff changeset
31
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
32 class
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
33 NLEqn : public NLFunc, public NLEqn_options
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
34 {
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
35 public:
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
36
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
37 NLEqn (void)
3971
41e7fa40ff4c [project @ 2002-07-02 23:46:48 by jwe]
jwe
parents: 2847
diff changeset
38 : NLFunc (), NLEqn_options (), x (), solution_status (0) { }
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
39
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
40 NLEqn (const ColumnVector& xx, const NLFunc f)
3971
41e7fa40ff4c [project @ 2002-07-02 23:46:48 by jwe]
jwe
parents: 2847
diff changeset
41 : NLFunc (f), NLEqn_options (), x (xx), solution_status (0) { }
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
42
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
43 NLEqn (const NLEqn& a)
3971
41e7fa40ff4c [project @ 2002-07-02 23:46:48 by jwe]
jwe
parents: 2847
diff changeset
44 : NLFunc (a.fun, a.jac), NLEqn_options (), x (a.x),
41e7fa40ff4c [project @ 2002-07-02 23:46:48 by jwe]
jwe
parents: 2847
diff changeset
45 solution_status (a.solution_status) { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
46
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
47 NLEqn& operator = (const NLEqn& a)
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
48 {
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
49 if (this != &a)
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
50 {
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
51 NLFunc::operator = (a);
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
52 NLEqn_options::operator = (a);
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
53
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
54 x = a.x;
3971
41e7fa40ff4c [project @ 2002-07-02 23:46:48 by jwe]
jwe
parents: 2847
diff changeset
55 solution_status = a.solution_status;
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
56 }
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
57 return *this;
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
58 }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
59
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
60 ~NLEqn (void) { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
61
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
62 void set_states (const ColumnVector& xx) { x = xx; }
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
63
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
64 ColumnVector states (void) const { return x; }
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
65
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 5105
diff changeset
66 octave_idx_type size (void) const { return x.capacity (); }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
67
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
68 ColumnVector solve (void)
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
69 {
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 5105
diff changeset
70 octave_idx_type info;
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
71 return solve (info);
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
72 }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
73
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
74 ColumnVector solve (const ColumnVector& xvec)
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
75 {
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
76 set_states (xvec);
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 5105
diff changeset
77 octave_idx_type info;
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
78 return solve (info);
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
79 }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
80
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 5105
diff changeset
81 ColumnVector solve (const ColumnVector& xvec, octave_idx_type& info)
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
82 {
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
83 set_states (xvec);
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
84 return solve (info);
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
85 }
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
86
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 5105
diff changeset
87 ColumnVector solve (octave_idx_type& info);
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
88
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 5105
diff changeset
89 octave_idx_type solution_state (void) const { return solution_status; }
3971
41e7fa40ff4c [project @ 2002-07-02 23:46:48 by jwe]
jwe
parents: 2847
diff changeset
90
41e7fa40ff4c [project @ 2002-07-02 23:46:48 by jwe]
jwe
parents: 2847
diff changeset
91 bool solution_ok (void) const { return solution_status == 1; }
41e7fa40ff4c [project @ 2002-07-02 23:46:48 by jwe]
jwe
parents: 2847
diff changeset
92
41e7fa40ff4c [project @ 2002-07-02 23:46:48 by jwe]
jwe
parents: 2847
diff changeset
93 std::string error_message (void) const;
41e7fa40ff4c [project @ 2002-07-02 23:46:48 by jwe]
jwe
parents: 2847
diff changeset
94
41e7fa40ff4c [project @ 2002-07-02 23:46:48 by jwe]
jwe
parents: 2847
diff changeset
95 private:
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
96
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
97 ColumnVector x;
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 5105
diff changeset
98 octave_idx_type solution_status;
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
99
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
100 void error (const char* msg);
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
101 };
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
102
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
103 #endif
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
104
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
105 /*
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
106 ;;; Local Variables: ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
107 ;;; mode: C++ ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
108 ;;; End: ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
109 */