annotate liboctave/base-min.h @ 1840:cf5b42781ecc

[project @ 1996-02-03 09:48:15 by jwe]
author jwe
date Sat, 03 Feb 1996 09:49:01 +0000
parents 33dc934c0e38
children 1b43d3c06c04
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1527
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
1 // base-min.h -*- C++ -*-
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
2 /*
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
3
1835
12a94a17509d [project @ 1996-02-03 07:16:15 by jwe]
jwe
parents: 1536
diff changeset
4 Copyright (C) 1996 John W. Eaton
1527
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
5
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
6 This file is part of Octave.
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
7
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
8 Octave is free software; you can redistribute it and/or modify it
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
9 under the terms of the GNU General Public License as published by the
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
10 Free Software Foundation; either version 2, or (at your option) any
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
11 later version.
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
12
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
13 Octave is distributed in the hope that it will be useful, but WITHOUT
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
16 for more details.
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
17
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
18 You should have received a copy of the GNU General Public License
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
19 along with Octave; see the file COPYING. If not, write to the Free
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
20 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
21
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
22 */
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
23
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
24 #if !defined (octave_base_min_h)
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
25 #define octave_base_min_h 1
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
26
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
27 #include "dColVector.h"
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
28
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
29 class base_minimizer
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
30 {
1837
33dc934c0e38 [project @ 1996-02-03 07:51:07 by jwe]
jwe
parents: 1835
diff changeset
31 public:
1527
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
32
1837
33dc934c0e38 [project @ 1996-02-03 07:51:07 by jwe]
jwe
parents: 1835
diff changeset
33 base_minimizer (void)
33dc934c0e38 [project @ 1996-02-03 07:51:07 by jwe]
jwe
parents: 1835
diff changeset
34 : x () { }
1527
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
35
1837
33dc934c0e38 [project @ 1996-02-03 07:51:07 by jwe]
jwe
parents: 1835
diff changeset
36 base_minimizer (const ColumnVector& xx)
33dc934c0e38 [project @ 1996-02-03 07:51:07 by jwe]
jwe
parents: 1835
diff changeset
37 : x (xx) { }
1527
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
38
1837
33dc934c0e38 [project @ 1996-02-03 07:51:07 by jwe]
jwe
parents: 1835
diff changeset
39 base_minimizer (const base_minimizer& a)
1840
cf5b42781ecc [project @ 1996-02-03 09:48:15 by jwe]
jwe
parents: 1837
diff changeset
40 : x (a.x) { }
1527
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
41
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
42 virtual ~base_minimizer (void) { }
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
43
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
44 base_minimizer& operator = (const base_minimizer& a)
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
45 {
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
46 x = a.x;
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
47 return *this;
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
48 }
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
49
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
50 // Derived classes must provide a function to actually do the
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
51 // minimization.
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
52
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
53 virtual ColumnVector do_minimize (double& objf, int& inform,
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
54 ColumnVector& lambda) = 0;
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
55
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
56 // Lots of ways to call the single function and optionally set and
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
57 // get additional information.
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
58
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
59 virtual ColumnVector minimize (void)
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
60 {
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
61 double objf;
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
62 int inform;
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1527
diff changeset
63 ColumnVector lambda;
1527
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
64 return do_minimize (objf, inform, lambda);
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
65 }
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
66
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
67 virtual ColumnVector minimize (double& objf)
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
68 {
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
69 int inform;
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1527
diff changeset
70 ColumnVector lambda;
1527
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
71 return do_minimize (objf, inform, lambda);
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
72 }
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
73
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
74 virtual ColumnVector minimize (double& objf, int& inform)
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
75 {
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1527
diff changeset
76 ColumnVector lambda;
1527
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
77 return do_minimize (objf, inform, lambda);
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
78 }
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
79
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
80 virtual ColumnVector minimize (double& objf, int& inform,
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
81 ColumnVector& lambda)
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
82 {
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
83 return do_minimize (objf, inform, lambda);
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
84 }
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
85
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
86 virtual ColumnVector minimize (const ColumnVector& x0)
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
87 {
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
88 x = x0;
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
89 double objf;
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
90 int inform;
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1527
diff changeset
91 ColumnVector lambda;
1527
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
92 return do_minimize (objf, inform, lambda);
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
93 }
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
94
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
95 virtual ColumnVector minimize (const ColumnVector& x0, double& objf)
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
96 {
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
97 x = x0;
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
98 int inform;
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1527
diff changeset
99 ColumnVector lambda;
1527
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
100 return do_minimize (objf, inform, lambda);
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
101 }
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
102
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
103 virtual ColumnVector minimize (const ColumnVector& x0, double& objf,
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
104 int& inform)
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
105 {
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
106 x = x0;
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1527
diff changeset
107 ColumnVector lambda;
1527
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
108 return do_minimize (objf, inform, lambda);
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
109 }
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
110
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
111 virtual ColumnVector minimize (const ColumnVector& x0, double& objf,
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
112 int& inform, ColumnVector& lambda)
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
113 {
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
114 x = x0;
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
115 return do_minimize (objf, inform, lambda);
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
116 }
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
117
1835
12a94a17509d [project @ 1996-02-03 07:16:15 by jwe]
jwe
parents: 1536
diff changeset
118 int size (void) const { return x.capacity (); }
12a94a17509d [project @ 1996-02-03 07:16:15 by jwe]
jwe
parents: 1536
diff changeset
119
1527
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
120 protected:
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
121
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
122 ColumnVector x;
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
123 };
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
124
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
125 #endif
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
126
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
127 /*
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
128 ;;; Local Variables: ***
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
129 ;;; mode: C++ ***
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
130 ;;; page-delimiter: "^/\\*" ***
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
131 ;;; End: ***
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
132 */