Skip to content

Commit 5dc97d9

Browse files
committed
add urls to DESCRIPTION; update package man page
1 parent 31557f7 commit 5dc97d9

2 files changed

Lines changed: 16 additions & 3 deletions

File tree

DESCRIPTION

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Description: High level functions for doing parallel programming with Rcpp.
2121
Suggests: Rcpp, testthat
2222
SystemRequirements: GNU make
2323
License: GPL-2
24+
URL: http://rcppcore.github.io/RcppParallel, https://github.com/RcppCore/RcppParallel
2425
Collate:
2526
'build.R'
2627
'hooks.R'

man/RcppParallel-package.Rd

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,24 @@
55
\title{Parallel programming tools for Rcpp}
66
\description{
77
High level functions for doing parallel programming with Rcpp.
8-
For example, the parallelFor function can be used to convert the work of
9-
a standard serial "for" loop into a parallel one and the parallelReduce
8+
For example, the \code{parallelFor} function can be used to convert the work of
9+
a standard serial "for" loop into a parallel one and the \code{parallelReduce}
1010
function can be used for accumulating aggregate or other values.
11+
12+
The high level interface enables safe and robust parallel programming without
13+
direct manipulation of operating system threads. On Windows, OS X, and Linux
14+
systems the underlying implementation is based on \href{https://www.threadingbuildingblocks.org/}{Intel TBB} (Threading Building
15+
Blocks). On other platforms a less-performant fallback implementation based on the
16+
\href{http://tinythreadpp.bitsnbites.eu/}{TinyThread} library is used.
17+
18+
For additional documentation see the package website at: \href{http://rcppcore.github.io/RcppParallel}{http://rcppcore.github.io/RcppParallel}.
1119
}
20+
1221
\author{
13-
JJ Allaire \email{jj@rstudio.com}
22+
JJ Allaire, Romain Francois, Gregory Vandenbrouck, Marcus Geelnard, Intel Inc.
1423
}
24+
25+
1526
\keyword{package}
27+
\keyword{parallel}
1628

0 commit comments

Comments
 (0)