mirror of https://github.com/CGAL/cgal
added missing includes in the docs + convenience header
This commit is contained in:
Dmitry Anisimov
parent
9ccbea002d
commit
649db1ffdb
|
|
@ -19,6 +19,8 @@ Models and functions that can be used to compute weights which have a simple ana
|
|||
\defgroup PkgWeightsRefUniformWeights Uniform Weight
|
||||
\ingroup PkgWeightsRefAnalytic
|
||||
|
||||
`#include <CGAL/Weights/uniform_weights.h>`
|
||||
|
||||
This weight is always equal to 1.
|
||||
|
||||
\tparam GeomTraits
|
||||
|
|
@ -31,6 +33,8 @@ a model of `AnalyticWeightTraits_3` for 3D points
|
|||
\defgroup PkgWeightsRefShepardWeights Shepard Weight
|
||||
\ingroup PkgWeightsRefAnalytic
|
||||
|
||||
`#include <CGAL/Weights/shepard_weights.h>`
|
||||
|
||||
This weight is computed as
|
||||
\f$w = \frac{1}{d^a}\f$
|
||||
with notations shown in the figure below and \f$a\f$ any real number
|
||||
|
|
@ -57,6 +61,8 @@ a model of `AnalyticWeightTraits_3` for 3D points
|
|||
\defgroup PkgWeightsRefInverseDistanceWeights Inverse Distance Weight
|
||||
\ingroup PkgWeightsRefAnalytic
|
||||
|
||||
`#include <CGAL/Weights/inverse_distance_weights.h>`
|
||||
|
||||
This weight is computed as
|
||||
\f$w = \frac{1}{d}\f$
|
||||
with notations shown in the figure below.
|
||||
|
|
@ -84,6 +90,8 @@ a model of `AnalyticWeightTraits_3` for 3D points
|
|||
\defgroup PkgWeightsRefThreePointFamilyWeights Three Point Family Weight
|
||||
\ingroup PkgWeightsRefAnalytic
|
||||
|
||||
`#include <CGAL/Weights/three_point_family_weights.h>`
|
||||
|
||||
This weight is computed as
|
||||
\f$w = \frac{d_2^a A_1 - d^a B + d_1^a A_2}{A_1 A_2}\f$
|
||||
with notations shown in the figure below and \f$a\f$ any real number
|
||||
|
|
@ -121,6 +129,8 @@ a model of `AnalyticWeightTraits_3` for 3D points
|
|||
\defgroup PkgWeightsRefWachspressWeights Wachspress Weight
|
||||
\ingroup PkgWeightsRefAnalytic
|
||||
|
||||
`#include <CGAL/Weights/wachspress_weights.h>`
|
||||
|
||||
This weight is computed as
|
||||
\f$w = \frac{C}{A_1 A_2}\f$
|
||||
with notations shown in the figure below.
|
||||
|
|
@ -150,6 +160,8 @@ a model of `AnalyticWeightTraits_3` for 3D points
|
|||
\defgroup PkgWeightsRefAuthalicWeights Authalic Weight
|
||||
\ingroup PkgWeightsRefAnalytic
|
||||
|
||||
`#include <CGAL/Weights/authalic_weights.h>`
|
||||
|
||||
This weight is computed as
|
||||
\f$w = 2 \frac{\cot\beta + \cot\gamma}{d^2}\f$
|
||||
with notations shown in the figure below.
|
||||
|
|
@ -178,6 +190,8 @@ a model of `AnalyticWeightTraits_3` for 3D points
|
|||
\defgroup PkgWeightsRefMeanValueWeights Mean Value Weight
|
||||
\ingroup PkgWeightsRefAnalytic
|
||||
|
||||
`#include <CGAL/Weights/mean_value_weights.h>`
|
||||
|
||||
This weight is computed as
|
||||
\f$w = \pm 2 \sqrt{\frac{2 (d_1 d_2 - D)}{(d d_1 + D_1)(d d_2 + D_2)}}\f$
|
||||
with notations shown in the figure below and dot products
|
||||
|
|
@ -213,6 +227,8 @@ a model of `AnalyticWeightTraits_3` for 3D points
|
|||
\defgroup PkgWeightsRefTangentWeights Tangent Weight
|
||||
\ingroup PkgWeightsRefAnalytic
|
||||
|
||||
`#include <CGAL/Weights/tangent_weights.h>`
|
||||
|
||||
This weight is computed as
|
||||
\f$w = 2 \frac{t_1 + t_2}{d}\f$, where
|
||||
\f$t_1 = \frac{2 A_1}{d d_1 + D_1}\f$ and
|
||||
|
|
@ -246,6 +262,8 @@ a model of `AnalyticWeightTraits_3` for 3D points
|
|||
\defgroup PkgWeightsRefDiscreteHarmonicWeights Discrete Harmonic Weight
|
||||
\ingroup PkgWeightsRefAnalytic
|
||||
|
||||
`#include <CGAL/Weights/discrete_harmonic_weights.h>`
|
||||
|
||||
This weight is computed as
|
||||
\f$w = \frac{d_2^2 A_1 - d^2 B + d_1^2 A_2}{A_1 A_2}\f$
|
||||
with notations shown in the figure below.
|
||||
|
|
@ -275,6 +293,8 @@ a model of `AnalyticWeightTraits_3` for 3D points
|
|||
\defgroup PkgWeightsRefCotangentWeights Cotangent Weight
|
||||
\ingroup PkgWeightsRefAnalytic
|
||||
|
||||
`#include <CGAL/Weights/cotangent_weights.h>`
|
||||
|
||||
This weight is computed as
|
||||
\f$w = 2 (\cot\beta + \cot\gamma)\f$
|
||||
with notations shown in the figure below.
|
||||
|
|
@ -308,6 +328,8 @@ to polygons. These weights are then normalized in order to obtain barycentric co
|
|||
\defgroup PkgWeightsRefBarycentricWachspressWeights Wachspress Weights
|
||||
\ingroup PkgWeightsRefBarycentric
|
||||
|
||||
`#include <CGAL/Weights/wachspress_weights.h>`
|
||||
|
||||
Wachspress weights which can be computed for a query point with respect to the
|
||||
vertices of a strictly convex polygon.
|
||||
|
||||
|
|
@ -317,6 +339,8 @@ vertices of a strictly convex polygon.
|
|||
\defgroup PkgWeightsRefBarycentricMeanValueWeights Mean Value Weights
|
||||
\ingroup PkgWeightsRefBarycentric
|
||||
|
||||
`#include <CGAL/Weights/mean_value_weights.h>`
|
||||
|
||||
Mean value weights which can be computed for a query point with respect to the
|
||||
vertices of a simple polygon.
|
||||
|
||||
|
|
@ -326,6 +350,8 @@ vertices of a simple polygon.
|
|||
\defgroup PkgWeightsRefBarycentricDiscreteHarmonicWeights Discrete Harmonic Weights
|
||||
\ingroup PkgWeightsRefBarycentric
|
||||
|
||||
`#include <CGAL/Weights/discrete_harmonic_weights.h>`
|
||||
|
||||
Discrete Harmonic weights which can be computed for a query point with respect to the
|
||||
vertices of a strictly convex polygon.
|
||||
|
||||
|
|
@ -342,6 +368,8 @@ used to balance other weights.
|
|||
\defgroup PkgWeightsRefUniformRegionWeights Uniform Region Weight
|
||||
\ingroup PkgWeightsRefRegions
|
||||
|
||||
`#include <CGAL/Weights/uniform_region_weights.h>`
|
||||
|
||||
This weight is always equal to 1.
|
||||
|
||||
\tparam GeomTraits
|
||||
|
|
@ -354,6 +382,8 @@ a model of `AnalyticWeightTraits_3` for 3D points
|
|||
\defgroup PkgWeightsRefTriangularRegionWeights Triangular Region Weight
|
||||
\ingroup PkgWeightsRefRegions
|
||||
|
||||
`#include <CGAL/Weights/triangular_region_weights.h>`
|
||||
|
||||
This weight is the area of the shaded region in the figure below. The region is
|
||||
the triangle `[p, q, r]`.
|
||||
|
||||
|
|
@ -371,6 +401,8 @@ a model of `AnalyticWeightTraits_3` for 3D points
|
|||
\defgroup PkgWeightsRefBarycentricRegionWeights Barycentric Region Weight
|
||||
\ingroup PkgWeightsRefRegions
|
||||
|
||||
`#include <CGAL/Weights/barycentric_region_weights.h>`
|
||||
|
||||
This weight is the area of the shaded region in the figure below. The region
|
||||
is formed by the two midpoints of the edges incident to `q` and the barycenter of
|
||||
the triangle `[p, q, r]`.
|
||||
|
|
@ -389,6 +421,8 @@ a model of `AnalyticWeightTraits_3` for 3D points
|
|||
\defgroup PkgWeightsRefVoronoiRegionWeights Voronoi Region Weight
|
||||
\ingroup PkgWeightsRefRegions
|
||||
|
||||
`#include <CGAL/Weights/voronoi_region_weights.h>`
|
||||
|
||||
This weight is the area of the shaded region in the figure below. The region
|
||||
is formed by the two midpoints of the edges incident to `q` and the circumcenter of
|
||||
the triangle `[p, q, r]`.
|
||||
|
|
@ -409,6 +443,8 @@ a model of `AnalyticWeightTraits_3` for 3D points
|
|||
\defgroup PkgWeightsRefMixedVoronoiRegionWeights Mixed Voronoi Region Weight
|
||||
\ingroup PkgWeightsRefRegions
|
||||
|
||||
`#include <CGAL/Weights/mixed_voronoi_region_weights.h>`
|
||||
|
||||
This weight is the area of the shaded region in the figure below. The region
|
||||
is formed by the two midpoints of the edges incident to `q` and the circumcenter of
|
||||
the triangle `[p, q, r]`.
|
||||
|
|
|
|||
|
|
@ -17,8 +17,9 @@
|
|||
#include <CGAL/license/Weights.h>
|
||||
|
||||
/**
|
||||
@file Weights.h
|
||||
@brief a convenience header that includes all weights.
|
||||
* \ingroup PkgWeightsRef
|
||||
* \file CGAL/Weights.h
|
||||
* A convenience header that includes all weights.
|
||||
*/
|
||||
|
||||
#include <CGAL/Weights/utils.h>
|
||||
|
|
|
|||
Loading…
Reference in New Issue