1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168 | /* *****************************************************************
MESQUITE -- The Mesh Quality Improvement Toolkit
Copyright 2004 Sandia Corporation and Argonne National
Laboratory. Under the terms of Contract DE-AC04-94AL85000
with Sandia Corporation, the U.S. Government retains certain
rights in this software.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
(lgpl.txt) along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
[email protected], [email protected], [email protected],
[email protected], [email protected], [email protected]
***************************************************************** */
/*!
\file NonGradient.hpp
\brief
The NonGradient class is also a concrete vertex mover
which performs derivative free minimization
based on the Amoeba Method, as implemented in Numerical Recipes in C.
*/
#ifndef Mesquite_NonGradient_hpp
#define Mesquite_NonGradient_hpp
#include "Mesquite.hpp"
#include "VertexMover.hpp"
#include "PatchSetUser.hpp"
namespace MBMesquite
{
class ObjectiveFunction;
/*! \class NonGradient
This is an implementation of a derivative-free optimization algorithm
Commonly referred to as the 'amoeba'. This implementation only works
on patches containing one free vertex. */
class NonGradient : public VertexMover, public PatchSetUser
{
public:
MESQUITE_EXPORT
NonGradient( ObjectiveFunction* of );<--- Class 'NonGradient' has a constructor with 1 argument that is not explicit. [+]Class 'NonGradient' has a constructor with 1 argument that is not explicit. Such constructors should in general be explicit for type safety reasons. Using the explicit keyword in the constructor means some mistakes when using the class can be avoided.
MESQUITE_EXPORT
NonGradient( ObjectiveFunction* of, MsqError& err );
MESQUITE_EXPORT virtual ~NonGradient() {}
MESQUITE_EXPORT virtual std::string get_name() const;
MESQUITE_EXPORT virtual PatchSet* get_patch_set();
MESQUITE_EXPORT
bool project_gradient() const
{
return projectGradient;
}
MESQUITE_EXPORT
void project_gradient( bool yesno )
{
projectGradient = yesno;
}
int getDimension()
{
return ( mDimension );
}
double getThreshold()
{
return ( mThreshold );
}
// double getTolerance()
// {
// return(mTolerance);
// }
int getMaxNumEval()
{
return ( mMaxNumEval );
}
double getSimplexDiameterScale()
{
return ( mScaleDiameter );
}
void setDimension( int dimension )
{
mDimension = dimension;
}
void setThreshold( double threshold )
{
mThreshold = threshold;
}
// void setTolerance(double ftol)
// {
// mTolerance = ftol;
// }
void setMaxNumEval( int maxNumEval )
{
mMaxNumEval = maxNumEval;
}
void setExactPenaltyFunction( bool exactPenalty )
{
mUseExactPenaltyFunction = exactPenalty;
}
void setSimplexDiameterScale( double newScaleDiameter )
{
mScaleDiameter = newScaleDiameter;
}
void getRowSum( int numRow, int numCol, std::vector< double >& matrix, std::vector< double >& rowSum );
bool testRowSum( int numRow, int numCol, double* matrix, double* rowSum );
double evaluate( double localArray[], PatchData& pd, MsqError& err );
//! edgeLenght is a length scale for the initial polytope.
int initSimplex( double edgeLength );
//! matrix stored by column as a std::vector
std::vector< double > simplex;
std::vector< double > height;
//! Generic patch helper function only used by NonGradient
void printPatch( const PatchData& pd, MsqError& err );
//! Generic patch helper function only used by NonGradient
int getPatchDimension( const PatchData& pd, MsqError& err );
//! Obtain diagnostic data during optimization
//! off=level 0, ... level 3 = maximal
MESQUITE_EXPORT void set_debugging_level( int level )
{
mNonGradDebug = level;
}
protected:
MESQUITE_EXPORT virtual void initialize( PatchData& pd, MsqError& err );
MESQUITE_EXPORT virtual void optimize_vertex_positions( PatchData& pd, MsqError& err );
MESQUITE_EXPORT virtual void initialize_mesh_iteration( PatchData& pd, MsqError& err );
MESQUITE_EXPORT virtual void terminate_mesh_iteration( PatchData& pd, MsqError& err );
MESQUITE_EXPORT virtual void cleanup();
private:
bool projectGradient;
int mDimension;
double mThreshold; // stop if 2(heightMax-heightMin)
double mTolerance; // ---------------------------------- < mTolerance
int mMaxNumEval; // |heightMax|+|heightMin|+mThreshold
// or numEval >= mMaxNumEval
double amotry( std::vector< double >&, std::vector< double >&, double*, int, double, PatchData&, MsqError& err );
int mNonGradDebug;
bool mUseExactPenaltyFunction;
double mScaleDiameter;
void printSimplex( std::vector< double >&, std::vector< double >& );
NonGradient( const NonGradient& pd ); // disable copying
NonGradient& operator=( const NonGradient& pd ); // disable assignment
};
} // namespace MBMesquite
#endif
|