annotate liboctave/Objective.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: 238
diff changeset
24 #if !defined (octave_Objective_h)
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe]
jwe
parents: 238
diff changeset
25 #define octave_Objective_h 1
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe]
jwe
parents: 238
diff changeset
26
1296
f93b7fa5e113 [project @ 1995-05-01 18:30:08 by jwe]
jwe
parents: 1206
diff changeset
27 #include "dColVector.h"
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
28
1861
620a65533630 [project @ 1996-02-04 10:17:34 by jwe]
jwe
parents: 1536
diff changeset
29 class
620a65533630 [project @ 1996-02-04 10:17:34 by jwe]
jwe
parents: 1536
diff changeset
30 Objective
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
31 {
1861
620a65533630 [project @ 1996-02-04 10:17:34 by jwe]
jwe
parents: 1536
diff changeset
32 public:
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
33
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
34 typedef double (*objective_fcn) (const ColumnVector&);
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
35 typedef ColumnVector (*gradient_fcn) (const ColumnVector&);
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
36
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
37 Objective (void)
1861
620a65533630 [project @ 1996-02-04 10:17:34 by jwe]
jwe
parents: 1536
diff changeset
38 : phi (0), grad (0) { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
39
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
40 Objective (const objective_fcn obj)
1861
620a65533630 [project @ 1996-02-04 10:17:34 by jwe]
jwe
parents: 1536
diff changeset
41 : phi (obj), grad (0) { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
42
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
43 Objective (const objective_fcn obj, const gradient_fcn g)
1861
620a65533630 [project @ 1996-02-04 10:17:34 by jwe]
jwe
parents: 1536
diff changeset
44 : phi (obj), grad (g) { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
45
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
46 Objective (const Objective& a)
1861
620a65533630 [project @ 1996-02-04 10:17:34 by jwe]
jwe
parents: 1536
diff changeset
47 : phi (a.phi), grad (a.grad) { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
48
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
49 Objective& operator = (const Objective& a)
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
50 {
1861
620a65533630 [project @ 1996-02-04 10:17:34 by jwe]
jwe
parents: 1536
diff changeset
51 if (this != &a)
620a65533630 [project @ 1996-02-04 10:17:34 by jwe]
jwe
parents: 1536
diff changeset
52 {
620a65533630 [project @ 1996-02-04 10:17:34 by jwe]
jwe
parents: 1536
diff changeset
53 phi = a.phi;
620a65533630 [project @ 1996-02-04 10:17:34 by jwe]
jwe
parents: 1536
diff changeset
54 grad = a.grad;
620a65533630 [project @ 1996-02-04 10:17:34 by jwe]
jwe
parents: 1536
diff changeset
55 }
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
56 return *this;
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
57 }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
58
1861
620a65533630 [project @ 1996-02-04 10:17:34 by jwe]
jwe
parents: 1536
diff changeset
59 ~Objective (void) { }
620a65533630 [project @ 1996-02-04 10:17:34 by jwe]
jwe
parents: 1536
diff changeset
60
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
61 objective_fcn objective_function (void) const { return phi; }
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
62
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
63 Objective& set_objective_function (const objective_fcn obj)
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
64 {
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
65 phi = obj;
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
66 return *this;
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
67 }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
68
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
69 gradient_fcn gradient_function (void) const { return grad; }
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
70
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
71 Objective& set_gradient_function (const gradient_fcn g)
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
72 {
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
73 grad = g;
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
74 return *this;
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
75 }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
76
1861
620a65533630 [project @ 1996-02-04 10:17:34 by jwe]
jwe
parents: 1536
diff changeset
77 private:
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
78
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
79 objective_fcn phi;
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
80 gradient_fcn grad;
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
81
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
82 };
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
83
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
84 #endif
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
85
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
86 /*
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
87 ;;; Local Variables: ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
88 ;;; mode: C++ ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
89 ;;; End: ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
90 */