| Type: | Package |
| Title: | 'Rcpp' Integration for 'CGAL' |
| Version: | 6.2.1.1 |
| Date: | 2026-10-08 |
| Description: | Creates a header only package to link to the 'CGAL' (Computational Geometry Algorithms Library) header files in 'Rcpp'. There are a variety of potential uses for the software such as Hilbert sorting, K-D Tree nearest neighbors, and convex hull algorithms. For more information about how to use the header files, see the 'CGAL' documentation at https://www.cgal.org. Currently downloads version 6.2.1 of the 'CGAL' header files. |
| License: | GPL-3 |
| Imports: | Rcpp, utils, lifecycle |
| Suggests: | knitr, rmarkdown, spelling, testthat (≥ 3.0.0) |
| BugReports: | https://github.com/ericdunipace/RcppCGAL/issues |
| NeedsCompilation: | no |
| Encoding: | UTF-8 |
| VignetteBuilder: | knitr |
| Biarch: | TRUE |
| Language: | en-US |
| URL: | https://github.com/ericdunipace/RcppCGAL |
| Config/testthat/edition: | 3 |
| Config/roxygen2/version: | 8.1.0 |
| Packaged: | 2026-10-12 22:57:14 UTC; eifer |
| Author: | Eric Dunipace 
[aut, cre],
Tyler Morgan-Wall [ctb],
Michael Chirico [ctb],
The CGAL Project [cph] |
| Maintainer: | Eric Dunipace <edunipace@mail.harvard.edu> |
| Repository: | CRAN |
| Date/Publication: | 2026-10-13 00:10:02 UTC |
RcppCGAL: 'Rcpp' Integration for 'CGAL'
Description
Creates a header only package to link to the 'CGAL' (Computational Geometry Algorithms Library) header files in 'Rcpp'. There are a variety of potential uses for the software such as Hilbert sorting, K-D Tree nearest neighbors, and convex hull algorithms. For more information about how to use the header files, see the 'CGAL' documentation at https://www.cgal.org. Currently downloads version 6.2.1 of the 'CGAL' header files.
Author(s)
Maintainer: Eric Dunipace edunipace@mail.harvard.edu (ORCID)
Authors:
Eric Dunipace edunipace@mail.harvard.edu (ORCID)
Other contributors:
Tyler Morgan-Wall tylermw@gmail.com [contributor]
Michael Chirico [contributor]
The CGAL Project [copyright holder]
References
The CGAL Project. (2026). CGAL User and Reference Manual. Retrieved from https://doc.cgal.org/latest/Manual/index.html
See Also
Useful links:
Report bugs at https://github.com/ericdunipace/RcppCGAL/issues
Return Bundled CGAL Header Version
Description
Return Bundled CGAL Header Version
Usage
cgal_bundled_version()
Value
Returns ts the default version number of the CGAL header files bundled with the package as a character string
Examples
cgal_bundled_version()
Report CGAL header information
Description
Report CGAL header information
Usage
cgal_header_info()
Value
Invisibly returns a character string describing the source of the CGAL header files. The same information is also printed as a message.
Examples
cgal_header_info()
Check if CGAL header files exist in RcppCGAL package
Description
![[Stable]](./figures/lifecycle-stable.svg)
Usage
cgal_is_installed()
Details
This function will perform a very simple check to see if the CGAL folder exists in the include directory and that it is non-empty. If the folder exists and is non-empty, the function returns TRUE; otherwise the function returns FALSE.
Value
logical value
Examples
cgal_is_installed()
Report CGAL header information
Description
![[Deprecated]](./figures/lifecycle-deprecated.svg)
Usage
cgal_version()
Details
cgal_version() is deprecated in favor of cgal_header_info().
Value
The value returned by cgal_header_info().
Examples
cgal_version()
Set the CGAL header file directory
Description
This package will set the CGAL_DIR environmental variable if you don't know how. Then you can re-install the RcppCGAL package and the installation should use your preferred source of the CGAL library. Note the cleaner functions will run automatically and replace the calls to std::err and exit in the C code. They have been tested on CGAL 5.6 so are not guaranteed to work with other versions of the CGAL headers.
Usage
set_cgal(path)
Arguments
path |
character vector. either a URL or system path |
Details
Value
Invisibly returns TRUE if the CGAL_DIR variable was successfully set or or FALSE if it was not.
See Also
Examples
## Not run:
set_cgal("path/to/include/CGAL")
## End(Not run)
Unset the CGAL header file directory
Description
This package will remove the CGAL_DIR environmental variable.
Usage
unset_cgal(...)
Arguments
... |
Not used at this time |
Details
Value
Invisibley returns TRUE if the CGAL_DIR variable was successfully removed or or FALSE if it was not.
See Also
Examples
## Not run:
unset_cgal()
## End(Not run)