forked from r-lib/cpp11
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest-r_vector.cpp
More file actions
547 lines (405 loc) · 16.8 KB
/
test-r_vector.cpp
File metadata and controls
547 lines (405 loc) · 16.8 KB
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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
#include "cpp11/integers.hpp"
#include "cpp11/list.hpp"
#include "cpp11/protect.hpp"
#include "cpp11/strings.hpp"
#include <testthat.h>
#include <algorithm> // for max_element
context("r_vector-capabilities-C++") {
test_that("read only vector capabilities") {
using cpp11::integers;
expect_true(std::is_destructible<integers>::value);
expect_true(std::is_default_constructible<integers>::value);
expect_true(std::is_nothrow_default_constructible<integers>::value);
expect_true(std::is_copy_constructible<integers>::value);
expect_true(std::is_move_constructible<integers>::value);
expect_true(std::is_copy_assignable<integers>::value);
expect_true(std::is_move_assignable<integers>::value);
}
test_that("writable vector capabilities") {
using cpp11::writable::integers;
expect_true(std::is_destructible<integers>::value);
expect_true(std::is_default_constructible<integers>::value);
expect_true(std::is_nothrow_default_constructible<integers>::value);
expect_true(std::is_copy_constructible<integers>::value);
expect_true(std::is_move_constructible<integers>::value);
expect_true(std::is_copy_assignable<integers>::value);
expect_true(std::is_move_assignable<integers>::value);
}
test_that("read only const_iterator capabilities") {
using cpp11::integers;
expect_true(std::is_destructible<integers::const_iterator>::value);
expect_true(std::is_trivially_destructible<integers::const_iterator>::value);
expect_true(std::is_copy_constructible<integers::const_iterator>::value);
expect_true(std::is_move_constructible<integers::const_iterator>::value);
expect_true(std::is_copy_assignable<integers::const_iterator>::value);
expect_true(std::is_trivially_copy_assignable<integers::const_iterator>::value);
expect_true(std::is_move_assignable<integers::const_iterator>::value);
expect_true(std::is_trivially_move_assignable<integers::const_iterator>::value);
}
test_that("writable iterator capabilities") {
using cpp11::writable::integers;
expect_true(std::is_destructible<integers::iterator>::value);
expect_true(std::is_trivially_destructible<integers::iterator>::value);
expect_true(std::is_copy_constructible<integers::iterator>::value);
expect_true(std::is_move_constructible<integers::iterator>::value);
expect_true(std::is_copy_assignable<integers::iterator>::value);
expect_true(std::is_trivially_copy_assignable<integers::iterator>::value);
expect_true(std::is_move_assignable<integers::iterator>::value);
expect_true(std::is_trivially_move_assignable<integers::iterator>::value);
}
test_that("writable proxy capabilities") {
using cpp11::writable::integers;
expect_true(std::is_destructible<integers::proxy>::value);
expect_true(std::is_trivially_destructible<integers::proxy>::value);
expect_true(std::is_copy_constructible<integers::proxy>::value);
expect_true(std::is_move_constructible<integers::proxy>::value);
expect_true(std::is_copy_assignable<integers::proxy>::value);
expect_true(std::is_move_assignable<integers::proxy>::value);
}
}
context("r_vector-C++") {
test_that("writable vector temporary isn't leaked (integer) (#338)") {
R_xlen_t before = cpp11::detail::store::count();
// +1 from `x` allocation
cpp11::writable::integers x(1);
// Calls move assignment operator `operator=(r_vector<T>&& rhs)`
// +1 from `rhs` allocation and move into `x`
// -1 from old `x` release
x = cpp11::writable::integers(1);
R_xlen_t after = cpp11::detail::store::count();
expect_true(before == 0);
expect_true(after - before == 1);
}
test_that("writable vector temporary isn't leaked (list) (#338)") {
R_xlen_t before = cpp11::detail::store::count();
// +1 from `x` allocation
cpp11::writable::list x(1);
// Calls move assignment operator `operator=(r_vector<T>&& rhs)`
// +1 from `rhs` allocation and move into `x`
// -1 from old `x` release
x = cpp11::writable::list(1);
R_xlen_t after = cpp11::detail::store::count();
expect_true(before == 0);
expect_true(after - before == 1);
}
test_that("read-only vector copy constructor doesn't clear properties (#365)") {
R_xlen_t before = cpp11::detail::store::count();
SEXP x = PROTECT(Rf_allocVector(INTSXP, 1));
INTEGER(x)[0] = 1;
// +1 from `y` creation
cpp11::integers y(x);
// Calls read only copy constructor
// No duplication of `y`'s data is done
// +1 when adding `z`'s protection to the data
cpp11::integers z(y);
R_xlen_t after = cpp11::detail::store::count();
// `y` properties have not been cleared
expect_true(y.data() != R_NilValue);
expect_true(y.size() == 1);
// `z` owns them now
expect_true(z.data() != R_NilValue);
expect_true(z.size() == 1);
// And these are the same! This is all read-only, so no need to duplicate
expect_true(z.data() == y.data());
expect_true(before == 0);
expect_true(after - before == 2);
UNPROTECT(1);
}
test_that("read-only vector move constructor clears properties (#365)") {
R_xlen_t before = cpp11::detail::store::count();
SEXP x = PROTECT(Rf_allocVector(INTSXP, 1));
INTEGER(x)[0] = 1;
// +1 from `y` creation
cpp11::integers y(x);
// Calls read only move constructor
// +0 when moving
cpp11::integers z(std::move(y));
R_xlen_t after = cpp11::detail::store::count();
// `y` properties have been cleared in the move
expect_true(y.data() == R_NilValue);
expect_true(y.size() == 0);
// `z` owns them now
expect_true(z.data() != R_NilValue);
expect_true(z.size() == 1);
expect_true(before == 0);
expect_true(after - before == 1);
UNPROTECT(1);
}
test_that("writable vector copy constructor does not clear properties (#365)") {
R_xlen_t before = cpp11::detail::store::count();
// +1 from `y` allocation
cpp11::writable::integers y(1);
// Calls writable copy constructor
// +1 from duplicating `y` and protecting result
cpp11::writable::integers z(y);
R_xlen_t after = cpp11::detail::store::count();
// `y` properties have not been cleared
expect_true(y.data() != R_NilValue);
expect_true(y.size() == 1);
// `z` is a duplicate of `y`
expect_true(z.data() != R_NilValue);
expect_true(z.size() == 1);
// And these are not the same! This is writable, so a duplication occurred.
expect_true(z.data() != y.data());
expect_true(before == 0);
expect_true(after - before == 2);
}
test_that("writable vector move constructor clears properties (#365)") {
R_xlen_t before = cpp11::detail::store::count();
// +1 from `y` allocation
cpp11::writable::integers y(1);
// Calls writable move constructor
// +0 when moving
cpp11::writable::integers z(std::move(y));
R_xlen_t after = cpp11::detail::store::count();
// `y` properties have been cleared in the move
expect_true(y.data() == R_NilValue);
expect_true(y.size() == 0);
// `z` owns them now
expect_true(z.data() != R_NilValue);
expect_true(z.size() == 1);
expect_true(before == 0);
expect_true(after - before == 1);
}
test_that("read-only vector copy assignment operator doesn't clear properties (#365)") {
R_xlen_t before = cpp11::detail::store::count();
SEXP x = PROTECT(Rf_allocVector(INTSXP, 1));
INTEGER(x)[0] = 1;
// +1 from `y` creation
cpp11::integers y(x);
// +0 for default constructor
cpp11::integers z;
expect_true(z.data() == R_NilValue);
expect_true(z.size() == 0);
// Calls read only copy assignment operator `operator=(const r_vector<T>& rhs)`
// +1 from additional protection of `y` (but not duplicating `y`'s data)
z = y;
R_xlen_t after = cpp11::detail::store::count();
// `y` properties have not been cleared
expect_true(y.data() != R_NilValue);
expect_true(y.size() == 1);
// `z` properties have been updated
expect_true(z.data() != R_NilValue);
expect_true(z.size() == 1);
// And these are the same! This is all read-only, so no need to duplicate
expect_true(z.data() == y.data());
expect_true(before == 0);
expect_true(after - before == 2);
UNPROTECT(1);
}
test_that("read-only vector move assignment operator clears properties (#365)") {
R_xlen_t before = cpp11::detail::store::count();
SEXP x = PROTECT(Rf_allocVector(INTSXP, 1));
INTEGER(x)[0] = 1;
// +1 from `y` creation
cpp11::integers y(x);
// +0 for default constructor
cpp11::integers z;
// Calls read only move assignment operator `operator=(r_vector<T>&& rhs)`
// +0 when moving
z = std::move(y);
R_xlen_t after = cpp11::detail::store::count();
// `y` properties have been cleared in the move
expect_true(y.data() == R_NilValue);
expect_true(y.size() == 0);
expect_true(before == 0);
expect_true(after - before == 1);
UNPROTECT(1);
}
test_that("writable vector copy assignment operator doesn't clear properties (#365)") {
R_xlen_t before = cpp11::detail::store::count();
// +1 from `y` allocation
cpp11::writable::integers y(1);
// +0 for default constructor
cpp11::writable::integers z;
expect_true(z.data() == R_NilValue);
expect_true(z.size() == 0);
// Calls writable copy assignment operator `operator=(const r_vector<T>& rhs)`
// +1 from protecting duplicate of `y`
z = y;
R_xlen_t after = cpp11::detail::store::count();
// `y` properties have not been cleared
expect_true(y.data() != R_NilValue);
expect_true(y.size() == 1);
// `z` properties have been updated
expect_true(z.data() != R_NilValue);
expect_true(z.size() == 1);
// And these are not the same, we made a duplicate
expect_true(z.data() != y.data());
expect_true(before == 0);
expect_true(after - before == 2);
}
test_that("writable vector move assignment operator clears properties (#365)") {
R_xlen_t before = cpp11::detail::store::count();
// +1 from `y` allocation
cpp11::writable::integers y(1);
// +0 for default constructor
cpp11::writable::integers z;
// Calls writable move assignment operator `operator=(r_vector<T>&& rhs)`
// +0 when moving (also clears `capacity` in this case)
z = std::move(y);
R_xlen_t after = cpp11::detail::store::count();
// `y` properties have been cleared in the move
expect_true(y.data() == R_NilValue);
expect_true(y.size() == 0);
expect_true(before == 0);
expect_true(after - before == 1);
}
test_that("writable vector copy assignment works with default constructed vectors") {
// Default constructed - the `data_` is `R_NilValue`!
cpp11::writable::integers x;
cpp11::writable::integers y(1);
// Checks that this guards against calling `INTEGER()` on `R_NilValue`.
y = x;
SEXP z(y);
expect_true(cpp11::detail::r_typeof(z) == INTSXP);
expect_true(Rf_xlength(z) == 0);
}
test_that("writable vector copy constructor correctly tracks the `capacity_`") {
cpp11::writable::integers x(2);
x[0] = 1;
x[1] = 2;
// Doubles the capacity from 2 to 4
x.push_back(3);
expect_true(Rf_xlength(x.data()) == 4);
// Calls writable copy constructor.
// Should duplicate without truncations and retain same capacity.
cpp11::writable::integers y(x);
expect_true(Rf_xlength(y.data()) == 4);
// In the past, we truncated (i.e. to size 3) but retained the same capacity of 4,
// so this could try to push without first resizing.
y.push_back(4);
expect_true(y[0] == 1);
expect_true(y[1] == 2);
expect_true(y[2] == 3);
expect_true(y[3] == 4);
}
test_that("writable vector copy constructor works with default constructed vectors") {
// Default constructed - the `data_` is `R_NilValue`!
cpp11::writable::integers x;
// Checks that this guards against calling `INTEGER()` on `R_NilValue`.
cpp11::writable::integers y(x);
SEXP z(y);
expect_true(cpp11::detail::r_typeof(z) == INTSXP);
expect_true(Rf_xlength(z) == 0);
}
test_that(
"read only vector copy constructor from a writable vector correctly truncates") {
cpp11::writable::integers x(2);
x[0] = 1;
x[1] = 2;
// Doubles the capacity from 2 to 4, meaning the underlying SEXP has length 4 now.
x.push_back(3);
expect_true(Rf_xlength(x.data()) == 4);
// Calls read only copy constructor from a writable vector.
// Should truncate the SEXP before wrapping in a read only vector.
cpp11::integers y(x);
expect_true(Rf_xlength(y.data()) == 3);
// `x` is still in a good state
expect_true(x.data() != R_NilValue);
expect_true(x.size() == 3);
// Even if we get a temporary writable vector, that goes through the same copy
// constructor as above, because we still have to truncate before taking ownership.
cpp11::integers z(std::move(x));
expect_true(Rf_xlength(z.data()) == 3);
// So technically `x` is still in a working state after this, although that is
// implementation defined and up to us to decide on
expect_true(x.data() != R_NilValue);
expect_true(x.size() == 3);
}
test_that(
"writable vector truncation resizes names and retains attributes (but not dim or "
"dim names)") {
cpp11::writable::integers x(2);
x[0] = 1;
x[1] = 2;
// Doubles the capacity from 2 to 4, meaning the underlying SEXP has length 4 now.
x.push_back(3);
expect_true(Rf_xlength(x.data()) == 4);
// Set some names
SEXP names = PROTECT(Rf_allocVector(STRSXP, 3));
SET_STRING_ELT(names, 0, Rf_mkCharCE("x", CE_UTF8));
SET_STRING_ELT(names, 1, Rf_mkCharCE("y", CE_UTF8));
SET_STRING_ELT(names, 2, Rf_mkCharCE("z", CE_UTF8));
x.names() = names;
// Length of names SEXP is actually 4 now, extended by `setAttrib()` to match
// the internal capacity
expect_true(Rf_xlength(Rf_getAttrib(x.data(), R_NamesSymbol)) == 4);
// Set an attribute
SEXP bar = PROTECT(Rf_ScalarInteger(1));
x.attr("foo") = bar;
// Extract out the underlying SEXP using the operator:
// - This truncates to size 3
// - This truncates and keeps names
// - This copies over attributes like `"foo"`
// - This updates the internal SEXP in `x` to the one in `x_sexp` (gross but users
// probably expect this at this point)
SEXP x_sexp = x;
expect_true(Rf_xlength(x_sexp) == 3);
expect_true(Rf_xlength(Rf_getAttrib(x_sexp, R_NamesSymbol)) == 3);
expect_true(Rf_getAttrib(x_sexp, Rf_install("foo")) == bar);
expect_true(x.data() == x_sexp);
UNPROTECT(2);
}
test_that("`proxy` is copy assignable (integers) (#300, #339)") {
cpp11::writable::integers foo = {1, 2, 3, 4, 5};
cpp11::writable::integers bar = {6, 7, 8, 9, 10};
// Using rvalue temporaries (i.e. move assignable, but using copy assignment operator)
for (R_xlen_t i = 0; i < foo.size(); ++i) {
bar[i] = foo[i];
}
// Using lvalues (i.e. copy assignable)
cpp11::writable::integers::proxy x = foo[0];
bar[4] = x;
expect_true(bar[0] == 1);
expect_true(bar[1] == 2);
expect_true(bar[2] == 3);
expect_true(bar[3] == 4);
expect_true(bar[4] == 1);
}
test_that("`proxy` is copy assignable (list) (#300, #339)") {
SEXP a = PROTECT(Rf_allocVector(INTSXP, 1));
SEXP b = PROTECT(Rf_allocVector(REALSXP, 2));
cpp11::writable::list x({a, b});
cpp11::writable::list y(2);
// Using rvalue temporaries (i.e. move assignable, but using copy assignment operator)
y[0] = x[0];
// Using lvalues (i.e. copy assignable)
cpp11::writable::list::proxy elt = x[1];
y[1] = elt;
expect_true(y[0] == a);
expect_true(y[1] == b);
UNPROTECT(2);
}
test_that("`proxy` is copy assignable (strings) (#300, #339)") {
SEXP a = PROTECT(Rf_mkCharCE("a", CE_UTF8));
SEXP b = PROTECT(Rf_mkCharCE("b", CE_UTF8));
cpp11::writable::strings x({a, b});
cpp11::writable::strings y(2);
// Using rvalue temporaries (i.e. move assignable, but using copy assignment operator)
y[0] = x[0];
// Using lvalues (i.e. copy assignable)
cpp11::writable::strings::proxy elt = x[1];
y[1] = elt;
expect_true(y[0] == a);
expect_true(y[1] == b);
UNPROTECT(2);
}
test_that("std::max_element works on read only vectors") {
SEXP foo_sexp = PROTECT(Rf_allocVector(INTSXP, 5));
SET_INTEGER_ELT(foo_sexp, 0, 1);
SET_INTEGER_ELT(foo_sexp, 1, 2);
SET_INTEGER_ELT(foo_sexp, 2, 5);
SET_INTEGER_ELT(foo_sexp, 3, 4);
SET_INTEGER_ELT(foo_sexp, 4, 3);
cpp11::integers foo(foo_sexp);
auto element = std::max_element(foo.begin(), foo.end());
expect_true(*element == 5);
UNPROTECT(1);
}
test_that("std::max_element works on writable vectors (#334)") {
cpp11::writable::integers foo = {1, 2, 5, 4, 3};
auto element = std::max_element(foo.begin(), foo.end());
expect_true(*element == 5);
}
}