[Rcpp-commits] r752 - in pkg: Rcpp/man RcppExamples RcppExamples/R RcppExamples/man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Sat Feb 20 18:51:31 CET 2010
Author: edd
Date: 2010-02-20 18:51:31 +0100 (Sat, 20 Feb 2010)
New Revision: 752
Modified:
pkg/Rcpp/man/Rcpp-package.Rd
pkg/RcppExamples/DESCRIPTION
pkg/RcppExamples/R/RcppExample.R
pkg/RcppExamples/man/RcppDate.Rd
pkg/RcppExamples/man/RcppExample.Rd
pkg/RcppExamples/man/RcppParams.Rd
pkg/RcppExamples/man/RcppResultSet.Rd
pkg/RcppExamples/man/RcppVector.Rd
Log:
update man pages
set date property in RcppExample's DESCRIPTION too
correct one last .Call wrt to package name
Modified: pkg/Rcpp/man/Rcpp-package.Rd
===================================================================
--- pkg/Rcpp/man/Rcpp-package.Rd 2010-02-19 16:21:02 UTC (rev 751)
+++ pkg/Rcpp/man/Rcpp-package.Rd 2010-02-20 17:51:31 UTC (rev 752)
@@ -88,7 +88,10 @@
library is provided. The two \code{\link{Rcpp}} functions detailed
above provide the relevant content.
}
-\author{Dominick Samperi wrote most of Rcpp during 2005 and 2006. Dirk
- Eddelbuettel made some additions, and became maintainer in 2008.}
+\author{Dominick Samperi wrote the initial versions of Rcpp (and
+ RcppTemplate) during 2005 and 2006. Dirk Eddelbuettel made some
+ additions, and became maintainer in 2008. Dirk Eddelbuettel and Romain
+ Francois have been extending Rcpp since 2009.
+}
\keyword{programming}
\keyword{interface}
Modified: pkg/RcppExamples/DESCRIPTION
===================================================================
--- pkg/RcppExamples/DESCRIPTION 2010-02-19 16:21:02 UTC (rev 751)
+++ pkg/RcppExamples/DESCRIPTION 2010-02-20 17:51:31 UTC (rev 752)
@@ -1,7 +1,7 @@
Package: RcppExamples
Title: Examples using Rcpp to interface R and C++
Version: 0.1.0
-Date: $Date: 2010-02-16 10:30:00 -0600 (Tue, 16 Feb 2010) $
+Date: $Date$
Author: Dirk Eddelbuettel and Romain Francois, based on code written
during 2005 and 2006 by Dominick Samperi
Maintainer: Dirk and Romain <RomainAndDirk at r-enthusiasts.com>
Property changes on: pkg/RcppExamples/DESCRIPTION
___________________________________________________________________
Name: svn:keywords
+ Date
Modified: pkg/RcppExamples/R/RcppExample.R
===================================================================
--- pkg/RcppExamples/R/RcppExample.R 2010-02-19 16:21:02 UTC (rev 751)
+++ pkg/RcppExamples/R/RcppExample.R 2010-02-20 17:51:31 UTC (rev 752)
@@ -167,7 +167,7 @@
## Make the call...
val <- .Call("RcppVectorExample",
v,
- PACKAGE="Rcpp")
+ PACKAGE="RcppExamples")
## Define a class for the return value so we can control what gets
## printed when a variable assigned this value is typed on a line by itself.
Modified: pkg/RcppExamples/man/RcppDate.Rd
===================================================================
--- pkg/RcppExamples/man/RcppDate.Rd 2010-02-19 16:21:02 UTC (rev 751)
+++ pkg/RcppExamples/man/RcppDate.Rd 2010-02-20 17:51:31 UTC (rev 752)
@@ -32,7 +32,8 @@
%}
\details{
Usage of the \code{RcppDate}, \code{RcppDatetime} (and their vector
- extensions) in \code{C++} is fully defined in \code{Rcpp.h}.
+ extensions) in \code{C++} is fully defined in the respective header
+ files \code{RcppDate.h} and \code{RcppDatetime.h}.
As example, consider a call from \R to \code{C++} such as
@@ -40,13 +41,13 @@
# an R example passing one type of each class to a function
# someFunction in package somePackage
val <- .Call("someFunction",
- Sys.Date(), # current date
- Sys.time(), # current timestamp
- as.Date("2000-02-25")
- + 0:5, # date vector
- ISOdatetime(1999,12,31,23,59,0)
- + (0:5)*0.250, # datetime vector
- PACKAGE="somePackage")
+ Sys.Date(), # current date
+ Sys.time(), # current timestamp
+ as.Date("2000-02-25")
+ + 0:5, # date vector
+ ISOdatetime(1999,12,31,23,59,0)
+ + (0:5)*0.250, # datetime vector
+ PACKAGE="somePackage")
}
At the \code{C++} level, the corresponding code to assign these parameter to
@@ -62,19 +63,23 @@
}
}
- Standard accessor functions are defined, see \code{Rcpp.h} for details.
+ Standard accessor functions are defined, see \code{RcppDate.h} and
+ \code{RcppDatetime.h} for details.
Objects of these types can also be returned via \code{RcppResultSet}.
}
-%\references{
-% See \code{Rcpp.h} and the package vignette.
-%}
+\references{
+ \emph{Writing R Extensions}, available at \url{http:www.r-project.org}.
+}
\seealso{
- \code{RcppResultSet}, the vignette \dQuote{RcppAPI}.
+ \code{RcppResultSet}.
}
-\author{Dominick Samperi wrote most of Rcpp during 2005 and 2006. Dirk
- Eddelbuettel made some additions, and became maintainer in 2008.}
+\author{Dominick Samperi wrote the initial versions of Rcpp (and
+ RcppTemplate) during 2005 and 2006. Dirk Eddelbuettel made some
+ additions, and became maintainer in 2008. Dirk Eddelbuettel and Romain
+ Francois have been extending Rcpp since 2009.
+}
\examples{
# set up date and datetime vectors
Modified: pkg/RcppExamples/man/RcppExample.Rd
===================================================================
--- pkg/RcppExamples/man/RcppExample.Rd 2010-02-19 16:21:02 UTC (rev 751)
+++ pkg/RcppExamples/man/RcppExample.Rd 2010-02-20 17:51:31 UTC (rev 752)
@@ -38,10 +38,6 @@
what gets printed when a variable assigned the return value is entered
on a line by itself. It is defined to simply list the names of the
fields returned (see RcppExample.R).
-
- The source files for this
- example and for the \code{Rcpp} class library
- can be found in the RcppTemplate package source archive (the .tar.gz file).
}
\value{
\code{RcppExample} returns a list containing:
@@ -59,18 +55,13 @@
\item{InputDF}{a data frame passed in from R}
\item{PreDF}{a data frame created on C++ side to be passed back to R}
\item{params}{input parameter list (this is redundant because we returned the input parameters above)}
- }
-
-\author{Dominick Samperi wrote most of Rcpp during 2005 and 2006. Dirk
- Eddelbuettel made some additions, and became maintainer in 2008.}
-
+}
+\author{Dominick Samperi wrote the initial versions of Rcpp (and
+ RcppTemplate) during 2005 and 2006. Dirk Eddelbuettel made some
+ additions, and became maintainer in 2008. Dirk Eddelbuettel and Romain
+ Francois have been extending Rcpp since 2009.
+}
\references{
- Samperi, D., (2006) \emph{Rcpp: R/C++ Interface Classes:
- Using C++ Libraries from R},
- available as a package vignette, or in the \code{RcppTemplate}
- package \code{doc} subdirectory
- (\code{RcppAPI.pdf}).
-
\emph{Writing R Extensions}, available at \url{http:www.r-project.org}.
}
\examples{
Modified: pkg/RcppExamples/man/RcppParams.Rd
===================================================================
--- pkg/RcppExamples/man/RcppParams.Rd 2010-02-19 16:21:02 UTC (rev 751)
+++ pkg/RcppExamples/man/RcppParams.Rd 2010-02-20 17:51:31 UTC (rev 752)
@@ -63,14 +63,17 @@
\code{SEXP} object passed to the function contains a given set of
named object.
}
-%\references{
-% See \code{Rcpp.h} and the package vignette.
-%}
+\references{
+ \emph{Writing R Extensions}, available at \url{http:www.r-project.org}.
+}
\seealso{
- \code{RcppExample}, the vignette \dQuote{RcppAPI}.
+ \code{RcppExample}.
}
-\author{Dominick Samperi wrote most of Rcpp during 2005 and 2006. Dirk
- Eddelbuettel made some additions, and became maintainer in 2008.}
+\author{Dominick Samperi wrote the initial versions of Rcpp (and
+ RcppTemplate) during 2005 and 2006. Dirk Eddelbuettel made some
+ additions, and became maintainer in 2008. Dirk Eddelbuettel and Romain
+ Francois have been extending Rcpp since 2009.
+}
\examples{
# set up some value
Modified: pkg/RcppExamples/man/RcppResultSet.Rd
===================================================================
--- pkg/RcppExamples/man/RcppResultSet.Rd 2010-02-19 16:21:02 UTC (rev 751)
+++ pkg/RcppExamples/man/RcppResultSet.Rd 2010-02-20 17:51:31 UTC (rev 752)
@@ -33,7 +33,7 @@
%}
\details{
Usage of \code{RcppResultSet} from \code{C++} is fully defined in
- \code{Rcpp.h}. An example for returning data to \R at the end of a
+ \code{RcppResultSet.h}. An example for returning data to \R at the end of a
\code{.Call()} call follows.
At the C++ level, the corresponding code to assign these parameter to
@@ -80,10 +80,13 @@
% See \code{Rcpp.h} and the package vignette.
%}
\seealso{
- \code{RcppExample}, the vignette \dQuote{RcppAPI}.
+ \code{RcppExample}.
}
-\author{Dominick Samperi wrote most of Rcpp during 2005 and 2006. Dirk
- Eddelbuettel made some additions, and became maintainer in 2008.}
+\author{Dominick Samperi wrote the initial versions of Rcpp (and
+ RcppTemplate) during 2005 and 2006. Dirk Eddelbuettel made some
+ additions, and became maintainer in 2008. Dirk Eddelbuettel and Romain
+ Francois have been extending Rcpp since 2009.
+}
\examples{
# example from RcppDate
Modified: pkg/RcppExamples/man/RcppVector.Rd
===================================================================
--- pkg/RcppExamples/man/RcppVector.Rd 2010-02-19 16:21:02 UTC (rev 751)
+++ pkg/RcppExamples/man/RcppVector.Rd 2010-02-20 17:51:31 UTC (rev 752)
@@ -1,6 +1,8 @@
\name{RcppVector}
\alias{RcppVector}
\alias{RcppMatrix}
+\alias{RcppVectorView}
+\alias{RcppMatrixView}
\alias{RcppStringVector}
\alias{RcppVectorExample}
\title{C++ classes for receiving R object in C++}
@@ -12,6 +14,9 @@
The vector and matrix types are templated and can operate on \R types
\code{intger} and \code{numeric}.
+
+ The \code{RcppVectorView} and \code{RcppMatrixView} are slighly more
+ lightweight read-only variants.
Member functions are provided to query the dimension of the vector or
matrix object, convert it in a corresponding \code{C} representation,
@@ -28,7 +33,7 @@
\details{
Usage of \code{RcppVector}, \code{RcppMatrix} and
\code{RcppStringVector} in \code{C++} is fully defined in
- \code{Rcpp.h}.
+ the respective header files.
As example, consider a call from \R to \code{C++} such as
@@ -76,10 +81,13 @@
% See \code{Rcpp.h} and the package vignette.
%}
\seealso{
- \code{RcppExample}, the vignette \dQuote{RcppAPI}.
+ \code{RcppExample}.
}
-\author{Dominick Samperi wrote most of Rcpp during 2005 and 2006. Dirk
- Eddelbuettel made some additions, and became maintainer in 2008.}
+\author{Dominick Samperi wrote the initial versions of Rcpp (and
+ RcppTemplate) during 2005 and 2006. Dirk Eddelbuettel made some
+ additions, and became maintainer in 2008. Dirk Eddelbuettel and Romain
+ Francois have been extending Rcpp since 2009.
+}
\examples{
# set up some value
vector <- (seq(1,9))^2
More information about the Rcpp-commits
mailing list