Package 'cpp11eigen'

Title: An 'Eigen' Interface
Description: Provides function declarations and inline function definitions that facilitate communication between R and the 'Eigen' 'C++' library for linear algebra and scientific computing.
Authors: Mauricio Vargas Sepulveda [aut, cre] , Gael Guennebaud [aut] (Eigen library (C++)), Gael Guennebaud [aut] (Eigen library (C++)), Benot Jacob [aut] (Eigen library (C++)), Intel Corporation [aut] (Eigen library (C++)), Xerox Corporation [aut] (Eigen library (C++))
Maintainer: Mauricio Vargas Sepulveda <[email protected]>
License: Apache License (>= 2)
Version: 0.2.5
Built: 2024-11-16 04:19:38 UTC
Source: https://github.com/pachadotdev/cpp11eigen

Help Index


Vendor the cpp11 and cpp11eigen dependency

Description

Vendoring is the act of making your own copy of the 3rd party packages your project is using. It is often used in the go language community.

Usage

cpp_vendor(dir = NULL, subdir = "/inst/include")

Arguments

dir

The directory to vendor the code into.

subdir

The subdirectory to vendor the code into.

Details

This function vendors cpp11 and cpp11eigen into your package by copying the cpp11 and cpp11eigen headers into the 'inst/include' folder and adding 'cpp11 version: XYZ' and 'cpp11eigen version: XYZ' to the top of the files, where XYZ is the version of cpp11 and cpp11eigen currently installed on your machine.

Vendoring places the responsibility of updating the code on you. Bugfixes and new features in cpp11 and cpp11eigen will not be available for your code until you run 'cpp_vendor()' again.

Value

The file path to the vendored code (invisibly).

Examples

# create a new directory
dir <- tempdir()
dir.create(dir)

# vendor the cpp11 headers into the directory
cpp_vendor(dir)

Get eigen version

Description

Provides the eigen C++ library version number included in the package.

Usage

eigen_version()

Value

A string with the eigen version name and number

Examples

eigen_version()

Start a new project with the cpp11eigen package template

Description

Start a new project with the cpp11eigen package template

Usage

pkg_template(path = NULL, pkgname = NULL)

Arguments

path

Path to the new project

pkgname

Name of the new package

Value

The file path to the copied template (invisibly).

Examples

# create a new directory
dir <- tempdir()
dir.create(dir)

# copy the package template into the directory
pkg_template(dir, "mynewpkg")