File: median.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 (290 lines) | stat: -rw-r--r-- 7,619 bytes parent folder | download | duplicates (7)
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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
// -*- mode: C++; c-indent-level: 4; c-basic-offset: 4; indent-tabs-mode: nil; -*-
//
// median.h: Rcpp R/C++ interface class library -- median
//
// Copyright (C) 2016 Dirk Eddelbuettel, Romain Francois, and Nathan Russell
//
// 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__median_h
#define Rcpp__sugar__median_h

namespace Rcpp {
namespace sugar {
namespace median_detail {

// need to return double for integer vectors 
// (in case of even-length input vector)
// and Rcpp::String for STRSXP
// also need to return NA_REAL for 
// integer vector yielding NA result
template <int RTYPE>
struct result {
    typedef typename Rcpp::traits::storage_type<RTYPE>::type type;
    enum { rtype = RTYPE };
};

template <>
struct result<INTSXP> {
    typedef double type;
    enum { rtype = REALSXP };
};

template <>
struct result<STRSXP> {
    typedef Rcpp::String type;
    enum { rtype = STRSXP };
};

// std::nth_element and std::max_element don't 
// know how to compare Rcomplex values
template <typename T>
inline bool less(T lhs, T rhs) {
    return lhs < rhs;
}

template<>
inline bool less<Rcomplex>(Rcomplex lhs, Rcomplex rhs) {
    if (lhs.r < rhs.r) return true;
    if (lhs.i < rhs.i) return true;
    return false; 
}

// compiler does not know how to handle 
// Rcomplex numerator / double denominator
// and need explicit cast for INTSXP case
inline double half(double lhs) {
    return lhs / 2.0;
}

inline double half(int lhs) {
    return static_cast<double>(lhs) / 2.0;
}

inline Rcomplex half(Rcomplex lhs) {
    lhs.r /= 2.0;
    lhs.i /= 2.0;
    return lhs;
}

} // median_detail

// base case
template <int RTYPE, bool NA, typename T, bool NA_RM = false>
class Median {
public:
    typedef typename median_detail::result<RTYPE>::type result_type;
    typedef typename Rcpp::traits::storage_type<RTYPE>::type stored_type;
    enum { RESULT_RTYPE = median_detail::result<RTYPE>::rtype };
    typedef T VECTOR;
    
private:
    VECTOR x;
    
public:
    Median(const VECTOR& xx)
        : x(Rcpp::clone(xx)) {}
    
    operator result_type() {
        if (x.size() < 1) {
            return Rcpp::traits::get_na<RESULT_RTYPE>();
        }
        
        if (Rcpp::any(Rcpp::is_na(x))) {
            return Rcpp::traits::get_na<RESULT_RTYPE>();
        }
        
        R_xlen_t n = x.size() / 2;
        std::nth_element(
            x.begin(), x.begin() + n, x.end(), 
            median_detail::less<stored_type>);
        
        if (x.size() % 2) return x[n];
        return median_detail::half(
            x[n] + *std::max_element(
                    x.begin(), x.begin() + n, 
                    median_detail::less<stored_type>));
    }
};

// na.rm = TRUE
template <int RTYPE, bool NA, typename T>
class Median<RTYPE, NA, T, true> {
public:
    typedef typename median_detail::result<RTYPE>::type result_type;
    typedef typename Rcpp::traits::storage_type<RTYPE>::type stored_type;
    enum { RESULT_RTYPE = median_detail::result<RTYPE>::rtype };
    typedef T VECTOR;
    
private:
    VECTOR x;
    
public:
    Median(const VECTOR& xx)
        : x(Rcpp::na_omit(Rcpp::clone(xx))) {}
    
    operator result_type() {
        if (!x.size()) {
            return Rcpp::traits::get_na<RESULT_RTYPE>();
        }
        
        R_xlen_t n = x.size() / 2;
        std::nth_element(
            x.begin(), x.begin() + n, x.end(), 
            median_detail::less<stored_type>);
        
        if (x.size() % 2) return x[n];
        return median_detail::half(
            x[n] + *std::max_element(
                    x.begin(), x.begin() + n, 
                    median_detail::less<stored_type>));
    }
};

// NA = false
template <int RTYPE, typename T, bool NA_RM>
class Median<RTYPE, false, T, NA_RM> {
public:
    typedef typename median_detail::result<RTYPE>::type result_type;
    typedef typename Rcpp::traits::storage_type<RTYPE>::type stored_type;
    enum { RESULT_RTYPE = median_detail::result<RTYPE>::rtype };
    typedef T VECTOR;
    
private:
    VECTOR x;
    
public:
    Median(const VECTOR& xx)
        : x(Rcpp::clone(xx)) {}
    
    operator result_type() {
        if (x.size() < 1) {
            return Rcpp::traits::get_na<RESULT_RTYPE>();
        }
        
        R_xlen_t n = x.size() / 2;
        std::nth_element(
            x.begin(), x.begin() + n, x.end(), 
            median_detail::less<stored_type>);
        
        if (x.size() % 2) return x[n];
        return median_detail::half(
            x[n] + *std::max_element(
                    x.begin(), x.begin() + n, 
                    median_detail::less<stored_type>));
    }
};

// specialize for character vector
// due to string_proxy's incompatibility
// with certain std:: algorithms;
// need to return NA for even-length vectors
template <bool NA, typename T, bool NA_RM>
class Median<STRSXP, NA, T, NA_RM> {
public:
    typedef typename median_detail::result<STRSXP>::type result_type;
    typedef typename Rcpp::traits::storage_type<STRSXP>::type stored_type;
    typedef T VECTOR;
    
private:
    VECTOR x;
    
public:
    Median(const VECTOR& xx)
        : x(Rcpp::clone(xx)) {}
    
    operator result_type() {
        if (!(x.size() % 2)) {
            return Rcpp::traits::get_na<STRSXP>();
        }
        
        if (Rcpp::any(Rcpp::is_na(x))) {
            return Rcpp::traits::get_na<STRSXP>();
        }
        
        R_xlen_t n = x.size() / 2;
        x.sort();
        
        return x[n];
    }
};

// na.rm = TRUE
template <bool NA, typename T>
class Median<STRSXP, NA, T, true> {
public:
    typedef typename median_detail::result<STRSXP>::type result_type;
    typedef typename Rcpp::traits::storage_type<STRSXP>::type stored_type;
    typedef T VECTOR;
    
private:
    VECTOR x;
    
public:
    Median(const VECTOR& xx)
        : x(Rcpp::na_omit(Rcpp::clone(xx))) {}
    
    operator result_type() {
        if (!(x.size() % 2)) {
            return Rcpp::traits::get_na<STRSXP>();
        }
        
        R_xlen_t n = x.size() / 2;
        x.sort();
        
        return x[n];
    }
};

// NA = false
template <typename T>
class Median<STRSXP, false, T, true> {
public:
    typedef typename median_detail::result<STRSXP>::type result_type;
    typedef typename Rcpp::traits::storage_type<STRSXP>::type stored_type;
    typedef T VECTOR;
    
private:
    VECTOR x;
    
public:
    Median(const VECTOR& xx)
        : x(Rcpp::clone(xx)) {}
    
    operator result_type() {
        if (!(x.size() % 2)) {
            return Rcpp::traits::get_na<STRSXP>();
        }
        
        R_xlen_t n = x.size() / 2;
        x.sort();
        
        return x[n];
    }
};

} // sugar

template <int RTYPE, bool NA, typename T>
inline typename sugar::median_detail::result<RTYPE>::type
median(const Rcpp::VectorBase<RTYPE, NA, T>& x, bool na_rm = false) {
    if (!na_rm) return sugar::Median<RTYPE, NA, T, false>(x);
    return sugar::Median<RTYPE, NA, T, true>(x);
}

} // Rcpp

#endif // Rcpp__sugar__median_h