Package 'RcppCGAL'

Title: '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.0.1 of the 'CGAL' header files.
Authors: Eric Dunipace [aut, cre] , Tyler Morgan-Wall [ctb], The CGAL Project [cph]
Maintainer: Eric Dunipace <[email protected]>
License: GPL-3
Version: 6.0
Built: 2024-11-27 01:25:55 UTC
Source: https://github.com/ericdunipace/rcppcgal

Help Index


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.0.1 of the 'CGAL' header files.

Author(s)

Maintainer: Eric Dunipace [email protected] (ORCID)

Other contributors:

References

The CGAL Project. (2023). CGAL User and Reference Manual. Retrieved from https://doc.cgal.org/latest/Manual/index.html

See Also

Useful links:


Check if CGAL header files exist in RcppCGAL package

Description

Check if CGAL header files exist in RcppCGAL package

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()

Return CGAL version

Description

Return CGAL version

Usage

cgal_version()

Value

prints the CGAL version of the package

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

Value

Invisibley returns TRUE if the CGAL_DIR variable was successfully set or or FALSE if it was not.

See Also

unset_cgal()

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

Value

Invisibley returns TRUE if the CGAL_DIR variable was successfully removed or or FALSE if it was not.

See Also

unset_cgal()

Examples

## Not run: 
unset_cgal()

## End(Not run)