[Feature] Weights New Package

Installation/CHANGES.md

@@ -5,6 +5,15 @@ Release History
 
 Release date: December 2021
 
+### [Weights](https://doc.cgal.org/5.4/Manual/packages.html#PkgWeights) (new package)
+
+-   This package provides a simple and unified interface to different types of weights.
+    In particular, it groups all weights into three category: analytic weights including
+    all basic weights which can be computed analytically for a query point with respect to its
+    local neighbors in 2D and 3D; barycentric weights including all weights which can be computed
+    for a query point with respect to the vertices of a planar polygon; and weighting regions
+    including all weights which are used to balance other weights.
+
 ### [2D and 3D Linear Geometry Kernel](https://doc.cgal.org/5.4/Manual/packages.html#PkgKernel23)
 
 -   Added `construct_centroid_2_object()` and `compute_determinant_2_object()` in `Projection_traits_xy_3`, `Projection_traits_xz_3`,

Installation/include/CGAL/license/Weights.h

@@ -0,0 +1,54 @@
+// Copyright (c) 2016  GeometryFactory SARL (France).
+// All rights reserved.
+//
+// This file is part of CGAL (www.cgal.org)
+//
+// $URL$
+// $Id$
+// SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-Commercial
+//
+// Author(s) : Andreas Fabri
+//
+// Warning: this file is generated, see include/CGAL/licence/README.md
+
+#ifndef CGAL_LICENSE_WEIGHTS_H
+#define CGAL_LICENSE_WEIGHTS_H
+
+#include <CGAL/config.h>
+#include <CGAL/license.h>
+
+#ifdef CGAL_WEIGHTS_COMMERCIAL_LICENSE
+
+#  if CGAL_WEIGHTS_COMMERCIAL_LICENSE < CGAL_RELEASE_DATE
+
+#    if defined(CGAL_LICENSE_WARNING)
+
+       CGAL_pragma_warning("Your commercial license for CGAL does not cover "
+                           "this release of the Weights package.")
+#    endif
+
+#    ifdef CGAL_LICENSE_ERROR
+#      error "Your commercial license for CGAL does not cover this release \
+              of the Weights package. \
+              You get this error, as you defined CGAL_LICENSE_ERROR."
+#    endif // CGAL_LICENSE_ERROR
+
+#  endif // CGAL_WEIGHTS_COMMERCIAL_LICENSE < CGAL_RELEASE_DATE
+
+#else // no CGAL_WEIGHTS_COMMERCIAL_LICENSE
+
+#  if defined(CGAL_LICENSE_WARNING)
+     CGAL_pragma_warning("\nThe macro CGAL_WEIGHTS_COMMERCIAL_LICENSE is not defined."
+                          "\nYou use the CGAL Weights package under "
+                          "the terms of the GPLv3+.")
+#  endif // CGAL_LICENSE_WARNING
+
+#  ifdef CGAL_LICENSE_ERROR
+#    error "The macro CGAL_WEIGHTS_COMMERCIAL_LICENSE is not defined.\
+            You use the CGAL Weights package under the terms of \
+            the GPLv3+. You get this error, as you defined CGAL_LICENSE_ERROR."
+#  endif // CGAL_LICENSE_ERROR
+
+#endif // no CGAL_WEIGHTS_COMMERCIAL_LICENSE
+
+#endif // CGAL_LICENSE_WEIGHTS_H

Installation/include/CGAL/license/gpl_package_list.txt

@@ -96,3 +96,4 @@ Triangulation dD Triangulations
 Visibility_2 2D Visibility Computation
 Voronoi_diagram_2 2D Voronoi Diagram Adaptor
 Tetrahedral_remeshing Tetrahedral Remeshing
+Weights Weights

Kernel_23/doc/Kernel_23/CGAL/Projection_traits_xy_3.h

@@ -30,6 +30,7 @@ and predicates defined in `K`.
 \cgalModels `ConstrainedTriangulationTraits_2`
 \cgalModels `ConvexHullTraits_2`
 \cgalModels `DelaunayMeshTraits_2`
+\cgalModels `AnalyticWeightTraits_2`
 
 */
 template< typename K >

Kernel_23/doc/Kernel_23/dependencies

@@ -10,3 +10,4 @@ Circular_kernel_2
 Circular_kernel_3
 STL_Extension
 Polyhedron
+Weights

Weights/doc/Weights/Concepts/AnalyticWeightTraits_2.h

@@ -0,0 +1,202 @@
+/*!
+\ingroup PkgWeightsRefConcepts
+\cgalConcept
+
+A concept that describes the set of requirements of classes used in the computation
+of analytic weights in 2D.
+
+\cgalHasModel
+- All models of `Kernel`
+- `CGAL::Projection_traits_xy_3<K>`
+- `CGAL::Projection_traits_yz_3<K>`
+- `CGAL::Projection_traits_xz_3<K>`
+*/
+class AnalyticWeightTraits_2 {
+
+public:
+
+/// \name Types
+/// @{
+
+/*!
+  A model of `FieldNumberType`.
+*/
+typedef unspecified_type FT;
+
+/*!
+  `CGAL::Comparison_result` or `Uncertain<CGAL::Comparison_result>`.
+*/
+typedef unspecified_type Comparison_result;
+
+/*!
+  `CGAL::Orientation` or `Uncertain<CGAL::Orientation>`.
+*/
+typedef unspecified_type Orientation;
+
+/// @}
+
+/// \name Geometric Objects
+/// @{
+
+/*!
+  2D point type.
+*/
+typedef unspecified_type Point_2;
+
+/*!
+  2D vector type.
+*/
+typedef unspecified_type Vector_2;
+
+/// @}
+
+/// \name Constructions
+/// @{
+
+/*!
+  A construction object that must provide the function operator:
+
+  `FT operator()(const Point_2& p, const Point_2& q, const Point_2& r)`
+
+  that returns the signed area of the triangle defined by the points `p`, `q`, and `r`.
+*/
+typedef unspecified_type Compute_area_2;
+
+/*!
+  A construction object that must provide the function operator:
+
+  `FT operator()(const Point_2& p, const Point_2& q)`
+
+  that returns the squared Euclidean distance between the points `p` and `q`.
+*/
+typedef unspecified_type Compute_squared_distance_2;
+
+/*!
+  A construction object that must provide the function operator:
+
+  `FT operator()(const Vector_2& v)`
+
+  that returns the squared length of the vector `v`.
+*/
+typedef unspecified_type Compute_squared_length_2;
+
+/*!
+  A construction object that must provide the function operator:
+
+  `FT operator()(const Vector_2& v, const Vector_2& w)`
+
+  that returns the scalar product of the vectors `v` and `w`.
+*/
+typedef unspecified_type Compute_scalar_product_2;
+
+/*!
+  A construction object that must provide the function operator:
+
+  `FT operator()(const Vector_2& v, const Vector_2& w)`
+
+  that returns the determinant of the vectors `v` and `w`.
+*/
+typedef unspecified_type Compute_determinant_2;
+
+/*!
+  A construction object that must provide the function operator:
+
+  `%Point_2 operator()(const Point_2& p, const Point_2& q, const Point_2& r)`
+
+  that returns the center of the circle passing through the points `p`, `q`, and `r`.
+
+  \pre The points `p`, `q`, and `r` are not collinear.
+*/
+typedef unspecified_type Construct_circumcenter_2;
+
+/*!
+  A construction object that must provide the function operator:
+
+  `%Vector_2 operator()(const Point_2& p, const Point_2& q)`
+
+  that returns the vector through the points `p` and `q`.
+*/
+typedef unspecified_type Construct_vector_2;
+
+/*!
+  A construction object that must provide the function operator:
+
+  `%Point_2 operator()(const Point_2& p, const Point_2& q)`
+
+  that returns the midpoint between the points `p` and `q`.
+*/
+typedef unspecified_type Construct_midpoint_2;
+
+/*!
+  A construction object that must provide the function operator:
+
+  `%Point_2 operator()(const Point_2& p, const Point_2& q, const Point_2& r)`
+
+  that returns the centroid of the points `p`, `q`, and `r`.
+*/
+typedef unspecified_type Construct_centroid_2;
+
+/// @}
+
+/// \name Predicates
+/// @{
+
+/*!
+  A predicate object that must provide the function operator:
+
+  `bool operator()(const Point_2& p, const Point_2& q)`
+
+  that returns `true` if `p = q` and `false` otherwise.
+*/
+typedef unspecified_type Equal_2;
+
+/*!
+  A predicate object that must provide the function operator:
+
+  `bool operator()(const Point_2& p, const Point_2& q, const Point_2& r)`
+
+  that returns `true` if the points `p`, `q`, and `r` are collinear and `false` otherwise.
+*/
+typedef unspecified_type Collinear_2;
+
+/*!
+  A predicate object that must provide the function operator:
+
+  `bool operator()(const Point_2& p, const Point_2& q)`
+
+  that returns `true` iff the x-coordinate of `p` is smaller than the x-coordinate of `q` or
+  if they are the same and the y-coordinate of `p` is smaller than the y-coordinate of `q`.
+*/
+typedef unspecified_type Less_xy_2;
+
+/*!
+  A predicate object that must provide the function operator:
+
+  `Comparison_result operator()(const Point_2& p, const Point_2& q)`
+
+  that compares the %Cartesian x-coordinates of the points `p` and `q`.
+*/
+typedef unspecified_type Compare_x_2;
+
+/*!
+  A predicate object that must provide the function operator:
+
+  `Comparison_result operator()(const Point_2& p, const Point_2& q)`
+
+  that compares the %Cartesian y-coordinates of the points `p` and `q`.
+*/
+typedef unspecified_type Compare_y_2;
+
+/*!
+  A predicate object that must provide the function operator:
+
+  `Orientation operator()(const Point_2& p, const Point_2& q, const Point_2& r)`
+
+  that returns `CGAL::LEFT_TURN` if `r` lies to the left of the oriented line `l` defined by `p` and `q`,
+  returns `CGAL::RIGHT_TURN` if `r` lies to the right of `l`, and returns `CGAL::COLLINEAR` if `r` lies on `l`.
+*/
+typedef unspecified_type Orientation_2;
+
+/// @}
+
+};