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 | /* *****************************************************************
MESQUITE -- The Mesh Quality Improvement Toolkit
Copyright 2006 Sandia National Laboratories. Developed at the
University of Wisconsin--Madison under SNL contract number
624796. The U.S. Government and the University of Wisconsin
retain certain rights to 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 VarianceTemplate.hpp
* \brief
* \author Jason Kraftcheck
*/
#ifndef MSQ_VARIANCE_TEMPLATE_HPP
#define MSQ_VARIANCE_TEMPLATE_HPP
#include "Mesquite.hpp"
#include "MsqHessian.hpp"
#include "ObjectiveFunctionTemplate.hpp"
namespace MBMesquite
{
/**\brief (variance)^2 template
*
* This class implements an objective function that is the
* variance of the quality metric evalutations.
*/
class VarianceTemplate : public ObjectiveFunctionTemplate
{
public:
MESQUITE_EXPORT
VarianceTemplate( QualityMetric* qm = 0 ) : ObjectiveFunctionTemplate( qm )
{
clear();
}
/**\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
VarianceTemplate( const VarianceTemplate& copy )
: ObjectiveFunctionTemplate( copy ), mCount( copy.mCount ), mSum( copy.mSum ), mSqrSum( copy.mSqrSum ),
saveCount( copy.saveCount ), saveSum( copy.saveSum ), saveSqrSum( copy.saveSqrSum )
{
}
MESQUITE_EXPORT
virtual ~VarianceTemplate() {}
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 ObjectiveFunction* clone() const;<--- Function in derived class<--- Function in derived class
MESQUITE_EXPORT
virtual void clear();<--- Function in derived class<--- Function in derived class
private:
/**\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 sum The sum over the current patch
*\param sqr_sum The sum of squares 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
*\param result_sum The sum term of the variance
*\param result_sqr The sum of squares term of the variance
*/
void accumulate( double sum,
double sqr_sum,
size_t count,
EvalType type,
double& result_sum,
double& result_sqr,
size_t& global_count );
size_t mCount; /**< The number of accumulated entires */
double mSum; /**< The runnnig sum of the qualtiy metric valuse */
double mSqrSum; /**< The running sum of the square of QM values */
size_t saveCount; /**< Saved count from previous patch */
double saveSum; /**< Saved sum from previous patch */
double saveSqrSum; /**< Saved sum from previous patch */
/** 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, gradSum;
/** Temporary storage for qm Hessian diagonal data */
mutable std::vector< SymMatrix3D > mHessDiag, hessSum;
};
} // namespace MBMesquite
#endif
|