File: CppFunction-class.Rd

package info (click to toggle)
rcpp 1.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 7,480 kB
  • sloc: cpp: 27,436; ansic: 7,778; sh: 53; makefile: 2
file content (36 lines) | stat: -rw-r--r-- 1,028 bytes parent folder | download | duplicates (9)
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
32
33
34
35
36
\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}
    \item{\code{docstring}:}{Short documentation for the function}
    \item{\code{signature}:}{C++ signature}
  }
}
\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}