This package provides an R interface to the header-only C++ CGAL version 4 library

This package is using the latest release of the version 4 of CGAL.

Install

Install the development version with the remotes R package

remotes::install_gitlab("dickoa/cgal4h")

Using cgal4h

In order to use cgal4h in your own R package, you need to add it to the LinkingTo field in the DESCRIPTION field of R package. You also need to have the following C++ compiler flag.

-DCGAL_HEADER_ONLY=ON

You will have more information on how to use CGAL 4 in header-only mode in your own code in the official documentation.

If you are using Rcpp don’t forget to add a dependency to cgal4h to your cpp files before a call to #include <Rcpp.h>

// [[Rcpp::depends(cgal4h)]]

#include <Rcpp.h>

Missing headers

Because of portability issues not all headers are included in this package, the following components are currently missing:

  • CGAL/Algebraic_kernel_for_circles
  • CGAL/Algebraic_kernel_for_spheres
  • Polygon_mesh_processing/internal
  • CGAL/Shape_detection/

If you want to use them, please raise an issue.

License

This package is provided under the GPL-3.

The CGAL library uses the dual license GPL-3. | LGPL-3. More information can be found at https://www.cgal.org/license.html.