[Rcpp-commits] r2132 - in pkg/Rcpp: . R man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Fri Sep 17 14:15:43 CEST 2010
Author: romain
Date: 2010-09-17 14:15:43 +0200 (Fri, 17 Sep 2010)
New Revision: 2132
Added:
pkg/Rcpp/man/CppClassRepresentation-class.Rd
pkg/Rcpp/man/CppFunction-class.Rd
pkg/Rcpp/man/CppMethod-class.Rd
Removed:
pkg/Rcpp/man/CppFunction.Rd
pkg/Rcpp/man/CppReferenceMethods.Rd
Modified:
pkg/Rcpp/NAMESPACE
pkg/Rcpp/R/00_classes.R
pkg/Rcpp/man/CppClass-class.Rd
pkg/Rcpp/man/CppField-class.Rd
Log:
making R CMD check happier
Modified: pkg/Rcpp/NAMESPACE
===================================================================
--- pkg/Rcpp/NAMESPACE 2010-09-17 11:44:28 UTC (rev 2131)
+++ pkg/Rcpp/NAMESPACE 2010-09-17 12:15:43 UTC (rev 2132)
@@ -4,11 +4,14 @@
importFrom( utils, capture.output, assignInNamespace, .DollarNames, prompt, packageDescription )
exportClasses( Module, "C++Field", "C++Method", "C++Class", "C++Object", "C++Function",
- "C++Property", "C++ClassRepresentation" )
+ "C++ClassRepresentation" # , "C++Property"
+ )
S3method( .DollarNames, "C++Object" )
S3method( .DollarNames, "Module" )
exportMethods( prompt, show, .DollarNames, referenceMethods )
-export( Module, setRCppClass, Rcpp.package.skeleton )
+export(
+ Module, Rcpp.package.skeleton # , setRCppClass
+)
Modified: pkg/Rcpp/R/00_classes.R
===================================================================
--- pkg/Rcpp/R/00_classes.R 2010-09-17 11:44:28 UTC (rev 2131)
+++ pkg/Rcpp/R/00_classes.R 2010-09-17 12:15:43 UTC (rev 2132)
@@ -72,8 +72,8 @@
),
contains = "classRepresentation" )
-# might not actually use this
-setClass( "C++Property" )
+# # might not actually use this
+# setClass( "C++Property" )
setClass( "C++Object",
representation(
Modified: pkg/Rcpp/man/CppClass-class.Rd
===================================================================
--- pkg/Rcpp/man/CppClass-class.Rd 2010-09-17 11:44:28 UTC (rev 2131)
+++ pkg/Rcpp/man/CppClass-class.Rd 2010-09-17 12:15:43 UTC (rev 2132)
@@ -2,7 +2,7 @@
\Rdversion{1.1}
\docType{class}
\alias{C++Class-class}
-\alias{new,C++Class-method}
+\alias{$,C++Class-method}
\alias{show,C++Class-method}
\title{Reflection information for an internal c++ class}
@@ -19,15 +19,13 @@
\item{\code{pointer}:}{external pointer to the internal infomation}
\item{\code{module}:}{external pointer to the module}
\item{\code{fields}:}{list of \linkS4class{C++Field} objects}
+ \item{\code{methods}:}{list of \linkS4class{C++Method} objects}
}
}
\section{Methods}{
\describe{
- \item{new}{\code{signature(Class = "C++Class")}: creates a new object
- of this class using its default constructor. This creates
- instances of the class \linkS4class{C++Object}
- }
\item{show}{\code{signature(object = "C++Class")}: prints the class. }
+ \item{$}{\code{signature(object = "C++Class")}: ... }
}
}
\keyword{classes}
Added: pkg/Rcpp/man/CppClassRepresentation-class.Rd
===================================================================
--- pkg/Rcpp/man/CppClassRepresentation-class.Rd (rev 0)
+++ pkg/Rcpp/man/CppClassRepresentation-class.Rd 2010-09-17 12:15:43 UTC (rev 2132)
@@ -0,0 +1,39 @@
+\name{C++ClassRepresentation-class}
+\Rdversion{1.1}
+\docType{class}
+\alias{C++ClassRepresentation-class}
+\alias{referenceMethods,C++ClassRepresentation-method}
+
+\title{Class "C++ClassRepresentation"}
+\description{Representation of a C++ class}
+\section{Slots}{
+ \describe{
+ \item{\code{pointer}:}{Object of class \code{"externalptr"} ~~ }
+ \item{\code{generator}:}{Object of class \code{"refObjectGenerator"} ~~ }
+ \item{\code{cpp_fields}:}{Object of class \code{"list"} ~~ }
+ \item{\code{cpp_methods}:}{Object of class \code{"list"} ~~ }
+ \item{\code{slots}:}{Object of class \code{"list"} ~~ }
+ \item{\code{contains}:}{Object of class \code{"list"} ~~ }
+ \item{\code{virtual}:}{Object of class \code{"logical"} ~~ }
+ \item{\code{prototype}:}{Object of class \code{"ANY"} ~~ }
+ \item{\code{validity}:}{Object of class \code{"OptionalFunction"} ~~ }
+ \item{\code{access}:}{Object of class \code{"list"} ~~ }
+ \item{\code{className}:}{Object of class \code{"character"} ~~ }
+ \item{\code{package}:}{Object of class \code{"character"} ~~ }
+ \item{\code{subclasses}:}{Object of class \code{"list"} ~~ }
+ \item{\code{versionKey}:}{Object of class \code{"externalptr"} ~~ }
+ \item{\code{sealed}:}{Object of class \code{"logical"} ~~ }
+ }
+}
+\section{Extends}{
+Class \code{"\linkS4class{classRepresentation}"}, directly.
+}
+\section{Methods}{
+ \describe{
+ \item{referenceMethods}{\code{signature(classDef = "C++ClassRepresentation")}: ... }
+ }
+}
+\examples{
+showClass("C++ClassRepresentation")
+}
+\keyword{classes}
Modified: pkg/Rcpp/man/CppField-class.Rd
===================================================================
--- pkg/Rcpp/man/CppField-class.Rd 2010-09-17 11:44:28 UTC (rev 2131)
+++ pkg/Rcpp/man/CppField-class.Rd 2010-09-17 12:15:43 UTC (rev 2132)
@@ -7,11 +7,12 @@
\description{
Metadata associated with a field of a class exposed through Rcpp modules
}
-\section{Slots}{
+\section{Fields}{
\describe{
\item{\code{pointer}:}{external pointer to the internal (C++) object that represents fields}
\item{\code{cpp_class}:}{(demangled) name of the C++ class of the field}
\item{\code{read_only}:}{Is this field read only}
+ \item{\code{class_pointer}:}{external pointer to the class this field is from. }
}
}
\section{Methods}{
Copied: pkg/Rcpp/man/CppFunction-class.Rd (from rev 2121, pkg/Rcpp/man/CppFunction.Rd)
===================================================================
--- pkg/Rcpp/man/CppFunction-class.Rd (rev 0)
+++ pkg/Rcpp/man/CppFunction-class.Rd 2010-09-17 12:15:43 UTC (rev 2132)
@@ -0,0 +1,34 @@
+\name{C++Function-class}
+\Rdversion{1.1}
+\docType{class}
+\alias{C++Function-class}
+\alias{show,C++Function-method}
+
+\title{Class "C++Function"}
+\description{
+Internal C++ function
+}
+\section{Objects from the Class}{
+ Objects can be created by the \code{Rcpp::InternalFunction}
+ class from the \code{Rcpp} library
+}
+\section{Slots}{
+ \describe{
+ \item{\code{.Data}:}{R function that calls back to the internal function}
+ \item{\code{pointer}:}{External pointer to a C++ object poiting to the function}
+ }
+}
+\section{Extends}{
+Class \code{"\linkS4class{function}"}, from data part.
+Class \code{"\linkS4class{OptionalFunction}"}, by class "function", distance 2.
+Class \code{"\linkS4class{PossibleMethod}"}, by class "function", distance 2.
+}
+\section{Methods}{
+ \describe{
+ \item{show}{\code{signature(object = "C++Function")}: print the object }
+ }
+}
+\examples{
+showClass("C++Function")
+}
+\keyword{classes}
Deleted: pkg/Rcpp/man/CppFunction.Rd
===================================================================
--- pkg/Rcpp/man/CppFunction.Rd 2010-09-17 11:44:28 UTC (rev 2131)
+++ pkg/Rcpp/man/CppFunction.Rd 2010-09-17 12:15:43 UTC (rev 2132)
@@ -1,34 +0,0 @@
-\name{C++Function-class}
-\Rdversion{1.1}
-\docType{class}
-\alias{C++Function-class}
-\alias{show,C++Function-method}
-
-\title{Class "C++Function"}
-\description{
-Internal C++ function
-}
-\section{Objects from the Class}{
- Objects can be created by the \code{Rcpp::InternalFunction}
- class from the \code{Rcpp} library
-}
-\section{Slots}{
- \describe{
- \item{\code{.Data}:}{R function that calls back to the internal function}
- \item{\code{pointer}:}{External pointer to a C++ object poiting to the function}
- }
-}
-\section{Extends}{
-Class \code{"\linkS4class{function}"}, from data part.
-Class \code{"\linkS4class{OptionalFunction}"}, by class "function", distance 2.
-Class \code{"\linkS4class{PossibleMethod}"}, by class "function", distance 2.
-}
-\section{Methods}{
- \describe{
- \item{show}{\code{signature(object = "C++Function")}: print the object }
- }
-}
-\examples{
-showClass("C++Function")
-}
-\keyword{classes}
Added: pkg/Rcpp/man/CppMethod-class.Rd
===================================================================
--- pkg/Rcpp/man/CppMethod-class.Rd (rev 0)
+++ pkg/Rcpp/man/CppMethod-class.Rd 2010-09-17 12:15:43 UTC (rev 2132)
@@ -0,0 +1,27 @@
+\name{C++Method-class}
+\Rdversion{1.1}
+\docType{class}
+\alias{C++Method-class}
+
+\title{Class "C++Method"}
+\description{
+Metadata associated with a field of a class exposed through Rcpp modules
+}
+\section{Fields}{
+ \describe{
+ \item{\code{pointer}:}{external pointer to the internal (C++) object that represents the method}
+ \item{\code{class_pointer}:}{external pointer to the class this method is from. }
+ \item{\code{void}:}{\code{TRUE} if the method is void. }
+ }
+}
+\section{Methods}{
+No methods defined with class "C++Method" in the signature.
+}
+\seealso{
+ The \code{fields} slot of the \code{\linkS4class{C++Class}} class is a
+ list of \code{C++Method} objects
+}
+\examples{
+showClass("C++Method")
+}
+\keyword{classes}
Deleted: pkg/Rcpp/man/CppReferenceMethods.Rd
===================================================================
--- pkg/Rcpp/man/CppReferenceMethods.Rd 2010-09-17 11:44:28 UTC (rev 2131)
+++ pkg/Rcpp/man/CppReferenceMethods.Rd 2010-09-17 12:15:43 UTC (rev 2132)
@@ -1,17 +0,0 @@
-\name{referenceMethods-methods}
-\docType{methods}
-\alias{referenceMethods,C++Class-method}
-\title{generate reference methods proxies for C++ classes}
-\description{
- generate reference methods proxies for C++ classes exposed
- by Rcpp modules
-}
-\section{Methods}{
-\describe{
-
-\item{\code{signature(classDef = "C++Class")}}{
-generate reference methods proxies for C++ classes
-}
-}}
-\keyword{methods}
-
More information about the Rcpp-commits
mailing list