Adds size attribute aliases for DataFrame (closes #630)

Author: coatless

ChangeLog

@@ -1,3 +1,9 @@
+2017-01-21  James J Balamuta  <[email protected]>
+
+        * inst/include/Rcpp/DataFrame.h: Added alias for column and row size
+        * inst/unitTests/runit.DataFrame.R: Added unit tests for aliases
+        * inst/unitTests/cpp/DataFrame.cpp: Idem
+
 2017-01-17  Dirk Eddelbuettel  <[email protected]>
 
         * DESCRIPTION (Version, Date): Roll minor version and Date

inst/NEWS.Rd

@@ -3,6 +3,16 @@
 \newcommand{\ghpr}{\href{https://github.com/RcppCore/Rcpp/pull/#1}{##1}}
 \newcommand{\ghit}{\href{https://github.com/RcppCore/Rcpp/issues/#1}{##1}}
 
+\section{Changes in Rcpp version 0.13.0 (2017-03-xx)}{
+  \itemize{
+    \item Changes in Rcpp API:
+    \itemize{
+      \item Added new size attribute aliases for number of rows and columns in
+      DataFrame (James Balamuta in \ghpr{638} addressing \ghit{630}).
+    }
+  }
+}
+
 \section{Changes in Rcpp version 0.12.9 (2017-01-14)}{
   \itemize{
     \item Changes in Rcpp API:
@@ -20,9 +30,9 @@
     }
     \item Changes in Rcpp Sugar:
     \itemize{
-      \item Added new Sugar function \code{sample()} (Nathan Russell in 
+      \item Added new Sugar function \code{sample()} (Nathan Russell in
       \ghpr{610} and \ghpr{616}).
-      \item Added new Sugar function \code{Arg()} (James Balamuta in 
+      \item Added new Sugar function \code{Arg()} (James Balamuta in
       \ghpr{626} addressing \ghit{625}).
     }
     \item Changes in Rcpp unit tests
@@ -53,8 +63,8 @@
     \itemize{
       \item String and vector elements now use extended \code{R_xlen_t} indices
       (Qiang in PR \ghpr{560})
-      \item Hashing functions now return unsigned int (Qiang in PR \ghpr{561}) 
-      \item Added static methods \code{eye()}, \code{ones()}, and \code{zeros()} 
+      \item Hashing functions now return unsigned int (Qiang in PR \ghpr{561})
+      \item Added static methods \code{eye()}, \code{ones()}, and \code{zeros()}
       for select matrix types (Nathan Russell in PR \ghpr{569})
       \item The exception call stack is again correctly reported; print methods
       and tests added too (Jim Hester in PR \ghpr{582} fixing \ghit{579})
@@ -66,7 +76,7 @@
     \item Changes in Rcpp Sugar:
     \itemize{
       \item Added new Sugar functions \code{rowSums()}, \code{colSums()},
-      \code{rowMeans()}, \code{colMeans()} (PR \ghpr{551} by Nathan Russell 
+      \code{rowMeans()}, \code{colMeans()} (PR \ghpr{551} by Nathan Russell
       fixing \ghit{549})
       \item \code{Range} Sugar now used \code{R_xlen_t} type for start/end
       (PR \ghpr{568} by Qiang Kou)
@@ -96,7 +106,7 @@
       can activated. We intend to make the new classes the default no sooner
       than twelve months from this release.
       \item The \code{capabilities()} function can also be used for presence of
-      this feature 
+      this feature
     }
   }
 }
@@ -106,16 +116,16 @@
     \item Changes in Rcpp API:
     \itemize{
       \item The \code{NORET} macro is now defined if it was not already defined
-      by R itself (Kevin fixing issue \ghit{512}). 
+      by R itself (Kevin fixing issue \ghit{512}).
       \item Environment functions get() & find() now accept a Symbol
       (James Balamuta in \ghpr{513} addressing issue \ghit{326}).
       \item Several uses of \code{Rf_eval} were replaced by the preferred
       \code{Rcpp::Rcpp_eval} (Qiang in PR \ghpr{523} closing \ghit{498}).
       \item Improved Autogeneration Warning for RcppExports
       (James Balamuta in \ghpr{528} addressing issue \ghit{526}).
-      \item Fixed invalid C++ prefix identifiers in auto-generated code 
+      \item Fixed invalid C++ prefix identifiers in auto-generated code
       (James Balamuta in \ghpr{528} and \ghpr{531} addressing issue
-      \ghit{387}; Simon Dirmeier in \ghpr{548}). 
+      \ghit{387}; Simon Dirmeier in \ghpr{548}).
       \item String constructors now set default UTF-8 encoding (Qiang Kou in
       \ghpr{529} fixing \ghit{263}).
       \item Add variadic variants of the \code{RCPP_RETURN_VECTOR} and
@@ -130,15 +140,15 @@
     }
     \item Changes in Rcpp unit tests
     \itemize{
-      \item New unit tests for random number generators the R namespace which 
-      call the standalone Rmath library. (James Balamuta in \ghpr{514} 
+      \item New unit tests for random number generators the R namespace which
+      call the standalone Rmath library. (James Balamuta in \ghpr{514}
       addressing issue \ghit{28}).
     }
     \item Changes in Rcpp Examples:
     \itemize{
       \item Examples that used cxxfunction() from the inline package have been
-      rewritten to use either sourceCpp() or cppFunction() 
-      (James Balamuta in \ghpr{541}, \ghpr{535}, \ghpr{534}, and \ghpr{532} 
+      rewritten to use either sourceCpp() or cppFunction()
+      (James Balamuta in \ghpr{541}, \ghpr{535}, \ghpr{534}, and \ghpr{532}
       addressing issue \ghit{56}).
     }
   }
@@ -156,9 +166,9 @@
       \item String replacement was corrected (Qiang in \ghpr{479} following
       mailing list bug report by Masaki Tsuda)
       \item Allow for UTF-8 encoding in error messages via
-      \code{RCPP_USING_UTF8_ERROR_STRING} macro (Qin Wenfeng in \ghpr{493}) 
+      \code{RCPP_USING_UTF8_ERROR_STRING} macro (Qin Wenfeng in \ghpr{493})
       \item The R function \code{Rf_warningcall} is now provided as well (as
-      usual without leading \code{Rf_}) (\ghpr{497} fixing \ghit{495}) 
+      usual without leading \code{Rf_}) (\ghpr{497} fixing \ghit{495})
     }
     \item Changes in Rcpp Sugar:
     \itemize{
@@ -175,7 +185,7 @@
     }
     \item Changes in Rcpp Attributes:
     \itemize{
-      \item Add \code{cacheDir} argument to \code{sourceCpp()} to enable caching of 
+      \item Add \code{cacheDir} argument to \code{sourceCpp()} to enable caching of
         shared libraries across R sessions (JJ in \ghpr{504}).
       \item Code generation now deals correctly which packages containing a dot
       in their name (Qiang in \ghpr{501} fixing \ghit{500}).
@@ -194,7 +204,7 @@
     }
   }
 }
-      
+
 \section{Changes in Rcpp version 0.12.5 (2016-05-14)}{
   \itemize{
     \item Changes in Rcpp API:
@@ -207,7 +217,7 @@
     \item Changes in Rcpp Attributes:
     \itemize{
       \item R 3.3.0 Windows with Rtools 3.3 is now supported (Qin Wenfeng in PR
-      \ghpr{451}). 
+      \ghpr{451}).
       \item Correct handling of dependent file paths on Windows (use winslash = "/").
     }
     \item Changes in Rcpp Modules:
@@ -227,7 +237,7 @@
     }
   }
 }
-      
+
 \section{Changes in Rcpp version 0.12.4 (2016-03-22)}{
   \itemize{
     \item Changes in Rcpp API:
@@ -276,13 +286,13 @@
       \ghpr{406} by Qiang fixing \ghit{365}).
       \item A missing \code{std::hash} function interface for
       \code{Rcpp::String} has been addded (PR \ghpr{408} by Qiang fixing
-      \ghit{84}). 
+      \ghit{84}).
     }
     \item Changes in Rcpp Attributes:
     \itemize{
       \item Avoid invalid function names when generating C++ interfaces (PR
       \ghpr{403} by JJ fixing \ghit{402}).
-      \item Insert additional space around \code{&} in function interface (PR 
+      \item Insert additional space around \code{&} in function interface (PR
       \ghpr{400} by Kazuki Fukui fixing \ghit{278}).
     }
     \item Changes in Rcpp Modules:
@@ -306,7 +316,7 @@
       by Florian)
       \item Before creating a single String object from a \code{SEXP}, ensure
       that it is from a vector of length one (PR \ghpr{376} by Dirk, fixing
-      \ghit{375}). 
+      \ghit{375}).
       \item No longer use \code{STRING_ELT} as a left-hand side, thanks to a
       heads-up by Luke Tierney (PR \ghpr{378} by Dirk, fixing \ghit{377}).
       \item Rcpp Module objects are now checked more carefully (PR \ghpr{381}
@@ -318,7 +328,7 @@
       \item \code{operator<<()} now always shows decimal points (PR \ghpr{396}
       by Dan)
       \item Matrix classes now have a \code{transpose()} function (PR \ghpr{397}
-      by Dirk fixing \ghit{383}) 
+      by Dirk fixing \ghit{383})
       \item \code{operator<<()} for complex types was added (PRs \ghpr{398} by
       Qiang and \ghpr{399} by Dirk, fixing \ghit{187})
     }
@@ -336,20 +346,20 @@
     \item Changes in Rcpp Documentation:
     \itemize{
       \item The \code{NEWS} file now links to GitHub issue tickets and pull
-      requests. 
+      requests.
       \item The \code{Rcpp.bib} file with bibliographic references was updated.
     }
   }
 }
-      
+
 \section{Changes in Rcpp version 0.12.1 (2015-09-10)}{
   \itemize{
     \item Changes in Rcpp API:
     \itemize{
-      \item Correct use of WIN32 instead of _WIN32 to please Windows 10 
+      \item Correct use of WIN32 instead of _WIN32 to please Windows 10
       \item Add an assignment operator to \code{DimNameProxy} (PR \ghpr{339} by Florian)
       \item Add vector and matrix accessors \code{.at()} with bounds checking
-      (PR \ghpr{342} by Florian) 
+      (PR \ghpr{342} by Florian)
       \item Correct character vector conversion from single char (PR \ghpr{344} by
       Florian fixing issue \ghit{343})
       \item Correct on use of \code{R_xlen_t} back to \code{size_t} (PR \ghpr{348} by
@@ -397,13 +407,13 @@
       R expressions; this should resolve errors where calling handlers (e.g.
       through \code{suppressMessages()}) were not properly respected.
       \item All internal length variables have been changed from \code{R_len_t}
-      to \code{R_xlen_t} to support vectors longer than 2^31-1 elements (via 
+      to \code{R_xlen_t} to support vectors longer than 2^31-1 elements (via
       PR \ghpr{303} by Qiang Kou).
       \item The sugar function \code{sapply} now supports lambda functions
       (addressing \ghit{213} thanks to Matt Dziubinski)
       \item The \code{var} sugar function now uses a more robust two-pass
       method, supports complex numbers, with new unit tests added (via PR
-      \ghpr{320} by Matt Dziubinski) 
+      \ghpr{320} by Matt Dziubinski)
       \item \code{String} constructors now allow encodings (via PR \ghpr{310}
       by Qiang Kou)
       \item \code{String} objects are preserving the underlying \code{SEXP}
@@ -412,7 +422,7 @@
       \item DataFrame constructors are now a little more careful (via PR
       \ghpr{301} by Romain Francois)
       \item For R 3.2.0 or newer, \code{Rf_installChar()} is used instead of
-      \code{Rf_install(CHAR())} (via PR \ghpr{332}). 
+      \code{Rf_install(CHAR())} (via PR \ghpr{332}).
     }
     \item Changes in Rcpp Attributes:
     \itemize{
@@ -444,7 +454,7 @@
       matrices (via a pull request by Dmitrii Meleshko).
       \item A new \code{empty()} string constructor was added (via another pull
       request).
-      \item Better support for Vectors with a storage policy different from the 
+      \item Better support for Vectors with a storage policy different from the
       default, i.e. \code{NoProtectStorage}, was added.
     }
     \item Changes in Rcpp Attributes:
@@ -469,16 +479,16 @@
       \item The \code{Rcpp::Environment} constructor can now use a supplied
       parent environment.
       \item The \code{Rcpp::Function} constructor can now use a supplied
-      environment or namespace. 
+      environment or namespace.
       \item The \code{attributes_hidden} macro from R is used to shield internal
       functions; the \code{R_ext/Visibility.h} header is now included as well.
-      \item A \code{Rcpp::print} function was added as a wrapper around \code{Rf_PrintValue}. 
+      \item A \code{Rcpp::print} function was added as a wrapper around \code{Rf_PrintValue}.
     }
     \item Changes in Rcpp Attributes:
     \itemize{
       \item The \code{pkg_types.h} file is now included in \code{RcppExports.cpp}
-      if it is present in either the \code{inst/include} or \code{src}. 
-      \item \code{sourceCpp} was modified to allow includes of local files 
+      if it is present in either the \code{inst/include} or \code{src}.
+      \item \code{sourceCpp} was modified to allow includes of local files
       (e.g. \code{#include "foo.hpp"}). Implementation files (*.cc; *.cpp) corresponding
       to local includes are also automatically built if they exist.
       \item The generated attributes code was simplified with respect to

inst/include/Rcpp/DataFrame.h

@@ -66,7 +66,7 @@ namespace Rcpp{
         // getAttrib(df, R_RowNamesSymbol) will force an expansion of that
         // compact form thereby allocating a huge vector when we just want
         // the row.names. Hence this workaround.
-        inline int nrows() const {
+        inline int nrow() const {
             SEXP rn = R_NilValue ;
             SEXP att = ATTRIB( Parent::get__() )  ;
             while( att != R_NilValue ){
@@ -83,6 +83,26 @@ namespace Rcpp{
             return LENGTH(rn);
         }
 
+        // Leave in place for a year
+        // before making defunct
+        inline int nrows() const {
+            return DataFrame_Impl::nrow();
+        }
+
+        // Adds size attribute accessors that mimic
+        // those available in R and the Matrix class
+        inline int rows() const {
+            return DataFrame_Impl::nrow();
+        }
+
+        inline int ncol() const {
+            return DataFrame_Impl::length();
+        }
+
+        inline int cols() const {
+            return DataFrame_Impl::length();
+        }
+
         static DataFrame_Impl create(){
             return DataFrame_Impl() ;
         }

inst/unitTests/cpp/DataFrame.cpp

@@ -85,7 +85,12 @@ DataFrame createTwoStringsAsFactors(){
 }
 
 // [[Rcpp::export]]
-int DataFrame_nrows( DataFrame df){
-    return df.nrows() ;
+IntegerVector DataFrame_nrow( DataFrame df){
+    return IntegerVector::create(df.nrow(), df.rows()) ;
 }
 
+
+// [[Rcpp::export]]
+IntegerVector DataFrame_ncol( DataFrame df){
+    return IntegerVector::create(df.ncol(), df.cols());
+}

inst/unitTests/runit.DataFrame.R

@@ -76,9 +76,14 @@ if (.runThisTest) {
         checkEquals( createTwoStringsAsFactors(), DF, msg = "DataFrame create2 stringsAsFactors = false")
     }
 
-    test.DataFrame.nrows <- function(){
+    test.DataFrame.nrow <- function(){
         df <- data.frame( x = 1:10, y = 1:10 )
-        checkEquals( DataFrame_nrows( df ), nrow(df) )
+        checkEquals( DataFrame_nrow( df ), rep(nrow(df), 2) )
+    }
+
+    test.DataFrame.ncol <- function(){
+        df <- data.frame( x = 1:10, y = 1:10 )
+        checkEquals( DataFrame_ncol( df ), rep(ncol(df), 2) )
     }