[Rcpp-commits] r531 - pkg/src

[noreply at r-forge.r-project.org]

Author: edd
Date: 2010-01-31 20:05:39 +0100 (Sun, 31 Jan 2010)
New Revision: 531

Added:
   pkg/src/RcppDoxygenExamples.h
Log:
'phony' file without C++ code that exists simple to define a few \example tags consumed by doxygen


Added: pkg/src/RcppDoxygenExamples.h
===================================================================
--- pkg/src/RcppDoxygenExamples.h	                        (rev 0)
+++ pkg/src/RcppDoxygenExamples.h	2010-01-31 19:05:39 UTC (rev 531)
@@ -0,0 +1,95 @@
+// -*- mode: C++; c-indent-level: 4; c-basic-offset: 4; tab-width: 8 -*-
+//
+// Rcpp.h: R/C++ interface class library
+//
+// Copyright (C) 2009 - 2010 Dirk Eddelbuettel and Romain Francois
+//
+// This file is part of Rcpp.
+//
+// Rcpp is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 2 of the License, or
+// (at your option) any later version.
+//
+// Rcpp is distributed in the hope that it will be useful, but
+// WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Rcpp.  If not, see <http://www.gnu.org/licenses/>.
+
+// This file is not used by any code but exists solely to group
+// example macros for Doxygen.
+//
+// Note that there is some serious brain-damagedness going on doxygen will only
+// include the examples if we do this:
+//
+//    cd src && ln -s ../inst/examples examples cd -
+//    doxygen doxyfile
+//    cd src && rm examples cd -
+//
+// ie without the softlink nothing happens, despite the recursive example path set
+// in doxyfile etc and numerous other attempts I made.
+
+
+//! \example functionCallback/RcppFunctionCallExample.cpp
+//! An example providing a class RVectorFuncCall derived from class RcppFunction which
+//! implements a vector-values function transformVector(); the class gets initialized 
+//! with an R function vecfunc passed along using Rcpp.
+
+//! \example functionCallback/ExampleRCode.R
+//! This files defines the R function vecfunc passed down to C++ and called via the 
+//! wrapper function built using the sub-class of RcppFunction to call it.
+
+
+
+//! \example RcppInline/external_pointer.r  
+//! A simple example (using inline) of external Pointer use via Rcpp::XPtr
+
+//! \example RcppInline/RcppInlineExample.r  
+//! The 'distribution of determinant' example as a demonstration of how to use
+//! inline and Rcpp for a simple function.
+
+//! \example RcppInline/RcppInlineWithLibsExamples.r  
+//! Four simple examples of how to combine Rcpp and an external library 
+//! (where we use the GNU GSL) using inline. 
+
+//! \example RcppInline/RcppSexpTests.r  
+//! A number of examples on how to use wrap() to automatically convert data types.
+
+//! \example RcppInline/RcppSimpleExample.r
+//! A very simple example of using inline without Rcpp.
+
+//! \example RcppInline/RcppSimpleTests.r  
+//! This file provides a few simple tests that preceded the creation of the 
+//! numerous formal unit tests that followed.
+
+//! \example RcppInline/UncaughtExceptions.r
+//! An example of how to catch C++ exceptions even without a try / catch block.
+
+
+
+
+//! \example ConvolveBenchmarks/convolve2_c.c
+//! The basic convolution example from Section 5.10.1 of 'Writing R Extensions'
+
+//! \example ConvolveBenchmarks/convolve2_cpp.c
+//! A simple version of the basic convolution example from Section 5.10.1 
+//! of 'Writing R Extensions', now rewritten for Rcpp using RcppVector<double>.
+
+//! \example ConvolveBenchmarks/convolve3_cpp.c
+//! A more efficient version of the basic convolution example from Section 5.10.1 
+//! of 'Writing R Extensions', now rewritten for Rcpp and using Rcpp::NumericVector.
+
+//! \example ConvolveBenchmarks/convolve4_cpp.c
+//! An even more efficient version of the basic convolution example from Section 5.10.1 
+//! of 'Writing R Extensions', now rewritten for Rcpp and using Rcpp::NumericVector as
+//! well as direct pointer operations for better performance.
+
+//! \example ConvolveBenchmarks/convolve7_c.c
+//! The basic convolution example from Section 5.10.1 of 'Writing R Extensions', written
+//! using REAL(x)[i] accessor macros to demonstrate the performance hit imposed by these.
+
+//! \example ConvolveBenchmarks/exampleRCode.r
+//! R file / littler script to run and time the various implementations.