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
169 | /* *****************************************************************
MESQUITE -- The Mesh Quality Improvement Toolkit
Copyright 2006 Lawrence Livermore National Laboratory. Under
the terms of Contract B545069 with the University of Wisconsin --
Madison, Lawrence Livermore National Laboratory 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
(2006) [email protected]
***************************************************************** */
/** \file PMeanPTemplate.hpp
* \brief previous name: PowerMeanP.hpp
* \author Jason Kraftcheck
*/
#ifndef MSQ_P_MEAN_P_TEMPLATE_HPP
#define MSQ_P_MEAN_P_TEMPLATE_HPP
#include "Mesquite.hpp"
#include "ObjectiveFunctionTemplate.hpp"
#include "Exponent.hpp"
#include "Matrix3D.hpp"
namespace MBMesquite
{
/**\brief \f$\frac{1}{n}\sum_{i=1}^n\mu(s_i)^p\f$
*
* This class implements an objective function that is the
* power-mean of the quality metric evalutations raised to the
* power-mean power. That is, the sum of each quality metric value
* raised to a power, divided by the totoal number of quality metric
* values.
*/
class PMeanPTemplate : public ObjectiveFunctionTemplate
{
public:
/**
*\param power The exponent to use for the power-mean
*\param qm The quality metric.
*/
MESQUITE_EXPORT
PMeanPTemplate( double power, QualityMetric* qm = 0 ) : ObjectiveFunctionTemplate( qm )<--- Class 'PMeanPTemplate' has a constructor with 1 argument that is not explicit. [+]Class 'PMeanPTemplate' 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. <--- Class 'PMeanPTemplate' has a constructor with 1 argument that is not explicit. [+]Class 'PMeanPTemplate' 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.
{
clear();
set_power( power );
}
/**\brief copy constructor
*
* Define a copy constructor because the compiler-provided
* default one would also copy the temporary arrays, which
* would be a waste of time.
*/
MESQUITE_EXPORT
PMeanPTemplate( const PMeanPTemplate& copy )
: ObjectiveFunctionTemplate( copy ), mPower( copy.mPower ), mPowerMinus1( copy.mPowerMinus1 ),
mPowerMinus2( copy.mPowerMinus2 ), mCount( copy.mCount ), mPowSum( copy.mPowSum ),
saveCount( copy.saveCount ), savePowSum( copy.savePowSum )
{
}
MESQUITE_EXPORT
virtual ~PMeanPTemplate() {}
MESQUITE_EXPORT
double get_power() const
{
return mPower.value();
}
MESQUITE_EXPORT
void set_power( double p )
{
mPower = p;
mPowerMinus1 = p - 1;
mPowerMinus2 = p - 2;
}
MESQUITE_EXPORT
virtual bool evaluate( EvalType type, PatchData& pd, double& value_out, bool free, MsqError& err );<--- Function in derived class<--- Function in derived class
MESQUITE_EXPORT
virtual bool evaluate_with_gradient( EvalType type,<--- Function in derived class<--- Function in derived class
PatchData& pd,
double& value_out,
std::vector< Vector3D >& grad_out,
MsqError& err );
MESQUITE_EXPORT
virtual bool evaluate_with_Hessian_diagonal( EvalType type,<--- Function in derived class<--- Function in derived class
PatchData& pd,
double& value_out,
std::vector< Vector3D >& grad_out,
std::vector< SymMatrix3D >& hess_diag_out,
MsqError& err );
MESQUITE_EXPORT
virtual bool evaluate_with_Hessian( EvalType type,<--- Function in derived class<--- Function in derived class
PatchData& pd,
double& value_out,
std::vector< Vector3D >& grad_out,
MsqHessian& Hessian_out,
MsqError& err );
MESQUITE_EXPORT
virtual ObjectiveFunction* clone() const;<--- Function in derived class<--- Function in derived class
MESQUITE_EXPORT
virtual void clear();<--- Function in derived class<--- Function in derived class
protected:
/**\brief Handle EvalType for all eval functions, return OF value
*
* This function implements the common handling of the EvalType
* argument for all forms of the 'evaluate' method.
*
* NOTE: This function modifies accumulated values depenending
* on the value of EvalType.
*\param power_sum The sum over the current patch
*\param count The number of qm evaluations for the current patch
*\param type The evaluation type passed to 'evaluate'
*\param global_count The total, accumulated number of QM evaluations
*\return The objective function value to return from 'evaluate'
*/
double get_value( double power_sum, size_t count, EvalType type, size_t& global_count );
Exponent mPower; /**< The power to use */
Exponent mPowerMinus1; /**< mPower - 1.0 */
Exponent mPowerMinus2; /**< mPower - 2.0 */
private:
size_t mCount; /**< The number of accumulated entires */
double mPowSum; /**< The accumulated sum of values to the mPower */
size_t saveCount; /**< Saved count from previous patch */
double savePowSum; /**< Saved sum from previous patch */
protected:
/** Temporary storage for qm sample handles */
mutable std::vector< size_t > qmHandles;
/** Temporary storage for qm vertex indices */
mutable std::vector< size_t > mIndices;
/** Temporary storage for qm gradient */
mutable std::vector< Vector3D > mGradient;
/** Temporary storage for qm hessian diagonal */
mutable std::vector< SymMatrix3D > mDiag;
/** Temporary storage for qm Hessian */
mutable std::vector< Matrix3D > mHessian;
};
} // namespace MBMesquite
#endif
|