From 649db1ffdb48a9092012aaabb3fde11f2db17411 Mon Sep 17 00:00:00 2001 From: Dmitry Anisimov Date: Mon, 28 Jun 2021 14:29:10 +0200 Subject: [PATCH] added missing includes in the docs + convenience header --- Weights/doc/Weights/PackageDescription.txt | 36 ++++++++++++++++++++++ Weights/include/CGAL/Weights.h | 5 +-- 2 files changed, 39 insertions(+), 2 deletions(-) diff --git a/Weights/doc/Weights/PackageDescription.txt b/Weights/doc/Weights/PackageDescription.txt index b85e768b8ac..fa3ba620891 100644 --- a/Weights/doc/Weights/PackageDescription.txt +++ b/Weights/doc/Weights/PackageDescription.txt @@ -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 ` + 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 ` + 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 ` + 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 ` + 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 ` + 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 ` + 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 ` + 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 ` + 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 ` + 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 ` + 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 ` + 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 ` + 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 ` + 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 ` + 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 ` + 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 ` + 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 ` + 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 ` + 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]`. diff --git a/Weights/include/CGAL/Weights.h b/Weights/include/CGAL/Weights.h index c623955eb63..7bca600e00b 100644 --- a/Weights/include/CGAL/Weights.h +++ b/Weights/include/CGAL/Weights.h @@ -17,8 +17,9 @@ #include /** -@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