annotate liboctave/NLP.h @ 5356:06585668a971 ss-2-9-3

[project @ 2005-05-18 17:20:31 by jwe]
author jwe
date Wed, 18 May 2005 17:20:32 +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: 296
diff changeset
24 #if !defined (octave_NLP_h)
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe]
jwe
parents: 296
diff changeset
25 #define octave_NLP_h 1
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe]
jwe
parents: 296
diff changeset
26
465
4caf8fbeb778 [project @ 1994-06-06 01:05:09 by jwe]
jwe
parents: 384
diff changeset
27 #include "dColVector.h"
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
28 #include "Objective.h"
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
29 #include "Bounds.h"
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
30 #include "LinConst.h"
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
31 #include "NLConst.h"
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
32 #include "base-min.h"
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
33
1863
986e565efd0a [project @ 1996-02-04 10:40:02 by jwe]
jwe
parents: 1835
diff changeset
34 class
986e565efd0a [project @ 1996-02-04 10:40:02 by jwe]
jwe
parents: 1835
diff changeset
35 NLP : public base_minimizer
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
36 {
1863
986e565efd0a [project @ 1996-02-04 10:40:02 by jwe]
jwe
parents: 1835
diff changeset
37 public:
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
38
1863
986e565efd0a [project @ 1996-02-04 10:40:02 by jwe]
jwe
parents: 1835
diff changeset
39 NLP (void)
986e565efd0a [project @ 1996-02-04 10:40:02 by jwe]
jwe
parents: 1835
diff changeset
40 : base_minimizer (), phi (), bnds (), lc (), nlc () { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
41
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
42 NLP (const ColumnVector& x, const Objective& obj)
1863
986e565efd0a [project @ 1996-02-04 10:40:02 by jwe]
jwe
parents: 1835
diff changeset
43 : base_minimizer (x), phi (obj), bnds (), lc (), nlc () { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
44
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
45 NLP (const ColumnVector& x, const Objective& obj, const Bounds& b)
1863
986e565efd0a [project @ 1996-02-04 10:40:02 by jwe]
jwe
parents: 1835
diff changeset
46 : base_minimizer (x), phi (obj), bnds (b), lc (), nlc () { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
47
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
48 NLP (const ColumnVector& x, const Objective& obj, const Bounds& b,
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
49 const LinConst& l)
1863
986e565efd0a [project @ 1996-02-04 10:40:02 by jwe]
jwe
parents: 1835
diff changeset
50 : base_minimizer (x), phi (obj), bnds (b), lc (l), nlc () { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
51
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
52 NLP (const ColumnVector& x, const Objective& obj, const Bounds& b,
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
53 const LinConst& l, const NLConst& nl)
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
54 : base_minimizer (x), phi (obj), bnds (b), lc (l), nlc (nl) { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
55
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
56 NLP (const ColumnVector& x, const Objective& obj, const LinConst& l)
1863
986e565efd0a [project @ 1996-02-04 10:40:02 by jwe]
jwe
parents: 1835
diff changeset
57 : base_minimizer (x), phi (obj), bnds (), lc (l), nlc () { }
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
58
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
59 NLP (const ColumnVector& x, const Objective& obj, const LinConst& l,
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
60 const NLConst& nl)
1863
986e565efd0a [project @ 1996-02-04 10:40:02 by jwe]
jwe
parents: 1835
diff changeset
61 : base_minimizer (x), phi (obj), bnds (), lc (l), nlc (nl) { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
62
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
63 NLP (const ColumnVector& x, const Objective& obj, const NLConst& nl)
1863
986e565efd0a [project @ 1996-02-04 10:40:02 by jwe]
jwe
parents: 1835
diff changeset
64 : base_minimizer (x), phi (obj), bnds (), lc (), nlc (nl) { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
65
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
66 NLP (const ColumnVector& x, const Objective& obj, const Bounds& b,
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
67 const NLConst& nl)
1863
986e565efd0a [project @ 1996-02-04 10:40:02 by jwe]
jwe
parents: 1835
diff changeset
68 : base_minimizer (x), phi (obj), bnds (b), lc (), nlc (nl) { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
69
1835
12a94a17509d [project @ 1996-02-03 07:16:15 by jwe]
jwe
parents: 1528
diff changeset
70 NLP (const NLP& a)
12a94a17509d [project @ 1996-02-03 07:16:15 by jwe]
jwe
parents: 1528
diff changeset
71 : base_minimizer (a), phi (a.phi), bnds (a.bnds), lc (a.lc), nlc (a.nlc)
12a94a17509d [project @ 1996-02-03 07:16:15 by jwe]
jwe
parents: 1528
diff changeset
72 { }
12a94a17509d [project @ 1996-02-03 07:16:15 by jwe]
jwe
parents: 1528
diff changeset
73
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
74 NLP& operator = (const NLP& a)
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
75 {
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
76 if (this != &a)
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
77 {
1835
12a94a17509d [project @ 1996-02-03 07:16:15 by jwe]
jwe
parents: 1528
diff changeset
78 base_minimizer::operator = (a);
12a94a17509d [project @ 1996-02-03 07:16:15 by jwe]
jwe
parents: 1528
diff changeset
79
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
80 phi = a.phi;
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
81 bnds = a.bnds;
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
82 lc = a.lc;
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
83 nlc = a.nlc;
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
84 }
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
85 return *this;
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
86 }
287
6027a905fc06 [project @ 1994-01-13 01:41:00 by jwe]
jwe
parents: 238
diff changeset
87
1528
dc527156c38c [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents: 1315
diff changeset
88 virtual ~NLP (void) { }
287
6027a905fc06 [project @ 1994-01-13 01:41:00 by jwe]
jwe
parents: 238
diff changeset
89
1863
986e565efd0a [project @ 1996-02-04 10:40:02 by jwe]
jwe
parents: 1835
diff changeset
90 Objective objective (void) const { return phi; }
986e565efd0a [project @ 1996-02-04 10:40:02 by jwe]
jwe
parents: 1835
diff changeset
91
986e565efd0a [project @ 1996-02-04 10:40:02 by jwe]
jwe
parents: 1835
diff changeset
92 Bounds bounds (void) const { return bnds; }
986e565efd0a [project @ 1996-02-04 10:40:02 by jwe]
jwe
parents: 1835
diff changeset
93
986e565efd0a [project @ 1996-02-04 10:40:02 by jwe]
jwe
parents: 1835
diff changeset
94 LinConst linear_constraints (void) const { return lc; }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
95
1863
986e565efd0a [project @ 1996-02-04 10:40:02 by jwe]
jwe
parents: 1835
diff changeset
96 NLConst nonlinear_constraints (void) const { return nlc; }
986e565efd0a [project @ 1996-02-04 10:40:02 by jwe]
jwe
parents: 1835
diff changeset
97
986e565efd0a [project @ 1996-02-04 10:40:02 by jwe]
jwe
parents: 1835
diff changeset
98 protected:
986e565efd0a [project @ 1996-02-04 10:40:02 by jwe]
jwe
parents: 1835
diff changeset
99
986e565efd0a [project @ 1996-02-04 10:40:02 by jwe]
jwe
parents: 1835
diff changeset
100 Objective phi;
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
101 Bounds bnds;
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
102 LinConst lc;
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
103 NLConst nlc;
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 #endif
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
107
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
108 /*
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
109 ;;; Local Variables: ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
110 ;;; mode: C++ ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
111 ;;; End: ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
112 */