File: bindrcpp-package.R

package info (click to toggle)
r-cran-bindrcpp 0.2.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 208 kB
  • sloc: cpp: 141; ansic: 57; sh: 13; makefile: 2
file content (19 lines) | stat: -rw-r--r-- 945 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
#' @details Use `LinkingTo: bindrcpp` in `DESCRIPTION` and
#' `#include <bindrcpp.h>` in your C++ headers and/or modules to access the
#' C++ functions provided by this package:
#'
#' - `create_env_string()` creates an environment with active bindings, with
#'    names given as a character vector.  Access of these bindings triggers a
#'    call to a C++ function with a fixed signature (`GETTER_FUNC_STRING`);
#'    this call contains the name of the binding (as character) and an arbitrary
#'    payload (`PAYLOAD`, essentially a wrapped `void*`).
#' - `create_env_symbol()` is similar, the callback function accepts the name of
#'   the binding as symbol instead of character (`GETTER_FUNC_SYMBOL`).
#' - `populate_env_string()` and `populate_env_symbol()` populate an existing
#'   environment instead of creating a new one.
"_PACKAGE"

#' @useDynLib bindrcpp
#' @importFrom Rcpp sourceCpp
#' @importFrom bindr create_env populate_env
NULL