-
Notifications
You must be signed in to change notification settings - Fork 59
Expand file tree
/
Copy pathRcppParallelFlags.Rd
More file actions
32 lines (27 loc) · 993 Bytes
/
RcppParallelFlags.Rd
File metadata and controls
32 lines (27 loc) · 993 Bytes
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
\name{RcppParallelFlags}
\alias{RcppParallelLibs}
\alias{LdFlags}
\alias{CxxFlags}
\title{
Compilation flags for RcppParallel
}
\description{
Output the compiler or linker flags required to build against RcppParallel.
}
\usage{
CxxFlags()
LdFlags()
RcppParallelLibs()
}
\details{
These functions are typically called from \code{Makevars} as follows:
\code{PKG_LIBS += $(shell "${R_HOME}/bin/Rscript" -e "RcppParallel::LdFlags()")}
On Windows, the flags ensure that the package links with the built-in TBB library.
On Linux and macOS, the output is empty, because TBB is loaded dynamically.
To ensure portability, load \pkg{RcppParallel} before loading your package, e.g. by including \code{importFrom(RcppParallel, RcppParallelLibs)} in your \code{NAMESPACE} file.
See \url{https://github.com/RcppCore/RcppParallel/issues/129} for details.
}
\value{
Returns \code{NULL} invisibly. The function is not called for it's
return value rather for the side effect of outputting the flags.
}