/
subset.c
1424 lines (1303 loc) · 39.9 KB
/
subset.c
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
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* R : A Computer Language for Statistical Data Analysis
* Copyright (C) 1997--2023 The R Core Team
* Copyright (C) 1995, 1996 Robert Gentleman and Ross Ihaka
*
* This program 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.
*
* This program 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 this program; if not, a copy is available at
* https://www.R-project.org/Licenses/
*
*
* Vector and List Subsetting
*
* There are three kinds of subscripting [, [[, and $.
* We have three different functions to compute these.
*
*
* Note on Matrix Subscripts
*
* The special [ subscripting where dim(x) == ncol(subscript matrix)
* is handled inside VectorSubset. The subscript matrix is turned
* into a subscript vector of the appropriate size and then
* VectorSubset continues. This provides coherence especially
* regarding attributes etc. (it would be quicker to handle this case
* separately, but then we would have more to keep in step.
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <Defn.h>
#include <Internal.h>
/* JMC convinced MM that this was not a good idea: */
#undef _S4_subsettable
static R_INLINE SEXP VECTOR_ELT_FIX_NAMED(SEXP y, R_xlen_t i) {
/* if RHS (container or element) has NAMED > 0 set NAMED = NAMEDMAX.
Duplicating might be safer/more consistent (fix bug reported by
Radford Neal; similar to PR15098) */
SEXP val = VECTOR_ELT(y, i);
if ((NAMED(y) || NAMED(val)))
ENSURE_NAMEDMAX(val);
return val;
}
/* ExtractSubset allocates "result" and does the transfer of elements
from "x" to "result" according to the integer/real subscripts given
in "indx".
The EXTRACT_SUBSET_LOOP macro allows the branches based on index
type and vector type to happen outside the loop.
This could avoid using data pointers, but there is little point as
currently the subscript code forces allocation.
*/
#define EXTRACT_SUBSET_LOOP(STDCODE, NACODE) do { \
if (TYPEOF(indx) == INTSXP) { \
const int *pindx = INTEGER_RO(indx); \
for (i = 0; i < n; i++) { \
ii = pindx[i]; \
if (0 < ii && ii <= nx) { \
ii--; \
STDCODE; \
} \
else /* out of bounds or NA */ \
NACODE; \
} \
} \
else { \
const double *pindx = REAL_RO(indx); \
for (i = 0; i < n; i++) { \
double di = pindx[i]; \
ii = (R_xlen_t) (di - 1); \
if (R_FINITE(di) && \
0 <= ii && ii < nx) \
STDCODE; \
else \
NACODE; \
} \
} \
} while (0)
NORET static void errorcallNotSubsettable(SEXP x, SEXP call)
{
SEXP cond = R_makeNotSubsettableError(x, call);
PROTECT(cond);
R_signalErrorCondition(cond, call);
UNPROTECT(1); /* cond; not reached */
}
NORET static void errorcallMissingSubs(SEXP x, SEXP call)
{
if (call == R_NilValue)
call = R_CurrentExpression;
SEXP cond = R_makeMissingSubscriptError(x, call);
PROTECT(cond);
R_signalErrorCondition(cond, call);
UNPROTECT(1); /* cond; not reached */
}
attribute_hidden SEXP ExtractSubset(SEXP x, SEXP indx, SEXP call)
{
if (x == R_NilValue)
return x;
SEXP result;
if (ALTREP(x)) {
result = ALTVEC_EXTRACT_SUBSET(x, indx, call);
if (result != NULL)
return result;
}
R_xlen_t i, ii, n, nx;
n = XLENGTH(indx);
nx = xlength(x);
int mode = TYPEOF(x);
/* protect allocation in case _ELT operations need to allocate */
PROTECT(result = allocVector(mode, n));
switch(mode) {
case LGLSXP:
EXTRACT_SUBSET_LOOP(LOGICAL0(result)[i] = LOGICAL_ELT(x, ii),
LOGICAL0(result)[i] = NA_INTEGER);
break;
case INTSXP:
EXTRACT_SUBSET_LOOP(INTEGER0(result)[i] = INTEGER_ELT(x, ii),
INTEGER0(result)[i] = NA_INTEGER);
break;
case REALSXP:
EXTRACT_SUBSET_LOOP(REAL0(result)[i] = REAL_ELT(x, ii),
REAL0(result)[i] = NA_REAL);
break;
case CPLXSXP:
{
Rcomplex NA_CPLX = { .r = NA_REAL, .i = NA_REAL };
EXTRACT_SUBSET_LOOP(COMPLEX0(result)[i] = COMPLEX_ELT(x, ii),
COMPLEX0(result)[i] = NA_CPLX);
}
break;
case STRSXP:
EXTRACT_SUBSET_LOOP(SET_STRING_ELT(result, i, STRING_ELT(x, ii)),
SET_STRING_ELT(result, i, NA_STRING));
break;
case VECSXP:
case EXPRSXP:
EXTRACT_SUBSET_LOOP(SET_VECTOR_ELT(result, i,
VECTOR_ELT_FIX_NAMED(x, ii)),
SET_VECTOR_ELT(result, i, R_NilValue));
break;
case RAWSXP:
EXTRACT_SUBSET_LOOP(RAW0(result)[i] = RAW_ELT(x, ii),
RAW0(result)[i] = (Rbyte) 0);
break;
case LISTSXP:
/* cannot happen: pairlists are coerced to lists */
case LANGSXP:
/* cannot happen: LANGSXPs are coerced to lists */
default:
errorcallNotSubsettable(x, call);
}
UNPROTECT(1); /* result */
return result;
}
/* This is for all cases with a single index, including 1D arrays and
matrix indexing of arrays */
static SEXP VectorSubset(SEXP x, SEXP s, SEXP call)
{
if (s == R_MissingArg) return duplicate(x);
/* Check to see if we have special matrix subscripting. */
/* If we do, make a real subscript vector and protect it. */
PROTECT(s);
if (ATTRIB(s) != R_NilValue) { /* pretest to speed up simple case */
SEXP dim = getAttrib(x, R_DimSymbol);
if (isMatrix(s) && isArray(x) && ncols(s) == length(dim)) {
if (isString(s)) {
SEXP dnames = PROTECT(GetArrayDimnames(x));
s = strmat2intmat(s, dnames, call, x);
UNPROTECT(2); /* dnames, s */
PROTECT(s);
}
if (isInteger(s) || isReal(s)) {
s = mat2indsub(dim, s, call, x);
UNPROTECT(1);
PROTECT(s);
}
}
}
/* Convert to a vector of integer subscripts */
/* in the range 1:length(x). */
R_xlen_t stretch = 1;
SEXP indx = PROTECT(makeSubscript(x, s, &stretch, call));
/* Allocate the result. */
int mode = TYPEOF(x);
SEXP result = PROTECT(ExtractSubset(x, indx, call));
if (mode == VECSXP || mode == EXPRSXP)
/* we do not duplicate the values when extracting the subset,
so to be conservative mark the result as NAMED = NAMEDMAX */
ENSURE_NAMEDMAX(result);
if (result != R_NilValue) {
SEXP attrib, nattrib;
if (
((attrib = getAttrib(x, R_NamesSymbol)) != R_NilValue) ||
( /* here we might have an array. Use row names if 1D */
isArray(x) && length(getAttrib(x, R_DimNamesSymbol)) == 1 &&
(attrib = getAttrib(x, R_DimNamesSymbol)) != R_NilValue &&
(attrib = GetRowNames(attrib)) != R_NilValue
)
) {
PROTECT(attrib);
PROTECT(nattrib = ExtractSubset(attrib, indx, call));
setAttrib(result, R_NamesSymbol, nattrib);
UNPROTECT(2); /* attrib, nattrib */
}
if ((attrib = getAttrib(x, R_SrcrefSymbol)) != R_NilValue &&
TYPEOF(attrib) == VECSXP) {
PROTECT(nattrib = ExtractSubset(attrib, indx, call));
setAttrib(result, R_SrcrefSymbol, nattrib);
UNPROTECT(1);
}
/* FIXME: this is wrong, because the slots are gone, so result is an invalid object of the S4 class! JMC 3/3/09 */
#ifdef _S4_subsettable
if(IS_S4_OBJECT(x)) { /* e.g. contains = "list" */
setAttrib(result, R_ClassSymbol, getAttrib(x, R_ClassSymbol));
SET_S4_OBJECT(result);
}
#endif
}
UNPROTECT(3);
return result;
}
NORET static void errorcallOutOfBounds(SEXP x, int subscript,
R_xlen_t index, SEXP call)
{
SEXP sindex = ScalarReal((double) index);
PROTECT(sindex);
SEXP cond = R_makeOutOfBoundsError(x, subscript, sindex, call, NULL);
PROTECT(cond);
R_signalErrorCondition(cond, call);
UNPROTECT(2); /* sindex, cond; not reached */
}
NORET static void errorcallOutOfBoundsSEXP(SEXP x, int subscript,
SEXP sindex, SEXP call)
{
SEXP cond = R_makeOutOfBoundsError(x, subscript, sindex, call, NULL);
PROTECT(cond);
R_signalErrorCondition(cond, call);
UNPROTECT(1); /* cond; not reached */
}
// in ./subscript.c :
SEXP int_arraySubscript(int dim, SEXP s, SEXP dims, SEXP x, SEXP call);
/* The MATRIX_SUBSET_LOOP macro allows the branches based on index
type and vector type to happen outside the loop. Running through
the indices in column-major order also improves cache locality. */
#define MATRIX_SUBSET_LOOP(STDCODE, NACODE) do { \
for (j = 0; j < ncs; j++) { \
jj = psc[j]; \
if (jj != NA_INTEGER) { \
if (jj < 1 || jj > nc) \
errorcallOutOfBounds(x, 0, jj, call); \
jj--; \
} \
for (i = 0; i < nrs; i++) { \
ii = psr[i]; \
if (ii != NA_INTEGER) { \
if (ii < 1 || ii > nr) \
errorcallOutOfBounds(x, 1, ii, call); \
ii--; \
} \
ij = i + j * nrs; \
if (ii == NA_INTEGER || jj == NA_INTEGER) \
NACODE; \
else { \
iijj = ii + jj * nr; \
STDCODE; \
} \
} \
} \
} while (0)
static SEXP MatrixSubset(SEXP x, SEXP s, SEXP call, int drop)
{
SEXP attr, result, sr, sc, dim;
int nr, nc, nrs, ncs;
R_xlen_t i, j, ii, jj, ij, iijj;
nr = nrows(x);
nc = ncols(x);
/* Note that "s" is protected on entry. */
/* The following ensures that pointers remain protected. */
dim = getAttrib(x, R_DimSymbol);
sr = SETCAR (s, int_arraySubscript(0, CAR(s), dim, x, call));
sc = SETCADR(s, int_arraySubscript(1, CADR(s), dim, x, call));
nrs = LENGTH(sr);
ncs = LENGTH(sc);
/* Check this does not overflow: currently only possible on 32-bit */
if ((double)nrs * (double)ncs > R_XLEN_T_MAX)
error(_("dimensions would exceed maximum size of array"));
PROTECT(sr);
PROTECT(sc);
result = allocVector(TYPEOF(x), (R_xlen_t) nrs * (R_xlen_t) ncs);
const int *psr = INTEGER_RO(sr);
const int *psc = INTEGER_RO(sc);
PROTECT(result);
switch(TYPEOF(x)) {
case LGLSXP:
MATRIX_SUBSET_LOOP(LOGICAL0(result)[ij] = LOGICAL_ELT(x, iijj),
LOGICAL0(result)[ij] = NA_LOGICAL);
break;
case INTSXP:
MATRIX_SUBSET_LOOP(INTEGER0(result)[ij] = INTEGER_ELT(x, iijj),
INTEGER0(result)[ij] = NA_INTEGER);
break;
case REALSXP:
MATRIX_SUBSET_LOOP(REAL0(result)[ij] = REAL_ELT(x, iijj),
REAL0(result)[ij] = NA_REAL);
break;
case CPLXSXP:
{
Rcomplex NA_CPLX = { .r = NA_REAL, .i = NA_REAL };
MATRIX_SUBSET_LOOP(COMPLEX0(result)[ij] = COMPLEX_ELT(x, iijj),
COMPLEX0(result)[ij] = NA_CPLX);
}
break;
case STRSXP:
MATRIX_SUBSET_LOOP(SET_STRING_ELT(result, ij, STRING_ELT(x, iijj)),
SET_STRING_ELT(result, ij, NA_STRING));
break;
case VECSXP:
case EXPRSXP:
MATRIX_SUBSET_LOOP(SET_VECTOR_ELT(result, ij,
VECTOR_ELT_FIX_NAMED(x, iijj)),
SET_VECTOR_ELT(result, ij, R_NilValue));
break;
case RAWSXP:
MATRIX_SUBSET_LOOP(RAW0(result)[ij] = RAW_ELT(x, iijj),
RAW0(result)[ij] = (Rbyte) 0);
break;
default:
errorcall(call, _("matrix subscripting not handled for this type"));
break;
}
if(nrs >= 0 && ncs >= 0) {
PROTECT(attr = allocVector(INTSXP, 2));
INTEGER0(attr)[0] = nrs;
INTEGER0(attr)[1] = ncs;
if(!isNull(getAttrib(dim, R_NamesSymbol)))
setAttrib(attr, R_NamesSymbol, getAttrib(dim, R_NamesSymbol));
setAttrib(result, R_DimSymbol, attr);
UNPROTECT(1);
}
/* The matrix elements have been transferred. Now we need to */
/* transfer the attributes. Most importantly, we need to subset */
/* the dimnames of the returned value. */
if (nrs >= 0 && ncs >= 0) {
SEXP dimnames, dimnamesnames, newdimnames;
dimnames = getAttrib(x, R_DimNamesSymbol);
PROTECT(dimnamesnames = getAttrib(dimnames, R_NamesSymbol));
if (!isNull(dimnames)) {
PROTECT(newdimnames = allocVector(VECSXP, 2));
if (TYPEOF(dimnames) == VECSXP) {
SET_VECTOR_ELT(newdimnames, 0,
ExtractSubset(VECTOR_ELT(dimnames, 0), sr, call));
SET_VECTOR_ELT(newdimnames, 1,
ExtractSubset(VECTOR_ELT(dimnames, 1), sc, call));
}
else {
SET_VECTOR_ELT(newdimnames, 0,
ExtractSubset(CAR(dimnames), sr, call));
SET_VECTOR_ELT(newdimnames, 1,
ExtractSubset(CADR(dimnames), sc, call));
}
setAttrib(newdimnames, R_NamesSymbol, dimnamesnames);
setAttrib(result, R_DimNamesSymbol, newdimnames);
UNPROTECT(1); /* newdimnames */
}
UNPROTECT(1); /* dimnamesnames */
}
/* Probably should not do this:
copyMostAttrib(x, result); */
if (drop)
DropDims(result);
UNPROTECT(3);
return result;
}
static R_INLINE R_xlen_t findASubIndex(R_xlen_t k, const int * const *subs,
const int *indx, const int *pxdims,
const R_xlen_t *offset,
SEXP call)
{
R_xlen_t ii = 0;
for (int j = 0; j < k; j++) {
int jj = subs[j][indx[j]];
if (jj == NA_INTEGER)
return NA_INTEGER;
ii += (jj - 1) * offset[j];
}
return ii;
}
#define ARRAY_SUBSET_LOOP(STDCODE, NACODE) do { \
for (R_xlen_t i = 0; i < n; i++) { \
R_xlen_t ii = findASubIndex(k, subs, indx, \
pxdims, offset, call); \
if (ii != NA_INTEGER) \
STDCODE; \
else \
NACODE; \
if (n > 1) { \
int j = 0; \
while (++indx[j] >= bound[j]) { \
indx[j] = 0; \
j = (j + 1) % k; \
} \
} \
} \
} while (0)
static SEXP ArraySubset(SEXP x, SEXP s, SEXP call, int drop)
{
int k, mode;
SEXP dimnames, dimnamesnames, p, q, r, result, xdims;
const void *vmaxsave = vmaxget();
mode = TYPEOF(x);
xdims = getAttrib(x, R_DimSymbol);
k = length(xdims);
const int *pxdims = INTEGER_RO(xdims);
/* k is now the number of dims */
const int **subs = (const int**)R_alloc(k, sizeof(int*));
int *indx = (int*)R_alloc(k, sizeof(int));
int *bound = (int*)R_alloc(k, sizeof(int));
R_xlen_t *offset = (R_xlen_t*)R_alloc(k, sizeof(R_xlen_t));
/* Construct a vector to contain the returned values. */
/* Store its extents. */
R_xlen_t n = 1;
r = s;
for (int i = 0; i < k; i++) {
SETCAR(r, int_arraySubscript(i, CAR(r), xdims, x, call));
bound[i] = LENGTH(CAR(r));
n *= bound[i];
r = CDR(r);
}
r = s;
for (int i = 0; i < k; i++) {
indx[i] = 0;
subs[i] = INTEGER_RO(CAR(r));
r = CDR(r);
}
offset[0] = 1;
for (int i = 1; i < k; i++)
offset[i] = offset[i - 1] * pxdims[i - 1];
/* range check on indices -- the lower bound check may not be needed */
for (int i = 0; i < k; i++)
for (int j = 0; j < bound[i]; j++) {
int jj = subs[i][j];
if (jj > pxdims[i] ||
/* this should not be needed as indices reaching this
point should be positive or NA_INTEGER, which is
negative */
(jj < 1 && jj != NA_INTEGER))
errorcallOutOfBounds(x, i, jj, call);
}
/* Transfer the subset elements from "x" to "a". */
PROTECT(result = allocVector(mode, n));
switch (mode) {
case LGLSXP:
ARRAY_SUBSET_LOOP(LOGICAL0(result)[i] = LOGICAL_ELT(x, ii),
LOGICAL0(result)[i] = NA_LOGICAL);
break;
case INTSXP:
ARRAY_SUBSET_LOOP(INTEGER0(result)[i] = INTEGER_ELT(x, ii),
INTEGER0(result)[i] = NA_INTEGER);
break;
case REALSXP:
ARRAY_SUBSET_LOOP(REAL0(result)[i] = REAL_ELT(x, ii),
REAL0(result)[i] = NA_REAL);
break;
case CPLXSXP:
{
Rcomplex NA_CPLX = { .r = NA_REAL, .i = NA_REAL };
ARRAY_SUBSET_LOOP(COMPLEX0(result)[i] = COMPLEX_ELT(x, ii),
COMPLEX0(result)[i] = NA_CPLX);
}
break;
case STRSXP:
ARRAY_SUBSET_LOOP(SET_STRING_ELT(result, i, STRING_ELT(x, ii)),
SET_STRING_ELT(result, i, NA_STRING));
break;
case VECSXP:
case EXPRSXP:
ARRAY_SUBSET_LOOP(SET_VECTOR_ELT(result, i,
VECTOR_ELT_FIX_NAMED(x, ii)),
SET_VECTOR_ELT(result, i, R_NilValue));
break;
case RAWSXP:
ARRAY_SUBSET_LOOP(RAW0(result)[i] = RAW_ELT(x, ii),
RAW0(result)[i] = (Rbyte) 0);
break;
default:
errorcall(call, _("array subscripting not handled for this type"));
break;
}
SEXP new_dim = PROTECT(allocVector(INTSXP, k));
for(int i = 0 ; i < k ; i++)
INTEGER0(new_dim)[i] = bound[i];
if(!isNull(getAttrib(xdims, R_NamesSymbol)))
setAttrib(new_dim, R_NamesSymbol, getAttrib(xdims, R_NamesSymbol));
setAttrib(result, R_DimSymbol, new_dim);
UNPROTECT(1); // new_dim
/* The array elements have been transferred. */
/* Now we need to transfer the attributes. */
/* Most importantly, we need to subset the */
/* dimnames of the returned value. */
dimnames = getAttrib(x, R_DimNamesSymbol);
PROTECT(dimnamesnames = getAttrib(dimnames, R_NamesSymbol));
if (dimnames != R_NilValue) {
int j = 0;
PROTECT(xdims = allocVector(VECSXP, k));
if (TYPEOF(dimnames) == VECSXP) {
r = s;
for (int i = 0; i < k ; i++) {
if (bound[i] > 0) {
SET_VECTOR_ELT(xdims, j++,
ExtractSubset(VECTOR_ELT(dimnames, i), CAR(r), call));
} else { /* 0-length dims have NULL dimnames */
SET_VECTOR_ELT(xdims, j++, R_NilValue);
}
r = CDR(r);
}
}
else {
p = dimnames;
q = xdims;
r = s;
for(int i = 0 ; i < k; i++) {
SETCAR(q, ExtractSubset(CAR(p), CAR(r), call));
p = CDR(p);
q = CDR(q);
r = CDR(r);
}
}
setAttrib(xdims, R_NamesSymbol, dimnamesnames);
setAttrib(result, R_DimNamesSymbol, xdims);
UNPROTECT(1); /* xdims */
}
/* This was removed for matrices in 1998
copyMostAttrib(x, result); */
/* Free temporary memory */
vmaxset(vmaxsave);
if (drop)
DropDims(result);
UNPROTECT(2); /* dimnamesnames, result */
return result;
}
/* Returns and removes a named argument from argument list args.
The search ends as soon as a matching argument is found. If
the argument is not found, the argument list is not modified
and R_NilValue is returned.
*/
static SEXP ExtractArg(SEXP args, SEXP arg_sym)
{
SEXP arg, prev_arg;
int found = 0;
for (arg = prev_arg = args; arg != R_NilValue; arg = CDR(arg)) {
if(TAG(arg) == arg_sym) {
if (arg == prev_arg) /* found at head of args */
args = CDR(args);
else
SETCDR(prev_arg, CDR(arg));
found = 1;
break;
}
else prev_arg = arg;
}
return found ? CAR(arg) : R_NilValue;
}
/* Extracts the drop argument, if present, from the argument list.
The object being subsetted must be the first argument. */
static void ExtractDropArg(SEXP el, int *drop)
{
*drop = asLogical(ExtractArg(el, R_DropSymbol));
if (*drop == NA_LOGICAL) *drop = 1;
}
/* Extracts and, if present, removes the 'exact' argument from the
argument list. An integer code giving the desired exact matching
behavior is returned:
0 not exact
1 exact
-1 not exact, but warn when partial matching is used
*/
static int ExtractExactArg(SEXP args)
{
SEXP argval = ExtractArg(args, R_ExactSymbol);
if(isNull(argval)) return 1; /* Default is true as from R 2.7.0 */
int exact = asLogical(argval);
if (exact == NA_LOGICAL) exact = -1;
return exact;
}
/* Version of DispatchOrEval for "[" and friends that speeds up simple cases.
Also defined in subassign.c */
static R_INLINE
int R_DispatchOrEvalSP(SEXP call, SEXP op, const char *generic, SEXP args,
SEXP rho, SEXP *ans)
{
SEXP prom = NULL;
if (args != R_NilValue && CAR(args) != R_DotsSymbol) {
SEXP x = eval(CAR(args), rho);
PROTECT(x);
INCREMENT_LINKS(x);
if (! OBJECT(x)) {
*ans = CONS_NR(x, evalListKeepMissing(CDR(args), rho));
DECREMENT_LINKS(x);
UNPROTECT(1);
return FALSE;
}
prom = R_mkEVPROMISE_NR(CAR(args), x);
args = CONS(prom, CDR(args));
UNPROTECT(1);
}
PROTECT(args);
int disp = DispatchOrEval(call, op, generic, args, rho, ans, 0, 0);
if (prom) DECREMENT_LINKS(PRVALUE(prom));
UNPROTECT(1);
return disp;
}
/* The "[" subset operator.
* This provides the most general form of subsetting. */
attribute_hidden SEXP do_subset(SEXP call, SEXP op, SEXP args, SEXP rho)
{
SEXP ans;
/* If the first argument is an object and there is an */
/* appropriate method, we dispatch to that method, */
/* otherwise we evaluate the arguments and fall through */
/* to the generic code below. Note that evaluation */
/* retains any missing argument indicators. */
/* DispatchOrEval internal generic: [ */
if(R_DispatchOrEvalSP(call, op, "[", args, rho, &ans)) {
/* if(DispatchAnyOrEval(call, op, "[", args, rho, &ans, 0, 0)) */
if (NAMED(ans))
ENSURE_NAMEDMAX(ans);
return(ans);
}
/* Method dispatch has failed, we now */
/* run the generic internal code. */
return do_subset_dflt(call, op, ans, rho);
}
static R_INLINE R_xlen_t scalarIndex(SEXP s)
{
if (ATTRIB(s) == R_NilValue) {
if (IS_SCALAR(s, INTSXP)) {
int ival = SCALAR_IVAL(s);
if (ival != NA_INTEGER)
return ival;
else return -1;
}
else if (IS_SCALAR(s, REALSXP)) {
double rval = SCALAR_DVAL(s);
// treat infinite indices as NA, like asInteger
if (R_FINITE(rval))
return (R_xlen_t) rval;
else return -1;
}
else return -1;
}
else return -1;
}
// called from (R `[` => ) do_subset, but also from R .subset() :
attribute_hidden SEXP do_subset_dflt(SEXP call, SEXP op, SEXP args, SEXP rho)
{
/* By default we drop extents of length 1 */
/* Handle cases of extracting a single element from a simple vector
or matrix directly to improve speed for these simple cases. */
SEXP x = CAR(args);
SEXP cdrArgs = CDR(args);
SEXP cddrArgs = CDR(cdrArgs);
if (cdrArgs != R_NilValue && cddrArgs == R_NilValue &&
TAG(cdrArgs) == R_NilValue) {
/* one index, not named */
if (ATTRIB(x) == R_NilValue) {
SEXP s = CAR(cdrArgs);
R_xlen_t i = scalarIndex(s);
switch (TYPEOF(x)) {
case REALSXP:
if (i >= 1 && i <= XLENGTH(x))
return ScalarReal( REAL_ELT(x, i-1) );
break;
case INTSXP:
if (i >= 1 && i <= XLENGTH(x))
return ScalarInteger( INTEGER_ELT(x, i-1) );
break;
case LGLSXP:
if (i >= 1 && i <= XLENGTH(x))
return ScalarLogical( LOGICAL_ELT(x, i-1) );
break;
// do the more rare cases as well, since we've already prepared everything:
case CPLXSXP:
if (i >= 1 && i <= XLENGTH(x))
return ScalarComplex( COMPLEX_ELT(x, i-1) );
break;
case RAWSXP:
if (i >= 1 && i <= XLENGTH(x))
return ScalarRaw( RAW_ELT(x, i-1) );
break;
default: break;
}
}
}
else if (cddrArgs != R_NilValue && CDR(cddrArgs) == R_NilValue &&
TAG(cdrArgs) == R_NilValue && TAG(cddrArgs) == R_NilValue) {
/* two indices, not named */
SEXP attr = ATTRIB(x);
if (TAG(attr) == R_DimSymbol && CDR(attr) == R_NilValue) {
/* only attribute of x is 'dim' */
SEXP dim = CAR(attr);
if (TYPEOF(dim) == INTSXP && LENGTH(dim) == 2) {
/* x is a matrix */
SEXP si = CAR(cdrArgs);
SEXP sj = CAR(cddrArgs);
R_xlen_t i = scalarIndex(si);
R_xlen_t j = scalarIndex(sj);
int nrow = INTEGER_ELT(dim, 0);
int ncol = INTEGER_ELT(dim, 1);
if (i > 0 && j > 0 && i <= nrow && j <= ncol) {
/* indices are legal scalars */
R_xlen_t k = i - 1 + nrow * (j - 1);
switch (TYPEOF(x)) {
case REALSXP:
if (k < XLENGTH(x))
return ScalarReal( REAL_ELT(x, k) );
break;
case INTSXP:
if (k < XLENGTH(x))
return ScalarInteger( INTEGER_ELT(x, k) );
break;
case LGLSXP:
if (k < XLENGTH(x))
return ScalarLogical( LOGICAL_ELT(x, k) );
break;
case CPLXSXP:
if (k < XLENGTH(x))
return ScalarComplex( COMPLEX_ELT(x, k) );
break;
case RAWSXP:
if (k < XLENGTH(x))
return ScalarRaw( RAW_ELT(x, k) );
break;
default: break;
}
}
}
}
}
PROTECT(args);
int drop = 1;
ExtractDropArg(args, &drop);
/* This was intended for compatibility with S, */
/* but in fact S does not do this. */
/* FIXME: replace the test by isNull ... ? */
if (x == R_NilValue) {
UNPROTECT(1);
return x;
}
SEXP subs = CDR(args);
int nsubs = length(subs); /* Will be short */
int type = TYPEOF(x);
/* Here coerce pair-based objects into generic vectors. */
/* All subsetting takes place on the generic vector form. */
SEXP ax = x;
if (isVector(x))
PROTECT(ax);
else if (type == LISTSXP || type == LANGSXP) { // *not* <DOTSXP>[] :
SEXP dim = getAttrib(x, R_DimSymbol);
int ndim = length(dim);
if (ndim > 1) {
PROTECT(ax = allocArray(VECSXP, dim));
setAttrib(ax, R_DimNamesSymbol, getAttrib(x, R_DimNamesSymbol));
setAttrib(ax, R_NamesSymbol, getAttrib(x, R_DimNamesSymbol));
}
else {
PROTECT(ax = allocVector(VECSXP, length(x)));
setAttrib(ax, R_NamesSymbol, getAttrib(x, R_NamesSymbol));
}
SEXP px; int i;
for(px = x, i = 0 ; px != R_NilValue ; px = CDR(px))
SET_VECTOR_ELT(ax, i++, CAR(px));
}
else errorcallNotSubsettable(x, call);
/* This is the actual subsetting code. */
/* The separation of arrays and matrices is purely an optimization. */
SEXP ans;
if(nsubs < 2) {
SEXP dim = getAttrib(x, R_DimSymbol);
int ndim = length(dim);
PROTECT(ans = VectorSubset(ax, (nsubs == 1 ? CAR(subs) : R_MissingArg),
call));
/* one-dimensional arrays went through here, and they should
have their dimensions dropped only if the result has
length one and drop == TRUE
*/
if(ndim == 1) {
int len = length(ans);
if(!drop || len > 1) {
// must grab these before the dim is set.
SEXP nm = PROTECT(getAttrib(ans, R_NamesSymbol));
SEXP attr = PROTECT(ScalarInteger(length(ans)));
if(!isNull(getAttrib(dim, R_NamesSymbol)))
setAttrib(attr, R_NamesSymbol, getAttrib(dim, R_NamesSymbol));
setAttrib(ans, R_DimSymbol, attr);
SEXP attrib;
if((attrib = getAttrib(x, R_DimNamesSymbol)) != R_NilValue) {
/* reinstate dimnames, include names of dimnames */
SEXP nattrib = PROTECT(duplicate(attrib));
SET_VECTOR_ELT(nattrib, 0, nm);
setAttrib(ans, R_DimNamesSymbol, nattrib);
setAttrib(ans, R_NamesSymbol, R_NilValue);
UNPROTECT(1);
}
UNPROTECT(2);
}
}
} else {
if (nsubs != length(getAttrib(x, R_DimSymbol)))
errorcall(call, _("incorrect number of dimensions"));
if (nsubs == 2)
ans = MatrixSubset(ax, subs, call, drop);
else
ans = ArraySubset(ax, subs, call, drop);
PROTECT(ans);
}
/* Note: we do not coerce back to pair-based lists. */
/* They are "defunct" in this version of R. */
if (type == LANGSXP) {
ax = ans;
PROTECT(ans = allocList(LENGTH(ax)));
if ( LENGTH(ax) > 0 ) {
SET_TYPEOF(ans, LANGSXP);
SEXP px; int i;
for(px = ans, i = 0 ; px != R_NilValue ; px = CDR(px))
SETCAR(px, VECTOR_ELT(ax, i++));
setAttrib(ans, R_DimSymbol, getAttrib(ax, R_DimSymbol));
setAttrib(ans, R_DimNamesSymbol, getAttrib(ax, R_DimNamesSymbol));
setAttrib(ans, R_NamesSymbol, getAttrib(ax, R_NamesSymbol));
RAISE_NAMED(ans, NAMED(ax)); /* PR#7924 */
}
}
else {
PROTECT(ans);
}
if (ATTRIB(ans) != R_NilValue) { /* remove probably erroneous attr's */
setAttrib(ans, R_TspSymbol, R_NilValue);
#ifdef _S4_subsettable
if(!IS_S4_OBJECT(x))
#endif
setAttrib(ans, R_ClassSymbol, R_NilValue);
}
UNPROTECT(4);
return ans;
}
/* The [[ subset operator. It needs to be fast. */
/* The arguments to this call are evaluated on entry. */
attribute_hidden SEXP do_subset2(SEXP call, SEXP op, SEXP args, SEXP rho)
{
SEXP ans;
/* If the first argument is an object and there is */
/* an appropriate method, we dispatch to that method, */
/* otherwise we evaluate the arguments and fall */
/* through to the generic code below. Note that */
/* evaluation retains any missing argument indicators. */
/* DispatchOrEval internal generic: [[ */
if(R_DispatchOrEvalSP(call, op, "[[", args, rho, &ans)) {
if (NAMED(ans))
ENSURE_NAMEDMAX(ans);
return(ans);
}
/* Method dispatch has failed. */
/* We now run the generic internal code. */
return do_subset2_dflt(call, op, ans, rho);
}
attribute_hidden SEXP do_subset2_dflt(SEXP call, SEXP op, SEXP args, SEXP rho)
{
SEXP ans, dims, dimnames, indx, subs, x;
int i, ndims, nsubs;
int drop = 1;
R_xlen_t offset = 0;
PROTECT(args);
ExtractDropArg(args, &drop);
/* Is partial matching ok? When the exact arg is NA, a warning is
issued if partial matching occurs.
*/
int exact = ExtractExactArg(args);
int pok = (exact == -1) ? exact : ! exact;
x = CAR(args);
/* Get the subscripting and dimensioning information */
/* and check that any array subscripting is compatible. */
subs = CDR(args);
if(0 == (nsubs = length(subs)))
errorcall(call, _("no index specified"));
/* This code was intended for compatibility with S, */
/* but in fact S does not do this. Will anyone notice? */
if (x == R_NilValue) {
UNPROTECT(1); /* args */
if(CAR(subs) == R_MissingArg)
errorcallMissingSubs(x, call);
// else
return x;
}
dims = getAttrib(x, R_DimSymbol);
ndims = length(dims);
if(nsubs > 1 && nsubs != ndims)
errorcall(call, _("incorrect number of subscripts"));
/* code to allow classes to extend environment */
if(TYPEOF(x) == OBJSXP) {
SEXP xs = x;
x = R_getS4DataSlot(x, ANYSXP);
if(x == R_NilValue)
errorcall(call, _("this %s class is not subsettable"),