[Rcpp-commits] r1664 - in pkg/Rcpp/inst: doc/Rcpp-sugar include/Rcpp/sugar/functions unitTests

noreply at r-forge.r-project.org noreply at r-forge.r-project.org
Wed Jun 23 13:24:14 CEST 2010


Author: romain
Date: 2010-06-23 13:24:14 +0200 (Wed, 23 Jun 2010)
New Revision: 1664

Added:
   pkg/Rcpp/inst/include/Rcpp/sugar/functions/sign.h
   pkg/Rcpp/inst/unitTests/runit.sugar.sign.R
Modified:
   pkg/Rcpp/inst/doc/Rcpp-sugar/Rcpp-sugar.Rnw
   pkg/Rcpp/inst/include/Rcpp/sugar/functions/functions.h
Log:
new sugar function : sign

Modified: pkg/Rcpp/inst/doc/Rcpp-sugar/Rcpp-sugar.Rnw
===================================================================
--- pkg/Rcpp/inst/doc/Rcpp-sugar/Rcpp-sugar.Rnw	2010-06-23 10:32:35 UTC (rev 1663)
+++ pkg/Rcpp/inst/doc/Rcpp-sugar/Rcpp-sugar.Rnw	2010-06-23 11:24:14 UTC (rev 1664)
@@ -411,6 +411,19 @@
 \texttt{lapply} is similar to \texttt{sapply} except that the result is
 allways an list expression (an expression of type \texttt{VECSXP}. 
 
+\subsubsection{sign}
+
+Given a numeric or integer expression, \texttt{sign} expands to an expression
+whose values are one of 1, 0, -1 or \texttt{NA}, depending on the sign 
+of the input expression.
+
+<<lang=cpp>>=
+IntegerVector xx;
+
+sign( xx )
+sign( xx * xx )
+@
+
 \section{Performance}
 \label{sec:performance}
 

Modified: pkg/Rcpp/inst/include/Rcpp/sugar/functions/functions.h
===================================================================
--- pkg/Rcpp/inst/include/Rcpp/sugar/functions/functions.h	2010-06-23 10:32:35 UTC (rev 1663)
+++ pkg/Rcpp/inst/include/Rcpp/sugar/functions/functions.h	2010-06-23 11:24:14 UTC (rev 1664)
@@ -31,5 +31,6 @@
 #include <Rcpp/sugar/functions/ifelse.h>
 #include <Rcpp/sugar/functions/pmin.h>
 #include <Rcpp/sugar/functions/pmax.h>
+#include <Rcpp/sugar/functions/sign.h>
 
 #endif

Added: pkg/Rcpp/inst/include/Rcpp/sugar/functions/sign.h
===================================================================
--- pkg/Rcpp/inst/include/Rcpp/sugar/functions/sign.h	                        (rev 0)
+++ pkg/Rcpp/inst/include/Rcpp/sugar/functions/sign.h	2010-06-23 11:24:14 UTC (rev 1664)
@@ -0,0 +1,79 @@
+// -*- mode: C++; c-indent-level: 4; c-basic-offset: 4; tab-width: 8 -*-
+//
+// sign.h: Rcpp R/C++ interface class library -- sign
+//
+// Copyright (C) 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/>.
+
+#ifndef Rcpp__sugar__sign_h
+#define Rcpp__sugar__sign_h
+
+namespace Rcpp{
+namespace sugar{
+
+template <bool NA, int RTYPE>
+class sign__impl{
+public:
+	typedef typename Rcpp::traits::storage_type<RTYPE>::type STORAGE ;
+	static inline int get( STORAGE x){
+		return Rcpp::traits::is_na<RTYPE>(x) ? NA_INTEGER : ( x > 0 ? 1 : (x==0 ? 0 : -1) ) ;
+	}
+} ;
+
+template <int RTYPE>
+class sign__impl<false,RTYPE>{
+public:
+	typedef typename Rcpp::traits::storage_type<RTYPE>::type STORAGE ;
+	static inline int get( STORAGE x){
+		return ( x > 0 ? 1 : (x==0 ? 0 : -1) ) ;
+	}
+} ;
+
+	
+template <int RTYPE, bool NA, typename T>
+class Sign : public Rcpp::VectorBase< INTSXP,NA, Sign<RTYPE,NA,T> > {
+public:
+	typedef typename Rcpp::VectorBase<RTYPE,NA,T> VEC_TYPE ;
+	typedef typename Rcpp::traits::storage_type<RTYPE>::type STORAGE ;
+	
+	Sign( const VEC_TYPE& object_ ) : object(object_){}
+	
+	inline int operator[]( int i ) const {
+		return sign__impl<NA,RTYPE>::get( object[i] );
+	}
+	inline int size() const { return object.size() ; }
+	         
+private:
+	const VEC_TYPE& object ;
+} ;
+	
+} // sugar
+
+template <bool NA, typename T>
+inline sugar::Sign<INTSXP,NA,T> sign( const VectorBase<INTSXP,NA,T>& t){
+	return sugar::Sign<INTSXP,NA,T>( t ) ;
+}
+
+template <bool NA, typename T>
+inline sugar::Sign<REALSXP,NA,T> sign( const VectorBase<REALSXP,NA,T>& t){
+	return sugar::Sign<REALSXP,NA,T>( t ) ;
+}
+
+
+} // Rcpp
+#endif
+

Added: pkg/Rcpp/inst/unitTests/runit.sugar.sign.R
===================================================================
--- pkg/Rcpp/inst/unitTests/runit.sugar.sign.R	                        (rev 0)
+++ pkg/Rcpp/inst/unitTests/runit.sugar.sign.R	2010-06-23 11:24:14 UTC (rev 1664)
@@ -0,0 +1,41 @@
+#!/usr/bin/r -t
+#
+# Copyright (C) 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/>.
+
+test.sugar.sign <- function( ){
+
+	fx <- cxxfunction( signature( x = "numeric", y = "integer" ), '
+	
+		NumericVector xx(x) ;
+		IntegerVector yy(y) ;
+		
+		return List::create(
+			sign( xx ), 
+			sign( yy )
+			) ;
+	', plugin = "Rcpp" )
+	
+	checkEquals( 
+		fx( seq(-10, 10, length.out = 51), -25:25 ), 
+		list( 
+			c( rep(-1L, 25), 0L, rep(1L, 25) ), 
+			c( rep(-1L, 25), 0L, rep(1L, 25) )
+		)
+	)
+}
+



More information about the Rcpp-commits mailing list