[Rcpp-commits] r3759 - in pkg/RcppBDT: . man

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

Author: edd
Date: 2012-09-02 00:22:11 +0200 (Sun, 02 Sep 2012)
New Revision: 3759

Added:
   pkg/RcppBDT/man/bdtDu.Rd
   pkg/RcppBDT/man/bdtPt.Rd
   pkg/RcppBDT/man/bdtTz.Rd
Modified:
   pkg/RcppBDT/ChangeLog
   pkg/RcppBDT/man/bdt.Rd
Log:
added manual pages for new module classes


Modified: pkg/RcppBDT/ChangeLog
===================================================================
--- pkg/RcppBDT/ChangeLog	2012-09-01 21:39:01 UTC (rev 3758)
+++ pkg/RcppBDT/ChangeLog	2012-09-01 22:22:11 UTC (rev 3759)
@@ -7,6 +7,10 @@
 	simplified existing code by using them; and added new setter from the
 	R Datetime class as well
 
+	* man/bdtDu.Rd: Added
+	* man/bdtPt.Rd: Added
+	* man/bdtTz.Rd: Added
+
 2012-08-27  Dirk Eddelbuettel  <edd at debian.org>
 
 	* src/RcppBDTpt.cpp: getDatetime() now uses struct tm and mktime

Modified: pkg/RcppBDT/man/bdt.Rd
===================================================================
--- pkg/RcppBDT/man/bdt.Rd	2012-09-01 21:39:01 UTC (rev 3758)
+++ pkg/RcppBDT/man/bdt.Rd	2012-09-01 22:22:11 UTC (rev 3759)
@@ -9,11 +9,12 @@
 \title{Default object for RcppBDT Boost Date_Time binding}
 \description{
   The \verb{bdt} variable is a default instance of the 'date' class
-  created by means of Rcpp modules.
+  created by means of Rcpp modules. It facilities accessing the member
+  functions via utility function, see for example \code{\link{getEndOfBizWeek}}.
 
-  The \verb{bdtMod} variable is an instance of the class created by Rcpp
-  modules. It currently contains just the \code{date} class; see
-  \code{print(date)} for its available methods. 
+  The \verb{bdtDate} variable is an instance of the class created by Rcpp
+  modules. It contain just the \code{date} class from Boost Date_time; see
+  \code{print(bdtDate)} for the available methods. 
   
   New instances can be created using either the default constructor
   (without arguments) or the constructor using year, month, date arguments.

Added: pkg/RcppBDT/man/bdtDu.Rd
===================================================================
--- pkg/RcppBDT/man/bdtDu.Rd	                        (rev 0)
+++ pkg/RcppBDT/man/bdtDu.Rd	2012-09-01 22:22:11 UTC (rev 3759)
@@ -0,0 +1,23 @@
+\name{bdtDu}
+\alias{bdtDu}
+\alias{Rcpp_bdtDu-class}
+\docType{package}
+\title{Rcpp module bdtDu for binding of Boost Date_Time duration functionality}
+\description{
+  The \verb{bdtDu} module is created using Rcpp modules and wraps a
+  helper class \verb{bdtDu} around Boost Date_time duration
+  functionality provided by the Boost class \code{boost::posix_time::duration}.
+
+  New instances can be created using four integer values for hour,
+  minute, seconds and fractional seconds.  Fractional seconds ought to
+  be at a nano-second granularity; there may be platforms not permitting
+  this.
+}
+\details{
+  Please consult the Boost documentation for (copious) details on the
+  Date_Time library. See the Rcpp-modules vignette for details on Rcpp
+  modules. 
+}
+\author{Dirk Eddelbuettel \email{edd at debian.org}}
+\references{Boost Date_Time: \url{http://www.boost.org/doc/html/date_time.html}}
+\keyword{package}

Added: pkg/RcppBDT/man/bdtPt.Rd
===================================================================
--- pkg/RcppBDT/man/bdtPt.Rd	                        (rev 0)
+++ pkg/RcppBDT/man/bdtPt.Rd	2012-09-01 22:22:11 UTC (rev 3759)
@@ -0,0 +1,24 @@
+\name{bdtPt}
+\alias{bdtPt}
+\alias{Rcpp_bdtPt-class}
+\docType{package}
+\title{Rcpp module bdtPt for binding of Boost Date_Time ptime functionality}
+\description{
+  The \verb{bdtDu} module is created using Rcpp modules and wraps a
+  helper class \verb{bdtPt} around Boost Date_time duration
+  functionality provided by the Boost class \code{boost::posix_time::ptime}.
+
+  New instances can be created using either a default construction
+  (creating an unset instance) or using seven integer values for year,
+  month, day, hour, minute, seconds and fractional seconds.  Fractional
+  seconds ought to be at a nano-second granularity; there may be
+  platforms not permitting this.
+}
+\details{
+  Please consult the Boost documentation for (copious) details on the
+  Date_Time library. See the Rcpp-modules vignette for details on Rcpp
+  modules. 
+}
+\author{Dirk Eddelbuettel \email{edd at debian.org}}
+\references{Boost Date_Time: \url{http://www.boost.org/doc/html/date_time.html}}
+\keyword{package}

Added: pkg/RcppBDT/man/bdtTz.Rd
===================================================================
--- pkg/RcppBDT/man/bdtTz.Rd	                        (rev 0)
+++ pkg/RcppBDT/man/bdtTz.Rd	2012-09-01 22:22:11 UTC (rev 3759)
@@ -0,0 +1,36 @@
+\name{bdtTz}
+\alias{bdtTz}
+\alias{Rcpp_bdtTz-class}
+\alias{show,Rcpp_bdtTz-method}
+\alias{format,Rcpp_bdtTz-method}
+\docType{package}
+\title{Rcpp module bdtTz for binding of Boost Date_Time timezone functionality}
+\description{
+  The \verb{bdtTz} module is created using Rcpp modules and wraps a
+  helper class \verb{bdtTz} around Boost Date_time timezone
+  functionality provided mainly by the Boost classes
+  \code{boost::local_time::tz_database} and
+  \code{boost::local_time::time_zone_ptr}.
+
+  On startup, the database object is initialized using a local copy (in
+  csv format) of the timezone data.  Instances of the timezone object,
+  represented by an instance of the timezone pointer class, can be
+  created and queried.
+  
+  New instances can be created using a valid timezone region string
+  (such \dQuote{Europe/London}).
+}
+\section{Method}{
+  \describe{
+    \item{show}{\code{signature(x = "Rcpp_bdtTz")}: prints a (BDTtz) timezone class object}
+    \item{format}{\code{signature(x = "Rcpp_bdtTz")}: formats a (BDTtz) timezone class object}
+  }
+}
+\details{
+  Please consult the Boost documentation for (copious) details on the
+  Date_Time library. See the Rcpp-modules vignette for details on Rcpp
+  modules. 
+}
+\author{Dirk Eddelbuettel \email{edd at debian.org}}
+\references{Boost Date_Time: \url{http://www.boost.org/doc/html/date_time.html}}
+\keyword{package}