annotate liboctave/NLEqn.h @ 7156:77de8319c337 ss-2-9-17

[project @ 2007-11-10 06:16:59 by jwe]
author jwe
date Sat, 10 Nov 2007 06:17:00 +0000
parents a1dbe9d80eee
children 2eb392d058bb
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, 2002, 2004, 2005, 2006,
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
4 2007 John W. Eaton
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
5
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
6 This file is part of Octave.
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
7
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
8 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
9 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: 6108
diff changeset
10 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6108
diff changeset
11 option) any later version.
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
12
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
13 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
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
15 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
16 for more details.
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
17
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
18 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: 6108
diff changeset
19 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6108
diff changeset
20 <http://www.gnu.org/licenses/>.
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
6108
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe]
jwe
parents: 5307
diff changeset
33 OCTAVE_API
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
34 NLEqn : public NLFunc, public NLEqn_options
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 public:
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
37
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
38 NLEqn (void)
3971
41e7fa40ff4c [project @ 2002-07-02 23:46:48 by jwe]
jwe
parents: 2847
diff changeset
39 : NLFunc (), NLEqn_options (), x (), solution_status (0) { }
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
40
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
41 NLEqn (const ColumnVector& xx, const NLFunc f)
3971
41e7fa40ff4c [project @ 2002-07-02 23:46:48 by jwe]
jwe
parents: 2847
diff changeset
42 : 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
43
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
44 NLEqn (const NLEqn& a)
3971
41e7fa40ff4c [project @ 2002-07-02 23:46:48 by jwe]
jwe
parents: 2847
diff changeset
45 : 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
46 solution_status (a.solution_status) { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
47
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
48 NLEqn& operator = (const NLEqn& a)
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
49 {
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
50 if (this != &a)
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
51 {
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
52 NLFunc::operator = (a);
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
53 NLEqn_options::operator = (a);
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
54
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
55 x = a.x;
3971
41e7fa40ff4c [project @ 2002-07-02 23:46:48 by jwe]
jwe
parents: 2847
diff changeset
56 solution_status = a.solution_status;
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
57 }
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
58 return *this;
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
59 }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
60
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
61 ~NLEqn (void) { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
62
1865
0e095fed283c [project @ 1996-02-04 10:53:09 by jwe]
jwe
parents: 1531
diff changeset
63 void set_states (const ColumnVector& xx) { x = xx; }
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
64
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
65 ColumnVector states (void) const { return x; }
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
66
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 5105
diff changeset
67 octave_idx_type size (void) const { return x.capacity (); }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
68
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
69 ColumnVector solve (void)
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
70 {
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 5105
diff changeset
71 octave_idx_type info;
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
72 return solve (info);
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
73 }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
74
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
75 ColumnVector solve (const ColumnVector& xvec)
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
76 {
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
77 set_states (xvec);
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 5105
diff changeset
78 octave_idx_type info;
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
79 return solve (info);
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
80 }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
81
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 5105
diff changeset
82 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
83 {
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
84 set_states (xvec);
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
85 return solve (info);
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
86 }
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
87
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 5105
diff changeset
88 ColumnVector solve (octave_idx_type& info);
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
89
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 5105
diff changeset
90 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
91
41e7fa40ff4c [project @ 2002-07-02 23:46:48 by jwe]
jwe
parents: 2847
diff changeset
92 bool solution_ok (void) const { return solution_status == 1; }
41e7fa40ff4c [project @ 2002-07-02 23:46:48 by jwe]
jwe
parents: 2847
diff changeset
93
41e7fa40ff4c [project @ 2002-07-02 23:46:48 by jwe]
jwe
parents: 2847
diff changeset
94 std::string error_message (void) const;
41e7fa40ff4c [project @ 2002-07-02 23:46:48 by jwe]
jwe
parents: 2847
diff changeset
95
41e7fa40ff4c [project @ 2002-07-02 23:46:48 by jwe]
jwe
parents: 2847
diff changeset
96 private:
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
97
1531
db1a54941d52 [project @ 1995-10-05 05:22:01 by jwe]
jwe
parents: 1315
diff changeset
98 ColumnVector x;
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 5105
diff changeset
99 octave_idx_type solution_status;
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
100
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
101 void error (const char* msg);
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
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
104 #endif
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 /*
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
107 ;;; Local Variables: ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
108 ;;; mode: C++ ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
109 ;;; End: ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
110 */