File: r_vector.h

package info (click to toggle)
rcpp 1.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 7,480 kB
  • sloc: cpp: 27,436; ansic: 7,778; sh: 53; makefile: 2
file content (154 lines) | stat: -rw-r--r-- 4,559 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
// -*- mode: C++; c-indent-level: 4; c-basic-offset: 4; indent-tabs-mode: nil; -*-
/* :tabSize=4:indentSize=4:noTabs=false:folding=explicit:collapseFolds=1: */
//
// r_vector.h: Rcpp R/C++ interface class library -- information about R vectors
//
// Copyright (C) 2010 - 2017  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__internal__r_vector_h
#define Rcpp__internal__r_vector_h

namespace Rcpp{
namespace internal{

template <int RTYPE>
typename Rcpp::traits::storage_type<RTYPE>::type* r_vector_start(SEXP x) {
    typedef typename Rcpp::traits::storage_type<RTYPE>::type* pointer;
    return reinterpret_cast<pointer>(dataptr(x));
}

// add specializations to avoid use of dataptr
#define RCPP_VECTOR_START_IMPL(__RTYPE__, __ACCESSOR__)                                              \
    template <>                                                                                      \
    inline typename Rcpp::traits::storage_type<__RTYPE__>::type* r_vector_start<__RTYPE__>(SEXP x) { \
        return __ACCESSOR__(x);                                                                      \
    }

RCPP_VECTOR_START_IMPL(LGLSXP,  LOGICAL);
RCPP_VECTOR_START_IMPL(INTSXP,  INTEGER);
RCPP_VECTOR_START_IMPL(RAWSXP,  RAW);
RCPP_VECTOR_START_IMPL(CPLXSXP, COMPLEX);
RCPP_VECTOR_START_IMPL(REALSXP, REAL);

#undef RCPP_VECTOR_START_IMPL

/**
 * The value 0 statically casted to the appropriate type for
 * the given SEXP type
 */
template <int RTYPE,typename CTYPE>				// #nocov start
inline CTYPE get_zero() {
    return static_cast<CTYPE>(0);
}								// #nocov end


/**
 * Specialization for Rcomplex
 */
template<>
inline Rcomplex get_zero<CPLXSXP,Rcomplex>(){
    Rcomplex x;
    x.r = 0.0;
    x.i = 0.0;
    return x;
}

/**
 * Initializes a vector of the given SEXP type. The template fills the
 * vector with the value 0 of the appropriate type, for example
 * an INTSXP vector is initialized with (int)0, etc...
 */
template<int RTYPE> void r_init_vector(SEXP x) {		// #nocov start
    typedef typename ::Rcpp::traits::storage_type<RTYPE>::type CTYPE;
    CTYPE* start=r_vector_start<RTYPE>(x);
    std::fill(start, start + Rf_xlength(x), get_zero<RTYPE,CTYPE>());
}								// #nocov end
/**
 * Initializes a generic vector (VECSXP). Does nothing since
 * R already initializes all elements to NULL
 */
template<>
inline void r_init_vector<VECSXP>(SEXP /*x*/) {}

/**
 * Initializes an expression vector (EXPRSXP). Does nothing since
 * R already initializes all elements to NULL
 */
template<>
inline void r_init_vector<EXPRSXP>(SEXP /*x*/) {}

/**
 * Initializes a character vector (STRSXP). Does nothing since
 * R already initializes all elements to ""
 */
template<>
inline void r_init_vector<STRSXP>(SEXP /*x*/) {}


/**
 * We do not allow List(RTYPE=VECSXP), RawVector(RTYPE=RAWSXP)
 * or ExpressionVector(RTYPE=EXPRSXP) to be sorted, so it is
 * desirable to issue a compiler error if user attempts to sort
 * these types of Vectors.
 *
 * We declare a template class without defining the generic
 * class body, but complete the definition in specialization
 * of qualified Vector types. Hence when using this class
 * on unqualified Vectors, the compiler will emit errors.
 */
template<int RTYPE>
class Sort_is_not_allowed_for_this_type;

/**
 * Specialization for CPLXSXP, INTSXP, LGLSXP, REALSXP, and STRSXP
 */
template<>
class Sort_is_not_allowed_for_this_type<CPLXSXP> {
public:
    static void do_nothing() {}
};

template<>
class Sort_is_not_allowed_for_this_type<INTSXP> {
public:
    static void do_nothing() {}
};

template<>
class Sort_is_not_allowed_for_this_type<LGLSXP> {
public:
    static void do_nothing() {}
};

template<>
class Sort_is_not_allowed_for_this_type<REALSXP> {
public:
    static void do_nothing() {}
};

template<>
class Sort_is_not_allowed_for_this_type<STRSXP> {
public:
    static void do_nothing() {}
};


} // internal
} // Rcpp

#endif