Rcpp::CppFunction Class Reference

#include <CppFunction.h>

Inheritance diagram for Rcpp::CppFunction:

Collaboration diagram for Rcpp::CppFunction:

Public Member Functions
	CppFunction (const char *doc=0)
virtual	~CppFunction ()
virtual int	nargs ()
virtual bool	is_void ()
virtual void	signature (std::string &, const char *)
virtual SEXP	get_formals ()
virtual DL_FUNC	get_function_ptr ()=0
Public Member Functions inherited from Rcpp::CppFunctionBase
	CppFunctionBase ()
virtual	~CppFunctionBase ()
virtual SEXP	operator() (SEXP *)

Public Attributes
std::string	docstring

Detailed Description

base class of all exported C++ functions. Template deduction in the Module_generated_function.h file creates an instance of a class that derives CppFunction (see Module_generated_CppFunction.h for all the definitions

Definition at line 52 of file CppFunction.h.

Constructor & Destructor Documentation

CppFunction()

Rcpp::CppFunction::CppFunction ( const char *  doc = 0 )

inline

Definition at line 54 of file CppFunction.h.

~CppFunction()

virtual Rcpp::CppFunction::~CppFunction ( )

inlinevirtual

Definition at line 55 of file CppFunction.h.

Member Function Documentation

get_formals()

virtual SEXP Rcpp::CppFunction::get_formals ( )

inlinevirtual

formal arguments

Definition at line 75 of file CppFunction.h.

Referenced by Rcpp::Module::get_function().

get_function_ptr()

virtual DL_FUNC Rcpp::CppFunction::get_function_ptr ( )

pure virtual

The actual function pointer, as a catch all function pointer (see Rdynload.h for definition of DL_FUNC)

Referenced by Rcpp::Module::Add(), and Rcpp::Module::get_function_ptr().

is_void()

virtual bool Rcpp::CppFunction::is_void ( )

inlinevirtual

voidness

Definition at line 65 of file CppFunction.h.

Referenced by Rcpp::Module::get_function(), and Rcpp::Module::invoke().

nargs()

virtual int Rcpp::CppFunction::nargs ( )

inlinevirtual

The number of arguments of the function

Definition at line 60 of file CppFunction.h.

Referenced by Rcpp::Module::get_function(), and Rcpp::Module::invoke().

signature()

virtual void Rcpp::CppFunction::signature ( std::string &  , const char *    )

inlinevirtual

Human readable function signature (demangled if possible)

Definition at line 70 of file CppFunction.h.

Referenced by Rcpp::Module::get_function().

Member Data Documentation

docstring

std::string Rcpp::CppFunction::docstring

description of the function

Definition at line 86 of file CppFunction.h.

Referenced by Rcpp::Module::get_function().

---

The documentation for this class was generated from the following file:

• inst/include/Rcpp/module/CppFunction.h