/
seq.lisp
2353 lines (2130 loc) · 81.9 KB
/
seq.lisp
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
;;;; generic SEQUENCEs
;;;;
;;;; KLUDGE: comment from original CMU CL source:
;;;; Be careful when modifying code. A lot of the structure of the
;;;; code is affected by the fact that compiler transforms use the
;;;; lower level support functions. If transforms are written for
;;;; some sequence operation, note how the END argument is handled
;;;; in other operations with transforms.
;;;; This software is part of the SBCL system. See the README file for
;;;; more information.
;;;;
;;;; This software is derived from the CMU CL system, which was
;;;; written at Carnegie Mellon University and released into the
;;;; public domain. The software is in the public domain and is
;;;; provided with absolutely no warranty. See the COPYING and CREDITS
;;;; files for more information.
(in-package "SB!IMPL")
;;;; utilities
(eval-when (:compile-toplevel)
(defparameter *sequence-keyword-info*
;; (name default supplied-p adjustment new-type)
`((count nil
nil
(etypecase count
(null (1- most-positive-fixnum))
(fixnum (max 0 count))
(integer (if (minusp count)
0
(1- most-positive-fixnum))))
(mod #.sb!xc:most-positive-fixnum))
,@(mapcan (lambda (names)
(destructuring-bind (start end length sequence) names
(list
`(,start
0
nil
(if (<= 0 ,start ,length)
,start
(signal-bounding-indices-bad-error ,sequence
,start ,end))
index)
`(,end
nil
nil
(if (or (null ,end) (<= ,start ,end ,length))
;; Defaulting of NIL is done inside the
;; bodies, for ease of sharing with compiler
;; transforms.
;;
;; FIXME: defend against non-number non-NIL
;; stuff?
,end
(signal-bounding-indices-bad-error ,sequence
,start ,end))
(or null index)))))
'((start end length sequence)
(start1 end1 length1 sequence1)
(start2 end2 length2 sequence2)))
(key nil
nil
(and key (%coerce-callable-to-fun key))
(or null function))
(test #'eql
nil
(%coerce-callable-to-fun test)
function)
(test-not nil
nil
(and test-not (%coerce-callable-to-fun test-not))
(or null function))
))
(sb!xc:defmacro define-sequence-traverser (name args &body body)
(multiple-value-bind (body declarations docstring)
(parse-body body :doc-string-allowed t)
(collect ((new-args) (new-declarations) (adjustments))
(dolist (arg args)
(case arg
;; FIXME: make this robust. And clean.
((sequence)
(new-args arg)
(adjustments '(length (etypecase sequence
(list (length sequence))
(vector (length sequence)))))
(new-declarations '(type index length)))
((sequence1)
(new-args arg)
(adjustments '(length1 (etypecase sequence1
(list (length sequence1))
(vector (length sequence1)))))
(new-declarations '(type index length1)))
((sequence2)
(new-args arg)
(adjustments '(length2 (etypecase sequence2
(list (length sequence2))
(vector (length sequence2)))))
(new-declarations '(type index length2)))
(t (let ((info (cdr (assoc arg *sequence-keyword-info*))))
(cond (info
(destructuring-bind (default supplied-p adjuster type) info
(new-args `(,arg ,default ,@(when supplied-p (list supplied-p))))
(adjustments `(,arg ,adjuster))
(new-declarations `(type ,type ,arg))))
(t (new-args arg)))))))
`(defun ,name ,(new-args)
,@(when docstring (list docstring))
,@declarations
(let* (,@(adjustments))
(declare ,@(new-declarations))
,@body)))))
;;; SEQ-DISPATCH does an efficient type-dispatch on the given SEQUENCE.
;;;
;;; FIXME: It might be worth making three cases here, LIST,
;;; SIMPLE-VECTOR, and VECTOR, instead of the current LIST and VECTOR.
;;; It tends to make code run faster but be bigger; some benchmarking
;;; is needed to decide.
(sb!xc:defmacro seq-dispatch (sequence list-form array-form)
`(if (listp ,sequence)
,list-form
,array-form))
(sb!xc:defmacro make-sequence-like (sequence length)
#!+sb-doc
"Return a sequence of the same type as SEQUENCE and the given LENGTH."
`(if (typep ,sequence 'list)
(make-list ,length)
(progn
;; This is only called from places which have already deduced
;; that the SEQUENCE argument is actually a sequence. So
;; this would be a candidate place for (AVER (TYPEP ,SEQUENCE
;; 'VECTOR)), except that this seems to be a performance
;; hotspot.
(make-array ,length
:element-type (array-element-type ,sequence)))))
(sb!xc:defmacro bad-sequence-type-error (type-spec)
`(error 'simple-type-error
:datum ,type-spec
;; FIXME: This is actually wrong, and should be something
;; like (SATISFIES IS-A-VALID-SEQUENCE-TYPE-SPECIFIER-P).
:expected-type 'sequence
:format-control "~S is a bad type specifier for sequences."
:format-arguments (list ,type-spec)))
(sb!xc:defmacro sequence-type-length-mismatch-error (type length)
`(error 'simple-type-error
:datum ,length
:expected-type (cond ((array-type-p ,type)
`(eql ,(car (array-type-dimensions ,type))))
((type= ,type (specifier-type 'null))
'(eql 0))
((cons-type-p ,type)
'(integer 1))
(t (bug "weird type in S-T-L-M-ERROR")))
;; FIXME: this format control causes ugly printing. There's
;; probably some ~<~@:_~> incantation that would make it
;; nicer. -- CSR, 2002-10-18
:format-control "The length requested (~S) does not match the type restriction in ~S."
:format-arguments (list ,length (type-specifier ,type))))
(sb!xc:defmacro sequence-type-too-hairy (type-spec)
;; FIXME: Should this be a BUG? I'm inclined to think not; there are
;; words that give some but not total support to this position in
;; ANSI. Essentially, we are justified in throwing this on
;; e.g. '(OR SIMPLE-VECTOR (VECTOR FIXNUM)), but maybe not (by ANSI)
;; on '(CONS * (CONS * NULL)) -- CSR, 2002-10-18
`(error 'simple-type-error
:datum ,type-spec
;; FIXME: as in BAD-SEQUENCE-TYPE-ERROR, this is wrong.
:expected-type 'sequence
:format-control "~S is too hairy for sequence functions."
:format-arguments (list ,type-spec)))
) ; EVAL-WHEN
;;; It's possible with some sequence operations to declare the length
;;; of a result vector, and to be safe, we really ought to verify that
;;; the actual result has the declared length.
(defun vector-of-checked-length-given-length (vector declared-length)
(declare (type vector vector))
(declare (type index declared-length))
(let ((actual-length (length vector)))
(unless (= actual-length declared-length)
(error 'simple-type-error
:datum vector
:expected-type `(vector ,declared-length)
:format-control
"Vector length (~W) doesn't match declared length (~W)."
:format-arguments (list actual-length declared-length))))
vector)
(defun sequence-of-checked-length-given-type (sequence result-type)
(let ((ctype (specifier-type result-type)))
(if (not (array-type-p ctype))
sequence
(let ((declared-length (first (array-type-dimensions ctype))))
(if (eq declared-length '*)
sequence
(vector-of-checked-length-given-length sequence
declared-length))))))
(declaim (ftype (function (sequence index) nil) signal-index-too-large-error))
(defun signal-index-too-large-error (sequence index)
(let* ((length (length sequence))
(max-index (and (plusp length)
(1- length))))
(error 'index-too-large-error
:datum index
:expected-type (if max-index
`(integer 0 ,max-index)
;; This seems silly, is there something better?
'(integer 0 (0))))))
(defun signal-bounding-indices-bad-error (sequence start end)
(let ((length (length sequence)))
(error 'bounding-indices-bad-error
:datum (cons start end)
:expected-type `(cons (integer 0 ,length)
(or null (integer ,start ,length)))
:object sequence)))
(defun elt (sequence index)
#!+sb-doc "Return the element of SEQUENCE specified by INDEX."
(etypecase sequence
(list
(do ((count index (1- count))
(list sequence (cdr list)))
((= count 0)
(if (endp list)
(signal-index-too-large-error sequence index)
(car list)))
(declare (type (integer 0) count))))
(vector
(when (>= index (length sequence))
(signal-index-too-large-error sequence index))
(aref sequence index))))
(defun %setelt (sequence index newval)
#!+sb-doc "Store NEWVAL as the component of SEQUENCE specified by INDEX."
(etypecase sequence
(list
(do ((count index (1- count))
(seq sequence))
((= count 0) (rplaca seq newval) newval)
(declare (fixnum count))
(if (atom (cdr seq))
(signal-index-too-large-error sequence index)
(setq seq (cdr seq)))))
(vector
(when (>= index (length sequence))
(signal-index-too-large-error sequence index))
(setf (aref sequence index) newval))))
(defun length (sequence)
#!+sb-doc "Return an integer that is the length of SEQUENCE."
(etypecase sequence
(vector (length (truly-the vector sequence)))
(list (length (truly-the list sequence)))))
(defun make-sequence (type length &key (initial-element nil iep))
#!+sb-doc
"Return a sequence of the given TYPE and LENGTH, with elements initialized
to INITIAL-ELEMENT."
(declare (fixnum length))
(let* ((adjusted-type
(typecase type
(atom (cond
((eq type 'string) '(vector character))
((eq type 'simple-string) '(simple-array character (*)))
(t type)))
(cons (cond
((eq (car type) 'string) `(vector character ,@(cdr type)))
((eq (car type) 'simple-string)
`(simple-array character ,@(when (cdr type)
(list (cdr type)))))
(t type)))
(t type)))
(type (specifier-type adjusted-type)))
(cond ((csubtypep type (specifier-type 'list))
(cond
((type= type (specifier-type 'list))
(make-list length :initial-element initial-element))
((eq type *empty-type*)
(bad-sequence-type-error nil))
((type= type (specifier-type 'null))
(if (= length 0)
'nil
(sequence-type-length-mismatch-error type length)))
((cons-type-p type)
(multiple-value-bind (min exactp)
(sb!kernel::cons-type-length-info type)
(if exactp
(unless (= length min)
(sequence-type-length-mismatch-error type length))
(unless (>= length min)
(sequence-type-length-mismatch-error type length)))
(make-list length :initial-element initial-element)))
;; We'll get here for e.g. (OR NULL (CONS INTEGER *)),
;; which may seem strange and non-ideal, but then I'd say
;; it was stranger to feed that type in to MAKE-SEQUENCE.
(t (sequence-type-too-hairy (type-specifier type)))))
((csubtypep type (specifier-type 'vector))
(cond
(;; is it immediately obvious what the result type is?
(typep type 'array-type)
(progn
(aver (= (length (array-type-dimensions type)) 1))
(let* ((etype (type-specifier
(array-type-specialized-element-type type)))
(etype (if (eq etype '*) t etype))
(type-length (car (array-type-dimensions type))))
(unless (or (eq type-length '*)
(= type-length length))
(sequence-type-length-mismatch-error type length))
;; FIXME: These calls to MAKE-ARRAY can't be
;; open-coded, as the :ELEMENT-TYPE argument isn't
;; constant. Probably we ought to write a
;; DEFTRANSFORM for MAKE-SEQUENCE. -- CSR,
;; 2002-07-22
(if iep
(make-array length :element-type etype
:initial-element initial-element)
(make-array length :element-type etype)))))
(t (sequence-type-too-hairy (type-specifier type)))))
(t (bad-sequence-type-error (type-specifier type))))))
;;;; SUBSEQ
;;;;
;;;; The support routines for SUBSEQ are used by compiler transforms,
;;;; so we worry about dealing with END being supplied or defaulting
;;;; to NIL at this level.
(defun vector-subseq* (sequence start &optional end)
(declare (type vector sequence))
(declare (type index start))
(declare (type (or null index) end))
(when (null end)
(setf end (length sequence)))
(unless (<= 0 start end (length sequence))
(signal-bounding-indices-bad-error sequence start end))
(do ((old-index start (1+ old-index))
(new-index 0 (1+ new-index))
(copy (make-sequence-like sequence (- end start))))
((= old-index end) copy)
(declare (fixnum old-index new-index))
(setf (aref copy new-index)
(aref sequence old-index))))
(defun list-subseq* (sequence start &optional end)
(declare (type list sequence))
;; the INDEX declaration isn't actually mandatory, but it's true for
;; all practical purposes.
(declare (type index start))
(declare (type (or null index) end))
(do ((list sequence (cdr list))
(index 0 (1+ index))
(result nil))
(nil)
(cond
((null list) (if (or (and end (> end index))
(< index start))
(signal-bounding-indices-bad-error sequence start end)
(return (nreverse result))))
((< index start) nil)
((and end (= index end)) (return (nreverse result)))
(t (push (car list) result)))))
(defun subseq (sequence start &optional end)
#!+sb-doc
"Return a copy of a subsequence of SEQUENCE starting with element number
START and continuing to the end of SEQUENCE or the optional END."
(seq-dispatch sequence
(list-subseq* sequence start end)
(vector-subseq* sequence start end)))
;;;; COPY-SEQ
(eval-when (:compile-toplevel :execute)
(sb!xc:defmacro vector-copy-seq (sequence)
`(let ((length (length (the vector ,sequence))))
(declare (fixnum length))
(do ((index 0 (1+ index))
(copy (make-sequence-like ,sequence length)))
((= index length) copy)
(declare (fixnum index))
(setf (aref copy index) (aref ,sequence index)))))
(sb!xc:defmacro list-copy-seq (list)
`(if (atom ,list) '()
(let ((result (cons (car ,list) '()) ))
(do ((x (cdr ,list) (cdr x))
(splice result
(cdr (rplacd splice (cons (car x) '() ))) ))
((atom x) (unless (null x)
(rplacd splice x))
result)))))
) ; EVAL-WHEN
(defun copy-seq (sequence)
#!+sb-doc "Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ."
(seq-dispatch sequence
(list-copy-seq* sequence)
(vector-copy-seq* sequence)))
;;; internal frobs
(defun list-copy-seq* (sequence)
(list-copy-seq sequence))
(defun vector-copy-seq* (sequence)
(declare (type vector sequence))
(vector-copy-seq sequence))
;;;; FILL
(eval-when (:compile-toplevel :execute)
(sb!xc:defmacro vector-fill (sequence item start end)
`(do ((index ,start (1+ index)))
((= index (the fixnum ,end)) ,sequence)
(declare (fixnum index))
(setf (aref ,sequence index) ,item)))
(sb!xc:defmacro list-fill (sequence item start end)
`(do ((current (nthcdr ,start ,sequence) (cdr current))
(index ,start (1+ index)))
((or (atom current) (and end (= index (the fixnum ,end))))
sequence)
(declare (fixnum index))
(rplaca current ,item)))
) ; EVAL-WHEN
;;; The support routines for FILL are used by compiler transforms, so we
;;; worry about dealing with END being supplied or defaulting to NIL
;;; at this level.
(defun list-fill* (sequence item start end)
(declare (list sequence))
(list-fill sequence item start end))
(defun vector-fill* (sequence item start end)
(declare (vector sequence))
(when (null end) (setq end (length sequence)))
(vector-fill sequence item start end))
(define-sequence-traverser fill (sequence item &key start end)
#!+sb-doc "Replace the specified elements of SEQUENCE with ITEM."
(seq-dispatch sequence
(list-fill* sequence item start end)
(vector-fill* sequence item start end)))
;;;; REPLACE
(eval-when (:compile-toplevel :execute)
;;; If we are copying around in the same vector, be careful not to copy the
;;; same elements over repeatedly. We do this by copying backwards.
(sb!xc:defmacro mumble-replace-from-mumble ()
`(if (and (eq target-sequence source-sequence) (> target-start source-start))
(let ((nelts (min (- target-end target-start)
(- source-end source-start))))
(do ((target-index (+ (the fixnum target-start) (the fixnum nelts) -1)
(1- target-index))
(source-index (+ (the fixnum source-start) (the fixnum nelts) -1)
(1- source-index)))
((= target-index (the fixnum (1- target-start))) target-sequence)
(declare (fixnum target-index source-index))
;; disable bounds checking
(declare (optimize (safety 0)))
(setf (aref target-sequence target-index)
(aref source-sequence source-index))))
(do ((target-index target-start (1+ target-index))
(source-index source-start (1+ source-index)))
((or (= target-index (the fixnum target-end))
(= source-index (the fixnum source-end)))
target-sequence)
(declare (fixnum target-index source-index))
;; disable bounds checking
(declare (optimize (safety 0)))
(setf (aref target-sequence target-index)
(aref source-sequence source-index)))))
(sb!xc:defmacro list-replace-from-list ()
`(if (and (eq target-sequence source-sequence) (> target-start source-start))
(let ((new-elts (subseq source-sequence source-start
(+ (the fixnum source-start)
(the fixnum
(min (- (the fixnum target-end)
(the fixnum target-start))
(- (the fixnum source-end)
(the fixnum source-start))))))))
(do ((n new-elts (cdr n))
(o (nthcdr target-start target-sequence) (cdr o)))
((null n) target-sequence)
(rplaca o (car n))))
(do ((target-index target-start (1+ target-index))
(source-index source-start (1+ source-index))
(target-sequence-ref (nthcdr target-start target-sequence)
(cdr target-sequence-ref))
(source-sequence-ref (nthcdr source-start source-sequence)
(cdr source-sequence-ref)))
((or (= target-index (the fixnum target-end))
(= source-index (the fixnum source-end))
(null target-sequence-ref) (null source-sequence-ref))
target-sequence)
(declare (fixnum target-index source-index))
(rplaca target-sequence-ref (car source-sequence-ref)))))
(sb!xc:defmacro list-replace-from-mumble ()
`(do ((target-index target-start (1+ target-index))
(source-index source-start (1+ source-index))
(target-sequence-ref (nthcdr target-start target-sequence)
(cdr target-sequence-ref)))
((or (= target-index (the fixnum target-end))
(= source-index (the fixnum source-end))
(null target-sequence-ref))
target-sequence)
(declare (fixnum source-index target-index))
(rplaca target-sequence-ref (aref source-sequence source-index))))
(sb!xc:defmacro mumble-replace-from-list ()
`(do ((target-index target-start (1+ target-index))
(source-index source-start (1+ source-index))
(source-sequence (nthcdr source-start source-sequence)
(cdr source-sequence)))
((or (= target-index (the fixnum target-end))
(= source-index (the fixnum source-end))
(null source-sequence))
target-sequence)
(declare (fixnum target-index source-index))
(setf (aref target-sequence target-index) (car source-sequence))))
) ; EVAL-WHEN
;;;; The support routines for REPLACE are used by compiler transforms, so we
;;;; worry about dealing with END being supplied or defaulting to NIL
;;;; at this level.
(defun list-replace-from-list* (target-sequence source-sequence target-start
target-end source-start source-end)
(when (null target-end) (setq target-end (length target-sequence)))
(when (null source-end) (setq source-end (length source-sequence)))
(list-replace-from-list))
(defun list-replace-from-vector* (target-sequence source-sequence target-start
target-end source-start source-end)
(when (null target-end) (setq target-end (length target-sequence)))
(when (null source-end) (setq source-end (length source-sequence)))
(list-replace-from-mumble))
(defun vector-replace-from-list* (target-sequence source-sequence target-start
target-end source-start source-end)
(when (null target-end) (setq target-end (length target-sequence)))
(when (null source-end) (setq source-end (length source-sequence)))
(mumble-replace-from-list))
(defun vector-replace-from-vector* (target-sequence source-sequence
target-start target-end source-start
source-end)
(when (null target-end) (setq target-end (length target-sequence)))
(when (null source-end) (setq source-end (length source-sequence)))
(mumble-replace-from-mumble))
(defun simple-character-string-replace-from-simple-character-string*
(target-sequence source-sequence
target-start target-end source-start source-end)
(declare (type (simple-array character (*)) target-sequence source-sequence))
(when (null target-end) (setq target-end (length target-sequence)))
(when (null source-end) (setq source-end (length source-sequence)))
(mumble-replace-from-mumble))
(define-sequence-traverser replace
(sequence1 sequence2 &key start1 end1 start2 end2)
#!+sb-doc
"The target sequence is destructively modified by copying successive
elements into it from the source sequence."
(let* (;; KLUDGE: absent either rewriting FOO-REPLACE-FROM-BAR, or
;; excessively polluting DEFINE-SEQUENCE-TRAVERSER, we rebind
;; these things here so that legacy code gets the names it's
;; expecting. We could use &AUX instead :-/.
(target-sequence sequence1)
(source-sequence sequence2)
(target-start start1)
(source-start start2)
(target-end (or end1 length1))
(source-end (or end2 length2)))
(seq-dispatch target-sequence
(seq-dispatch source-sequence
(list-replace-from-list)
(list-replace-from-mumble))
(seq-dispatch source-sequence
(mumble-replace-from-list)
(mumble-replace-from-mumble)))))
;;;; REVERSE
(eval-when (:compile-toplevel :execute)
(sb!xc:defmacro vector-reverse (sequence)
`(let ((length (length ,sequence)))
(declare (fixnum length))
(do ((forward-index 0 (1+ forward-index))
(backward-index (1- length) (1- backward-index))
(new-sequence (make-sequence-like sequence length)))
((= forward-index length) new-sequence)
(declare (fixnum forward-index backward-index))
(setf (aref new-sequence forward-index)
(aref ,sequence backward-index)))))
(sb!xc:defmacro list-reverse-macro (sequence)
`(do ((new-list ()))
((endp ,sequence) new-list)
(push (pop ,sequence) new-list)))
) ; EVAL-WHEN
(defun reverse (sequence)
#!+sb-doc
"Return a new sequence containing the same elements but in reverse order."
(seq-dispatch sequence
(list-reverse* sequence)
(vector-reverse* sequence)))
;;; internal frobs
(defun list-reverse* (sequence)
(list-reverse-macro sequence))
(defun vector-reverse* (sequence)
(vector-reverse sequence))
;;;; NREVERSE
(eval-when (:compile-toplevel :execute)
(sb!xc:defmacro vector-nreverse (sequence)
`(let ((length (length (the vector ,sequence))))
(when (>= length 2)
(do ((left-index 0 (1+ left-index))
(right-index (1- length) (1- right-index)))
((<= right-index left-index))
(declare (type index left-index right-index))
(rotatef (aref ,sequence left-index)
(aref ,sequence right-index))))
,sequence))
(sb!xc:defmacro list-nreverse-macro (list)
`(do ((1st (cdr ,list) (if (endp 1st) 1st (cdr 1st)))
(2nd ,list 1st)
(3rd '() 2nd))
((atom 2nd) 3rd)
(rplacd 2nd 3rd)))
) ; EVAL-WHEN
(defun list-nreverse* (sequence)
(list-nreverse-macro sequence))
(defun vector-nreverse* (sequence)
(vector-nreverse sequence))
(defun nreverse (sequence)
#!+sb-doc
"Return a sequence of the same elements in reverse order; the argument
is destroyed."
(seq-dispatch sequence
(list-nreverse* sequence)
(vector-nreverse* sequence)))
;;;; CONCATENATE
(eval-when (:compile-toplevel :execute)
(sb!xc:defmacro concatenate-to-list (sequences)
`(let ((result (list nil)))
(do ((sequences ,sequences (cdr sequences))
(splice result))
((null sequences) (cdr result))
(let ((sequence (car sequences)))
;; FIXME: It appears to me that this and CONCATENATE-TO-MUMBLE
;; could benefit from a DO-SEQUENCE macro.
(seq-dispatch sequence
(do ((sequence sequence (cdr sequence)))
((atom sequence))
(setq splice
(cdr (rplacd splice (list (car sequence))))))
(do ((index 0 (1+ index))
(length (length sequence)))
((= index length))
(declare (fixnum index length))
(setq splice
(cdr (rplacd splice
(list (aref sequence index)))))))))))
(sb!xc:defmacro concatenate-to-mumble (output-type-spec sequences)
`(do ((seqs ,sequences (cdr seqs))
(total-length 0)
(lengths ()))
((null seqs)
(do ((sequences ,sequences (cdr sequences))
(lengths lengths (cdr lengths))
(index 0)
(result (make-sequence ,output-type-spec total-length)))
((= index total-length) result)
(declare (fixnum index))
(let ((sequence (car sequences)))
(seq-dispatch sequence
(do ((sequence sequence (cdr sequence)))
((atom sequence))
(setf (aref result index) (car sequence))
(setq index (1+ index)))
(do ((jndex 0 (1+ jndex))
(this-length (car lengths)))
((= jndex this-length))
(declare (fixnum jndex this-length))
(setf (aref result index)
(aref sequence jndex))
(setq index (1+ index)))))))
(let ((length (length (car seqs))))
(declare (fixnum length))
(setq lengths (nconc lengths (list length)))
(setq total-length (+ total-length length)))))
) ; EVAL-WHEN
(defun concatenate (output-type-spec &rest sequences)
#!+sb-doc
"Return a new sequence of all the argument sequences concatenated together
which shares no structure with the original argument sequences of the
specified OUTPUT-TYPE-SPEC."
(let ((type (specifier-type output-type-spec)))
(cond
((csubtypep type (specifier-type 'list))
(cond
((type= type (specifier-type 'list))
(apply #'concat-to-list* sequences))
((eq type *empty-type*)
(bad-sequence-type-error nil))
((type= type (specifier-type 'null))
(if (every (lambda (x) (or (null x)
(and (vectorp x) (= (length x) 0))))
sequences)
'nil
(sequence-type-length-mismatch-error
type
;; FIXME: circular list issues.
(reduce #'+ sequences :key #'length))))
((cons-type-p type)
(multiple-value-bind (min exactp)
(sb!kernel::cons-type-length-info type)
(let ((length (reduce #'+ sequences :key #'length)))
(if exactp
(unless (= length min)
(sequence-type-length-mismatch-error type length))
(unless (>= length min)
(sequence-type-length-mismatch-error type length)))
(apply #'concat-to-list* sequences))))
(t (sequence-type-too-hairy (type-specifier type)))))
((csubtypep type (specifier-type 'vector))
(apply #'concat-to-simple* output-type-spec sequences))
(t
(bad-sequence-type-error output-type-spec)))))
;;; internal frobs
;;; FIXME: These are weird. They're never called anywhere except in
;;; CONCATENATE. It seems to me that the macros ought to just
;;; be expanded directly in CONCATENATE, or in CONCATENATE-STRING
;;; and CONCATENATE-LIST variants. Failing that, these ought to be local
;;; functions (FLET).
(defun concat-to-list* (&rest sequences)
(concatenate-to-list sequences))
(defun concat-to-simple* (type &rest sequences)
(concatenate-to-mumble type sequences))
;;;; MAP and MAP-INTO
;;; helper functions to handle arity-1 subcases of MAP
(declaim (ftype (function (function sequence) list) %map-list-arity-1))
(declaim (ftype (function (function sequence) simple-vector)
%map-simple-vector-arity-1))
(macrolet ((dosequence ((i sequence) &body body)
(once-only ((sequence sequence))
`(etypecase ,sequence
(list (dolist (,i ,sequence) ,@body))
(simple-vector (dovector (,i sequence) ,@body))
(vector (dovector (,i sequence) ,@body))))))
(defun %map-to-list-arity-1 (fun sequence)
(let ((reversed-result nil)
(really-fun (%coerce-callable-to-fun fun)))
(dosequence (element sequence)
(push (funcall really-fun element)
reversed-result))
(nreverse reversed-result)))
(defun %map-to-simple-vector-arity-1 (fun sequence)
(let ((result (make-array (length sequence)))
(index 0)
(really-fun (%coerce-callable-to-fun fun)))
(declare (type index index))
(dosequence (element sequence)
(setf (aref result index)
(funcall really-fun element))
(incf index))
result))
(defun %map-for-effect-arity-1 (fun sequence)
(let ((really-fun (%coerce-callable-to-fun fun)))
(dosequence (element sequence)
(funcall really-fun element)))
nil))
;;; helper functions to handle arity-N subcases of MAP
;;;
;;; KLUDGE: This is hairier, and larger, than need be, because we
;;; don't have DYNAMIC-EXTENT. With DYNAMIC-EXTENT, we could define
;;; %MAP-FOR-EFFECT, and then implement the
;;; other %MAP-TO-FOO functions reasonably efficiently by passing closures to
;;; %MAP-FOR-EFFECT. (DYNAMIC-EXTENT would help a little by avoiding
;;; consing each closure, and would help a lot by allowing us to define
;;; a closure (LAMBDA (&REST REST) <do something with (APPLY FUN REST)>)
;;; with the REST list allocated with DYNAMIC-EXTENT. -- WHN 20000920
(macrolet (;; Execute BODY in a context where the machinery for
;; UPDATED-MAP-APPLY-ARGS has been set up.
(with-map-state (sequences &body body)
`(let* ((%sequences ,sequences)
(%iters (mapcar (lambda (sequence)
(etypecase sequence
(list sequence)
(vector 0)))
%sequences))
(%apply-args (make-list (length %sequences))))
(declare (type list %sequences %iters %apply-args))
,@body))
;; Return a list of args to pass to APPLY for the next
;; function call in the mapping, or NIL if no more function
;; calls should be made (because we've reached the end of a
;; sequence arg).
(updated-map-apply-args ()
'(do ((in-sequences %sequences (cdr in-sequences))
(in-iters %iters (cdr in-iters))
(in-apply-args %apply-args (cdr in-apply-args)))
((null in-sequences)
%apply-args)
(declare (type list in-sequences in-iters in-apply-args))
(let ((i (car in-iters)))
(declare (type (or list index) i))
(if (listp i)
(if (null i) ; if end of this sequence
(return nil)
(setf (car in-apply-args) (car i)
(car in-iters) (cdr i)))
(let ((v (the vector (car in-sequences))))
(if (>= i (length v)) ; if end of this sequence
(return nil)
(setf (car in-apply-args) (aref v i)
(car in-iters) (1+ i)))))))))
(defun %map-to-list (func sequences)
(declare (type function func))
(declare (type list sequences))
(with-map-state sequences
(loop with updated-map-apply-args
while (setf updated-map-apply-args (updated-map-apply-args))
collect (apply func updated-map-apply-args))))
(defun %map-to-vector (output-type-spec func sequences)
(declare (type function func))
(declare (type list sequences))
(let ((min-len (with-map-state sequences
(do ((counter 0 (1+ counter)))
;; Note: Doing everything in
;; UPDATED-MAP-APPLY-ARGS here is somewhat
;; wasteful; we even do some extra consing.
;; And stepping over every element of
;; VECTORs, instead of just grabbing their
;; LENGTH, is also wasteful. But it's easy
;; and safe. (If you do rewrite it, please
;; try to make sure that
;; (MAP NIL #'F SOME-CIRCULAR-LIST #(1))
;; does the right thing.)
((not (updated-map-apply-args))
counter)
(declare (type index counter))))))
(declare (type index min-len))
(with-map-state sequences
(let ((result (make-sequence output-type-spec min-len))
(index 0))
(declare (type index index))
(loop with updated-map-apply-args
while (setf updated-map-apply-args (updated-map-apply-args))
do
(setf (aref result index)
(apply func updated-map-apply-args))
(incf index))
result))))
(defun %map-for-effect (func sequences)
(declare (type function func))
(declare (type list sequences))
(with-map-state sequences
(loop with updated-map-apply-args
while (setf updated-map-apply-args (updated-map-apply-args))
do
(apply func updated-map-apply-args))
nil)))
"FUNCTION must take as many arguments as there are sequences provided.
The result is a sequence of type OUTPUT-TYPE-SPEC such that element I
is the result of applying FUNCTION to element I of each of the argument
sequences."
;;; %MAP is just MAP without the final just-to-be-sure check that
;;; length of the output sequence matches any length specified
;;; in RESULT-TYPE.
(defun %map (result-type function first-sequence &rest more-sequences)
(let ((really-fun (%coerce-callable-to-fun function))
(type (specifier-type result-type)))
;; Handle one-argument MAP NIL specially, using ETYPECASE to turn
;; it into something which can be DEFTRANSFORMed away. (It's
;; fairly important to handle this case efficiently, since
;; quantifiers like SOME are transformed into this case, and since
;; there's no consing overhead to dwarf our inefficiency.)
(if (and (null more-sequences)
(null result-type))
(%map-for-effect-arity-1 really-fun first-sequence)
;; Otherwise, use the industrial-strength full-generality
;; approach, consing O(N-ARGS) temporary storage (which can have
;; DYNAMIC-EXTENT), then using O(N-ARGS * RESULT-LENGTH) time.
(let ((sequences (cons first-sequence more-sequences)))
(cond
((eq type *empty-type*) (%map-for-effect really-fun sequences))
((csubtypep type (specifier-type 'list))
(%map-to-list really-fun sequences))
((csubtypep type (specifier-type 'vector))
(%map-to-vector result-type really-fun sequences))
(t
(bad-sequence-type-error result-type)))))))
(defun map (result-type function first-sequence &rest more-sequences)
(apply #'%map
result-type
function
first-sequence
more-sequences))
;;; KLUDGE: MAP has been rewritten substantially since the fork from
;;; CMU CL in order to give reasonable performance, but this
;;; implementation of MAP-INTO still has the same problems as the old
;;; MAP code. Ideally, MAP-INTO should be rewritten to be efficient in
;;; the same way that the corresponding cases of MAP have been
;;; rewritten. Instead of doing it now, though, it's easier to wait
;;; until we have DYNAMIC-EXTENT, at which time it should become
;;; extremely easy to define a reasonably efficient MAP-INTO in terms
;;; of (MAP NIL ..). -- WHN 20000920
(defun map-into (result-sequence function &rest sequences)
(let* ((fp-result
(and (arrayp result-sequence)
(array-has-fill-pointer-p result-sequence)))
(len (apply #'min
(if fp-result
(array-dimension result-sequence 0)
(length result-sequence))
(mapcar #'length sequences))))
(when fp-result
(setf (fill-pointer result-sequence) len))
(let ((really-fun (%coerce-callable-to-fun function)))
(dotimes (index len)
(setf (elt result-sequence index)
(apply really-fun
(mapcar (lambda (seq) (elt seq index))
sequences))))))
result-sequence)
;;;; quantifiers
;;; We borrow the logic from (MAP NIL ..) to handle iteration over
;;; arbitrary sequence arguments, both in the full call case and in
;;; the open code case.
(macrolet ((defquantifier (name found-test found-result
&key doc (unfound-result (not found-result)))
`(progn
;; KLUDGE: It would be really nice if we could simply
;; do something like this
;; (declaim (inline ,name))
;; (defun ,name (pred first-seq &rest more-seqs)
;; ,doc
;; (flet ((map-me (&rest rest)
;; (let ((pred-value (apply pred rest)))
;; (,found-test pred-value
;; (return-from ,name
;; ,found-result)))))
;; (declare (inline map-me))
;; (apply #'map nil #'map-me first-seq more-seqs)
;; ,unfound-result))
;; but Python doesn't seem to be smart enough about
;; inlining and APPLY to recognize that it can use