Implements the mean ratio quality metric. More...
#include <SimplexMeanRatio.h>
Public Types | |
typedef T | Number |
The number type. | |
typedef Base::Vertex | Vertex |
The class for a vertex. | |
typedef Base::Simplex | Simplex |
The simplex type. | |
typedef Base::Matrix | Matrix |
An NxN matrix. | |
Public Member Functions | |
Constructors etc. | |
SimplexMeanRatio () | |
Default constructor. Un-initialized memory. | |
SimplexMeanRatio (const SimplexMeanRatio &other) | |
Copy constructor. | |
SimplexMeanRatio (const Simplex &s) | |
Construct from a simplex. | |
SimplexMeanRatio & | operator= (const SimplexMeanRatio &other) |
Assignment operator. | |
~SimplexMeanRatio () | |
Trivial destructor. | |
Mathematical functions | |
Number | operator() () const |
Return the mean ratio (eta) quality metric. | |
Number | operator() (const Simplex &simplex) const |
Return the mean ratio (eta) quality metric. | |
void | computeGradient (Vertex *gradient) const |
Calculate the gradient of the mean ratio (eta) quality metric. | |
Protected Member Functions | |
Number | computeFunctionGivenS2 (Number s2) const |
Return the eta quality metric given . |
Implements the mean ratio quality metric.
N | is the dimension. | |
T | is the number type. By default it is double. |
This class implements the mean ratio quality metric. Let be the Jacobian matrix, be the Jacobian determinant and be the Frobenius norm. The operator()
member function returns the mean ratio quality metric:
This quality metric is only defined for simplices with positive content. (The Jacobian determinant must be positive.)
computeGradient()
calculates the gradient of the mean ratio metric.
Before evaluating the mean ratio metric, you must set the Jacobian matrix with setFunction()
or set()
. Before evaluating the gradient of the metric, you must set the Jacobian matrix and its gradient with set()
.
void SimplexMeanRatio< N, T >::computeGradient | ( | Vertex * | gradient | ) | const |
Calculate the gradient of the mean ratio (eta) quality metric.
Let be the Jacobian matrix, be the Jacobian determinant and be the Frobenius norm. The eta function is
Reimplemented in SimplexModMeanRatio< N, T >.
Number SimplexMeanRatio< N, T >::operator() | ( | const Simplex & | simplex | ) | const [inline] |
Return the mean ratio (eta) quality metric.
Reimplemented in SimplexModMeanRatio< N, T >.
References SimplexMeanRatio< N, T >::operator()(), and SimplexJacQF< N, T >::setFunction().
Number SimplexMeanRatio< N, T >::operator() | ( | ) | const |
Return the mean ratio (eta) quality metric.
Reimplemented in SimplexModMeanRatio< N, T >.
Referenced by SimplexMeanRatio< N, T >::operator()().