annotate liboctave/base-min.h @ 5103:e2ed74b9bfa0 after-gnuplot-split

[project @ 2004-12-28 02:43:01 by jwe]
author jwe
date Tue, 28 Dec 2004 02:43:01 +0000
parents 8b262e771614
children 23b37da9fd5b
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 /*
13d27938e778 [project @ 1995-10-05 01:44:18 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
1527
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
4
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
6
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
7 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
8 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
9 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
10 later version.
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
11
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
12 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
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
14 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
15 for more details.
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
16
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
17 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
18 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
19 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
20
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 #if !defined (octave_base_min_h)
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
24 #define octave_base_min_h 1
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
25
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
26 #include "dColVector.h"
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
27
1879
1b43d3c06c04 [project @ 1996-02-05 16:24:56 by jwe]
jwe
parents: 1840
diff changeset
28 class
1b43d3c06c04 [project @ 1996-02-05 16:24:56 by jwe]
jwe
parents: 1840
diff changeset
29 base_minimizer
1527
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
1879
1b43d3c06c04 [project @ 1996-02-05 16:24:56 by jwe]
jwe
parents: 1840
diff changeset
33 base_minimizer (void) : x () { }
1527
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
34
1879
1b43d3c06c04 [project @ 1996-02-05 16:24:56 by jwe]
jwe
parents: 1840
diff changeset
35 base_minimizer (const ColumnVector& xx) : x (xx) { }
1527
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
36
1879
1b43d3c06c04 [project @ 1996-02-05 16:24:56 by jwe]
jwe
parents: 1840
diff changeset
37 base_minimizer (const base_minimizer& a) : x (a.x) { }
1527
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
38
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
39 virtual ~base_minimizer (void) { }
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
40
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
41 base_minimizer& operator = (const base_minimizer& a)
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
42 {
1879
1b43d3c06c04 [project @ 1996-02-05 16:24:56 by jwe]
jwe
parents: 1840
diff changeset
43 if (this != &a)
1b43d3c06c04 [project @ 1996-02-05 16:24:56 by jwe]
jwe
parents: 1840
diff changeset
44 x = a.x;
1b43d3c06c04 [project @ 1996-02-05 16:24:56 by jwe]
jwe
parents: 1840
diff changeset
45
1527
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
46 return *this;
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
47 }
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 // Derived classes must provide a function to actually do the
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
50 // minimization.
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
51
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
52 virtual ColumnVector do_minimize (double& objf, int& inform,
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
53 ColumnVector& lambda) = 0;
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
54
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
55 // 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
56 // get additional information.
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
57
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
58 virtual ColumnVector minimize (void)
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
59 {
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
60 double objf;
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
61 int inform;
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1527
diff changeset
62 ColumnVector lambda;
1527
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
63 return do_minimize (objf, inform, lambda);
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
64 }
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 virtual ColumnVector minimize (double& objf)
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
67 {
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
68 int inform;
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1527
diff changeset
69 ColumnVector lambda;
1527
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
70 return do_minimize (objf, inform, lambda);
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
71 }
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 virtual ColumnVector minimize (double& objf, int& inform)
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
74 {
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1527
diff changeset
75 ColumnVector lambda;
1527
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
76 return do_minimize (objf, inform, lambda);
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
77 }
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 virtual ColumnVector minimize (double& objf, int& inform,
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
80 ColumnVector& lambda)
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
81 {
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
82 return do_minimize (objf, inform, lambda);
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
83 }
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 virtual ColumnVector minimize (const ColumnVector& x0)
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
86 {
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
87 x = x0;
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
88 double objf;
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
89 int inform;
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1527
diff changeset
90 ColumnVector lambda;
1527
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
91 return do_minimize (objf, inform, lambda);
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
92 }
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 virtual ColumnVector minimize (const ColumnVector& x0, double& objf)
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
95 {
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
96 x = x0;
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
97 int inform;
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1527
diff changeset
98 ColumnVector lambda;
1527
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
99 return do_minimize (objf, inform, lambda);
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
100 }
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 virtual ColumnVector minimize (const ColumnVector& x0, double& objf,
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
103 int& inform)
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
104 {
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
105 x = x0;
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1527
diff changeset
106 ColumnVector lambda;
1527
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
107 return do_minimize (objf, inform, lambda);
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
108 }
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 virtual ColumnVector minimize (const ColumnVector& x0, double& objf,
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
111 int& inform, ColumnVector& lambda)
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
112 {
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
113 x = x0;
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
114 return do_minimize (objf, inform, lambda);
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
115 }
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
116
1835
12a94a17509d [project @ 1996-02-03 07:16:15 by jwe]
jwe
parents: 1536
diff changeset
117 int size (void) const { return x.capacity (); }
12a94a17509d [project @ 1996-02-03 07:16:15 by jwe]
jwe
parents: 1536
diff changeset
118
1527
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
119 protected:
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
120
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
121 ColumnVector x;
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
122 };
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 #endif
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
125
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 ;;; Local Variables: ***
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
128 ;;; mode: C++ ***
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
129 ;;; End: ***
13d27938e778 [project @ 1995-10-05 01:44:18 by jwe]
jwe
parents:
diff changeset
130 */