[Rcpp-commits] r3410 - in pkg/RcppArmadillo: . inst man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Wed Dec 14 01:40:32 CET 2011
Author: edd
Date: 2011-12-14 01:40:31 +0100 (Wed, 14 Dec 2011)
New Revision: 3410
Modified:
pkg/RcppArmadillo/ChangeLog
pkg/RcppArmadillo/inst/NEWS
pkg/RcppArmadillo/man/RcppArmadillo-package.Rd
Log:
update RcppArmadillo-package manual page
Modified: pkg/RcppArmadillo/ChangeLog
===================================================================
--- pkg/RcppArmadillo/ChangeLog 2011-12-12 22:56:37 UTC (rev 3409)
+++ pkg/RcppArmadillo/ChangeLog 2011-12-14 00:40:31 UTC (rev 3410)
@@ -1,3 +1,8 @@
+2011-12-13 Dirk Eddelbuettel <edd at debian.org>
+
+ * man/RcppArmadillo-package.Rd: Updated to current version number,
+ added Conrad's Technical Report as a reference
+
2011-12-12 Dirk Eddelbuettel <edd at debian.org>
* DESCRIPTION: Release 0.2.34
Modified: pkg/RcppArmadillo/inst/NEWS
===================================================================
--- pkg/RcppArmadillo/inst/NEWS 2011-12-12 22:56:37 UTC (rev 3409)
+++ pkg/RcppArmadillo/inst/NEWS 2011-12-14 00:40:31 UTC (rev 3410)
@@ -1,4 +1,4 @@
-0.2.33 2011-12-12
+0.2.34 2011-12-12
o Upgraded to Armadillo release 2.4.2
Modified: pkg/RcppArmadillo/man/RcppArmadillo-package.Rd
===================================================================
--- pkg/RcppArmadillo/man/RcppArmadillo-package.Rd 2011-12-12 22:56:37 UTC (rev 3409)
+++ pkg/RcppArmadillo/man/RcppArmadillo-package.Rd 2011-12-14 00:40:31 UTC (rev 3410)
@@ -4,21 +4,21 @@
\alias{RcppArmadilloExample}
\docType{package}
\title{
-Rcpp/Armadillo bridge
+ Rcpp/Armadillo bridge
}
\description{
-The package eases the integration of Armadillo types with Rcpp
+ The package eases the integration of Armadillo types with Rcpp
}
\details{
-\tabular{ll}{
-Package: \tab RcppArmadillo\cr
-Type: \tab Package\cr
-Version: \tab 0.2.2\cr
-Date: \tab 2010-06-09\cr
-License: \tab GPL (>= 2)\cr
-LazyLoad: \tab yes\cr
+ \tabular{ll}{
+ Package: \tab RcppArmadillo\cr
+ Type: \tab Package\cr
+ Version: \tab 0.2.34\cr
+ Date: \tab 2011-12-12\cr
+ License: \tab GPL (>= 2)\cr
+ LazyLoad: \tab yes\cr
+ }
}
-}
\section{Armadillo}{
\code{Armadillo} is a C++ linear algebra library (matrix maths) aiming towards a good
balance between speed and ease of use. Integer, floating point and complex numbers
@@ -40,76 +40,84 @@
}
\section{RcppArmadillo}{
-\code{RcppArmadillo} acts as a bridge between \code{Rcpp} and \code{Armadillo},
-allowing the programmer to write code using armadillo classes that integrate
-seemlessly with \code{Rcpp}.
+ \code{RcppArmadillo} acts as a bridge between \code{Rcpp} and \code{Armadillo},
+ allowing the programmer to write code using armadillo classes that integrate
+ seemlessly with \code{Rcpp}.
}
\section{Using RcppArmadillo}{
-The simplest way to get started is to create a skeleton of a package
-using \code{RcppArmadillo}, this is done by the \code{\link{RcppArmadillo.package.skeleton}}
-function.
+ The simplest way to get started is to create a skeleton of a package
+ using \code{RcppArmadillo}, this is done by the \code{\link{RcppArmadillo.package.skeleton}}
+ function.
-The important steps are
-\itemize{
- \item Include the \code{RcppArmadillo.h} header file, which also includes
- armadillo.h
- \item Depend and link to Rcpp and RcppArmadillo by adding these lines to
- the DESCRIPTION file:
+ The important steps are
+ \itemize{
+ \item Include the \code{RcppArmadillo.h} header file, which also includes
+ armadillo.h
+ \item Depend and link to Rcpp and RcppArmadillo by adding these lines to
+ the DESCRIPTION file:
- \preformatted{
- Depends: Rcpp (>= 0.8.0), RcppArmadillo (>= 0.2.0)
- LinkingTo: Rcpp, RcppArmadillo
- }
+ \preformatted{
+ Depends: Rcpp (>= 0.8.0), RcppArmadillo (>= 0.2.0)
+ LinkingTo: Rcpp, RcppArmadillo
+ }
- \item Link against the Rcpp, blas and lapack libraries, by adding this line
- in the Makevars
+ \item Link against the Rcpp, blas and lapack libraries, by adding this line
+ in the Makevars
-\preformatted{PKG_LIBS = $(shell $(R_HOME)/bin/Rscript -e "Rcpp:::LdFlags()" ) $(LAPACK_LIBS) $(BLAS_LIBS) $(FLIBS) }
+ \preformatted{PKG_LIBS = $(shell $(R_HOME)/bin/Rscript -e "Rcpp:::LdFlags()" ) $(LAPACK_LIBS) $(BLAS_LIBS) $(FLIBS) }
-and this line to the Makevars.win:
-\preformatted{PKG_LIBS = $(shell $(R_HOME)/bin${R_ARCH_BIN}/Rscript.exe -e "Rcpp:::LdFlags()") $(LAPACK_LIBS) $(BLAS_LIBS) $(FLIBS) }
+ and this line to the Makevars.win:
+ \preformatted{PKG_LIBS = $(shell $(R_HOME)/bin${R_ARCH_BIN}/Rscript.exe -e "Rcpp:::LdFlags()") $(LAPACK_LIBS) $(BLAS_LIBS) $(FLIBS) }
+ }
}
-}
\section{Options: ATLAS and Boost}{
-Armadillo can optionally use atlas and boost. Please refer to the
-Armadillo documentation \url{http://arma.sourceforge.net/}
+ Armadillo can optionally use atlas and boost. Please refer to the
+ Armadillo documentation \url{http://arma.sourceforge.net/}
-\code{RcppArmadillo} does not force these features. it is up to the third party package
-to enable these them for their package. If your package wants to make use of
-these features, you can add a subset of
-these lines before \code{#include <RcppArmadillo.h>}
+ \code{RcppArmadillo} does not force these features. it is up to the third party package
+ to enable these them for their package. If your package wants to make use of
+ these features, you can add a subset of
+ these lines before \code{#include <RcppArmadillo.h>}
+
+ \preformatted{
+ #define ARMA_USE_BOOST
+ #define ARMA_USE_BOOST_DATE
+ #define ARMA_USE_ATLAS
+ }
-\preformatted{
-#define ARMA_USE_BOOST
-#define ARMA_USE_BOOST_DATE
-#define ARMA_USE_ATLAS
-}
-
-when you do so, you must make sure that the corresponding features are
-available, which typically involves writing a configure file. Refer to
-Writing R Extensions for the procedure.
+ when you do so, you must make sure that the corresponding features are
+ available, which typically involves writing a configure file. Refer to
+ Writing R Extensions for the procedure.
}
\section{Support}{
-Please use the Rcpp-devel mailing list on r-forge
-for questions about RcppArmadillo (subscribe first).
-\url{https://lists.r-forge.r-project.org/cgi-bin/mailman/listinfo/rcpp-devel}
-
-Questions about armadillo itself should be directed to the armadillo forum
-\url{http://sourceforge.net/apps/phpbb/arma/}
+ Please use the Rcpp-devel mailing list on r-forge
+ for questions about RcppArmadillo (subscribe first).
+ \url{https://lists.r-forge.r-project.org/cgi-bin/mailman/listinfo/rcpp-devel}
+
+ Questions about armadillo itself should be directed to the armadillo forum
+ \url{http://sourceforge.net/apps/phpbb/arma/}
}
\author{
-Romain Francois, Dirk Eddelbuettel and Doug Bates
+ For RcppArmadillo: Romain Francois, Dirk Eddelbuettel and Doug Bates
-Maintainer: Romain, Dirk and Doug <RcppArmadillo-authors at r-enthusiasts.com>
+ Maintainer: Romain, Dirk and Doug <RcppArmadillo-authors at r-enthusiasts.com>
+
+ For Armadillo: Conrad Sanderson
}
\references{
-Armadillo project: \url{http://arma.sourceforge.net/}
+ Armadillo project: \url{http://arma.sourceforge.net/}
+
+ Conrad Sanderson,
+ \href{http://arma.sourceforge.net/armadillo_nicta_2010.pdf}{Armadillo:
+ An Open Source C++ Linear Algebra Library
+ for Fast Prototyping and Computationally Intensive
+ Experiments}. Technical Report, NICTA, 2010.
}
\keyword{ package }
\keyword{ programming }
More information about the Rcpp-commits
mailing list