/
list.lisp
1453 lines (1353 loc) · 55 KB
/
list.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
;;;; functions to implement lists
;;;; 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")
;;; Limitation: no list might have more than INDEX conses.
;;;; KLUDGE: comment from CMU CL, what does it mean?
;;;; NSUBLIS, things at the beginning broken.
;;;; -- WHN 20000127
(declaim (maybe-inline
tree-equal %setnth nthcdr nth
tailp union
nunion intersection nintersection set-difference nset-difference
set-exclusive-or nset-exclusive-or subsetp acons
subst subst-if
;; NSUBLIS is >400 lines of assembly. How is it helpful to inline?
subst-if-not nsubst nsubst-if nsubst-if-not sublis nsublis))
;;; These functions perform basic list operations.
(defun car (list) "Return the 1st object in a list." (car list))
(defun cdr (list)
"Return all but the first object in a list."
(cdr list))
(defun cadr (list) "Return the 2nd object in a list." (cadr list))
(defun cdar (list) "Return the cdr of the 1st sublist." (cdar list))
(defun caar (list) "Return the car of the 1st sublist." (caar list))
(defun cddr (list)
"Return all but the 1st two objects of a list."
(cddr list))
(defun caddr (list)
"Return the 1st object in the cddr of a list."
(caddr list))
(defun caadr (list)
"Return the 1st object in the cadr of a list."
(caadr list))
(defun caaar (list)
"Return the 1st object in the caar of a list."
(caaar list))
(defun cdaar (list)
"Return the cdr of the caar of a list."
(cdaar list))
(defun cddar (list)
"Return the cdr of the cdar of a list."
(cddar list))
(defun cdddr (list)
"Return the cdr of the cddr of a list."
(cdddr list))
(defun cadar (list)
"Return the car of the cdar of a list."
(cadar list))
(defun cdadr (list)
"Return the cdr of the cadr of a list."
(cdadr list))
(defun caaaar (list)
"Return the car of the caaar of a list."
(caaaar list))
(defun caaadr (list)
"Return the car of the caadr of a list."
(caaadr list))
(defun caaddr (list)
"Return the car of the caddr of a list."
(caaddr list))
(defun cadddr (list)
"Return the car of the cdddr of a list."
(cadddr list))
(defun cddddr (list)
"Return the cdr of the cdddr of a list."
(cddddr list))
(defun cdaaar (list)
"Return the cdr of the caaar of a list."
(cdaaar list))
(defun cddaar (list)
"Return the cdr of the cdaar of a list."
(cddaar list))
(defun cdddar (list)
"Return the cdr of the cddar of a list."
(cdddar list))
(defun caadar (list)
"Return the car of the cadar of a list."
(caadar list))
(defun cadaar (list)
"Return the car of the cdaar of a list."
(cadaar list))
(defun cadadr (list)
"Return the car of the cdadr of a list."
(cadadr list))
(defun caddar (list)
"Return the car of the cddar of a list."
(caddar list))
(defun cdaadr (list)
"Return the cdr of the caadr of a list."
(cdaadr list))
(defun cdadar (list)
"Return the cdr of the cadar of a list."
(cdadar list))
(defun cdaddr (list)
"Return the cdr of the caddr of a list."
(cdaddr list))
(defun cddadr (list)
"Return the cdr of the cdadr of a list."
(cddadr list))
(defun cons (se1 se2)
"Return a list with SE1 as the CAR and SE2 as the CDR."
(cons se1 se2))
(declaim (maybe-inline tree-equal-test tree-equal-test-not))
(defun tree-equal-test-not (x y test-not)
(declare (type function test-not))
(cond ((consp x)
(and (consp y)
(tree-equal-test-not (car x) (car y) test-not)
(tree-equal-test-not (cdr x) (cdr y) test-not)))
((consp y) nil)
((not (funcall test-not x y)) t)
(t ())))
(defun tree-equal-test (x y test)
(declare (type function test))
(cond ((consp x)
(and (consp y)
(tree-equal-test (car x) (car y) test)
(tree-equal-test (cdr x) (cdr y) test)))
((consp y) nil)
((funcall test x y) t)
(t ())))
(defun tree-equal-eql (x y)
(labels ((recurse (x y)
(if (eq x y)
t
(do ((x x (cdr x))
(y y (cdr y)))
((or (atom x)
(atom y))
(or (eql x y)
(return-from tree-equal-eql)))
(cond ((consp (car x))
(when (atom (car y))
(return-from tree-equal-eql))
(recurse (car x) (car y)))
((not (eql (car x) (car y)))
(return-from tree-equal-eql)))))))
(recurse x y)))
(defun tree-equal (x y &key (test nil testp) (test-not nil notp))
"Return T if X and Y are isomorphic trees with identical leaves."
(declare (explicit-check))
(declare (dynamic-extent test test-not))
(cond (notp
(when testp
(error ":TEST and :TEST-NOT were both supplied."))
(tree-equal-test-not x y (%coerce-callable-to-fun test-not)))
((or (not test)
(eql test #'eql)
(eql test 'eql))
(tree-equal-eql x y))
(t
(tree-equal-test x y (%coerce-callable-to-fun test)))))
(defun endp (object)
"This is the recommended way to test for the end of a proper list. It
returns true if OBJECT is NIL, false if OBJECT is a CONS, and an error
for any other type of OBJECT."
(endp object))
(defun list-length (list)
"Return the length of the given List, or Nil if the List is circular."
(do ((n 0 (+ n 2))
(y list (cddr y))
(z list (cdr z)))
(())
(declare (type fixnum n)
(type list y z))
(when (endp y) (return n))
(when (endp (cdr y)) (return (+ n 1)))
(when (and (eq y z) (> n 0)) (return nil))))
(defun nth (n list)
"Return the nth object in a list where the car is the zero-th element."
(declare (explicit-check)
(optimize speed))
(typecase n
((and fixnum unsigned-byte)
(block nil
(let ((i n)
(result list))
(tagbody
loop
(the list result)
(if (plusp i)
(psetq i (1- i)
result (cdr result))
(return (car result)))
(go loop)))))
(t
(car (nthcdr n list)))))
(defun first (list)
"Return the 1st object in a list or NIL if the list is empty."
(car list))
(defun second (list)
"Return the 2nd object in a list or NIL if there is no 2nd object."
(cadr list))
(defun third (list)
"Return the 3rd object in a list or NIL if there is no 3rd object."
(caddr list))
(defun fourth (list)
"Return the 4th object in a list or NIL if there is no 4th object."
(cadddr list))
(defun fifth (list)
"Return the 5th object in a list or NIL if there is no 5th object."
(car (cddddr list)))
(defun sixth (list)
"Return the 6th object in a list or NIL if there is no 6th object."
(cadr (cddddr list)))
(defun seventh (list)
"Return the 7th object in a list or NIL if there is no 7th object."
(caddr (cddddr list)))
(defun eighth (list)
"Return the 8th object in a list or NIL if there is no 8th object."
(cadddr (cddddr list)))
(defun ninth (list)
"Return the 9th object in a list or NIL if there is no 9th object."
(car (cddddr (cddddr list))))
(defun tenth (list)
"Return the 10th object in a list or NIL if there is no 10th object."
(cadr (cddddr (cddddr list))))
(defun rest (list)
"Means the same as the cdr of a list."
(cdr list))
(defun nthcdr (n list)
"Performs the cdr function n times on a list."
(declare (explicit-check n)
(optimize speed))
(flet ((fast-nthcdr (n list)
(do ((i n (1- i))
(result list (cdr result)))
((not (plusp i)) result))))
(typecase n
((and fixnum unsigned-byte)
(fast-nthcdr n list))
;; Such a large list can only be circular
(t
(locally (declare (unsigned-byte n))
(do ((i 0 (1+ i))
(r-i list (cdr r-i))
(r-2i list (cddr r-2i)))
((and (eq r-i r-2i) (not (zerop i)))
(fast-nthcdr (mod n i) r-i))
(declare (type fixnum i))))))))
;;; For [n]butlast
(defun dotted-nthcdr (n list)
(declare (fixnum n))
(do ((i n (1- i))
(result list (cdr result)))
((not (plusp i)) result)
(declare (type fixnum i))
(when (atom result)
(return))))
;;; LAST
;;;
;;; Transforms in src/compiler/srctran.lisp pick the most specific
;;; version possible. %LAST/BIGNUM is admittedly somewhat academic...
(macrolet ((last0-macro ()
`(let ((rest list)
(list list))
(loop (unless (consp rest)
(return rest))
(shiftf list rest (cdr rest)))))
(last1-macro ()
`(let ((rest list)
(list list))
(loop (unless (consp rest)
(return list))
(shiftf list rest (cdr rest)))))
(lastn-macro (type)
`(let ((returned-list list)
(checked-list list)
(n (truly-the ,type n)))
(declare (,type n))
(tagbody
:scan
(pop checked-list)
(when (atom checked-list)
(go :done))
(if (zerop (truly-the ,type (decf n)))
(go :pop)
(go :scan))
:pop
(pop returned-list)
(pop checked-list)
(if (atom checked-list)
(go :done)
(go :pop))
:done)
returned-list)))
(defun %last0 (list)
(declare (optimize speed (sb-c:verify-arg-count 0)))
(last0-macro))
(defun %last1 (list)
(declare (optimize speed (sb-c:verify-arg-count 0)))
(last1-macro))
(defun %lastn/fixnum (list n)
(declare (optimize speed (sb-c:verify-arg-count 0))
(type (and unsigned-byte fixnum) n))
(case n
(1 (last1-macro))
(0 (last0-macro))
(t (lastn-macro fixnum))))
(defun %lastn/bignum (list n)
(declare (optimize speed (sb-c:verify-arg-count 0))
(type (and unsigned-byte bignum) n))
(lastn-macro unsigned-byte))
(defun last (list &optional (n 1))
"Return the last N conses (not the last element!) of a list."
(case n
(1 (last1-macro))
(0 (last0-macro))
(t
(typecase n
(fixnum
(lastn-macro fixnum))
(bignum
(lastn-macro unsigned-byte)))))))
(define-compiler-macro last (&whole form list &optional (n 1) &environment env)
(if (sb-xc:constantp n env)
(case (constant-form-value n env)
(0 `(%last0 ,list))
(1 `(%last1 ,list))
(t form))
form))
(defun list (&rest args)
"Return constructs and returns a list of its arguments."
args)
;;; LIST* is done the same as LIST, except that the last cons is made
;;; a dotted pair.
(defun list* (arg &rest others)
"Return a list of the arguments with last cons a dotted pair."
(let ((length (length others)))
(cond ((= length 0) arg)
((= length 1)
(cons arg (fast-&rest-nth 0 others)))
(t
(let* ((cons (list arg))
(result cons)
(index 0)
(1-length (1- length)))
(loop
(cond
((< index 1-length)
(setf cons
(setf (cdr cons)
(list (fast-&rest-nth index others))))
(incf index))
(t (return nil))))
(setf (cdr cons) (fast-&rest-nth index others))
result)))))
(defun make-list (size &key initial-element)
"Constructs a list with size elements each set to value"
(declare (explicit-check))
(%make-list size initial-element))
;;; This entry point is to be preferred, irrespective of
;;; whether or not the backend has vops for %MAKE-LIST.
(defun %make-list (size initial-element)
(declare (type index size))
(do ((count size (1- count))
(result '() (cons initial-element result)))
((<= count 0) result)
(declare (type index count))))
(defun append (&rest lists)
"Construct a new list by concatenating the list arguments"
(let* ((result (list nil))
(tail result)
(index 0)
(length (length lists))
(last (1- length)))
(declare (truly-dynamic-extent result))
(loop
(cond
((< (truly-the index index) last)
(let ((list (fast-&rest-nth (truly-the index index) lists)))
(dolist (elt list)
(setf (cdr (truly-the cons tail)) (list elt)
tail (cdr tail))))
(incf index))
(t (return nil))))
(cond
((zerop length) nil)
((null (cdr result))
(fast-&rest-nth (truly-the index last) lists))
(t
(setf (cdr (truly-the cons tail))
(fast-&rest-nth (truly-the index last) lists))
(cdr result)))))
(defun append2 (x y)
(declare (optimize (sb-c:verify-arg-count 0)))
(if (null x)
y
(let ((result (list (car x))))
(do ((more (cdr x) (cdr more))
(tail result (cdr tail)))
((null more)
(rplacd (truly-the cons tail) y)
result)
(rplacd (truly-the cons tail) (list (car more)))))))
;;;; list copying functions
(defun copy-list (list)
"Return a new list which is EQUAL to LIST. LIST may be improper."
(copy-list-macro list))
(defun copy-alist (alist)
"Return a new association list which is EQUAL to ALIST."
(if (endp alist)
alist
(let ((result
(cons (if (atom (car alist))
(car alist)
(cons (caar alist) (cdar alist)))
nil)))
(do ((x (cdr alist) (cdr x))
(splice result
(cdr (rplacd splice
(cons
(if (atom (car x))
(car x)
(cons (caar x) (cdar x)))
nil)))))
((endp x)))
result)))
(defun copy-tree (object)
"Recursively copy trees of conses."
(if (consp object)
(let ((result (list (if (consp (car object))
(copy-tree (car object))
(car object)))))
(loop for last-cons = result then new-cons
for cdr = (cdr object) then (cdr cdr)
for car = (if (consp cdr)
(car cdr)
(return (setf (cdr last-cons) cdr)))
for new-cons = (list (if (consp car)
(copy-tree car)
car))
do (setf (cdr last-cons) new-cons))
result)
object))
;;;; more commonly-used list functions
(defun revappend (x y)
"Return (append (reverse x) y)."
(do ((top x (cdr top))
(result y (cons (car top) result)))
((endp top) result)))
;;; NCONC finds the first non-null list, so it can make splice point
;;; to a cons. After finding the first cons element, it holds it in a
;;; result variable while running down successive elements tacking
;;; them together. While tacking lists together, if we encounter a
;;; null list, we set the previous list's last cdr to nil just in case
;;; it wasn't already nil, and it could have been dotted while the
;;; null list was the last argument to NCONC. The manipulation of
;;; splice (that is starting it out on a first cons, setting LAST of
;;; splice, and setting splice to ele) inherently handles (nconc x x),
;;; and it avoids running down the last argument to NCONC which allows
;;; the last argument to be circular.
(defun nconc (&rest lists)
"Concatenates the lists given as arguments (by changing them)"
(declare (optimize speed))
(flet ((fail (object)
(error 'type-error
:datum object
:expected-type 'list)))
(do-rest-arg ((result index) lists)
(typecase result
(cons
(let ((splice result))
(do-rest-arg ((ele index) lists (1+ index))
(typecase ele
(cons (rplacd (last splice) ele)
(setf splice ele))
(null (rplacd (last splice) nil))
(atom (if (< (1+ index) (length lists))
(fail ele)
(rplacd (last splice) ele)))))
(return result)))
(null)
(atom
(if (< (1+ index) (length lists))
(fail result)
(return result)))))))
(defun nreconc (x y)
"Return (NCONC (NREVERSE X) Y)."
(do ((1st (cdr x) (if (endp 1st) 1st (cdr 1st)))
(2nd x 1st) ;2nd follows first down the list.
(3rd y 2nd)) ;3rd follows 2nd down the list.
((atom 2nd) 3rd)
(rplacd 2nd 3rd)))
(defun butlast (list &optional (n 1))
(declare (optimize speed)
(explicit-check n))
(cond ((not (typep n '(and fixnum unsigned-byte)))
(the unsigned-byte n)
nil)
((zerop n)
(copy-list list))
(t
(let ((head (dotted-nthcdr (1- n) list)))
(and (consp head) ; there are at least n
(collect ((copy)) ; conses; copy!
(do ((trail list (cdr trail))
(head head (cdr head)))
;; HEAD is n-1 conses ahead of TRAIL;
;; when HEAD is at the last cons, return
;; the data copied so far.
((atom (cdr head))
(copy))
(copy (car trail)))))))))
(defun nbutlast (list &optional (n 1))
(declare (optimize speed)
(explicit-check n))
(cond ((not (typep n '(and fixnum unsigned-byte)))
(the unsigned-byte n)
nil)
((zerop n)
list)
(t
(let ((head (dotted-nthcdr (1- n) list)))
(and (consp head) ; there are more than n
(consp (cdr head)) ; conses.
;; TRAIL trails by n cons to be able to
;; cut the list at the cons just before.
(do ((trail list (cdr trail))
(head (cdr head) (cdr head)))
((atom (cdr head))
(setf (cdr trail) nil)
list)))))))
(defun ldiff (list object)
"Return a new list, whose elements are those of LIST that appear before
OBJECT. If OBJECT is not a tail of LIST, a copy of LIST is returned.
LIST must be a proper list or a dotted list."
(do* ((list list (cdr list))
(result (list ()))
(splice result))
((atom list)
(if (eql list object)
(cdr result)
(progn (rplacd splice list) (cdr result))))
(if (eql list object)
(return (cdr result))
(setq splice (cdr (rplacd splice (list (car list))))))))
;;;; functions to alter list structure
(defun rplaca (cons x)
"Change the CAR of CONS to X and return the CONS."
(rplaca cons x))
(defun rplacd (cons x)
"Change the CDR of CONS to X and return the CONS."
(rplacd cons x))
;;; Set the Nth element of LIST to NEWVAL.
(defun %setnth (n list newval)
(typecase n
(index
(do ((count n (1- count))
(list list (cdr list)))
((endp list)
(error "~S is too large an index for SETF of NTH." n))
(declare (type fixnum count))
(when (<= count 0)
(rplaca list newval)
(return newval))))
(t (let ((cons (nthcdr n list)))
(when (endp cons)
(error "~S is too large an index for SETF of NTH." n))
(rplaca cons newval)
newval))))
;;;; :KEY arg optimization to save funcall of IDENTITY
;;; APPLY-KEY saves us a function call sometimes.
;;; This isn't wrapped in an (EVAL-WHEN (COMPILE EVAL) ..)
;;; because it's used in seq.lisp and sort.lisp.
(defmacro apply-key (key element)
`(if ,key
(funcall ,key ,element)
,element))
(defmacro apply-key-function (key element)
`(if ,key
(funcall (truly-the function ,key) ,element)
,element))
;;;; macros for (&KEY (KEY #'IDENTITY) (TEST #'EQL TESTP) (TEST-NOT NIL NOTP))
;;; Use these with the following &KEY args:
(defmacro with-set-keys (funcall)
`(if notp
,(append funcall '(:key key :test-not test-not))
,(append funcall '(:key key :test test))))
(defmacro satisfies-the-test (item elt)
(let ((key-tmp (gensym)))
`(let ((,key-tmp (apply-key key ,elt)))
(cond (testp (funcall test ,item ,key-tmp))
(notp (not (funcall test-not ,item ,key-tmp)))
(t (funcall test ,item ,key-tmp))))))
;;;; substitution of expressions
(defun subst (new old tree &key key (test #'eql testp) (test-not #'eql notp))
"Substitutes new for subtrees matching old."
(declare (dynamic-extent key test test-not))
(when (and testp notp)
(error ":TEST and :TEST-NOT were both supplied."))
(let ((key (and key (%coerce-callable-to-fun key)))
(test (if testp (%coerce-callable-to-fun test) test))
(test-not (if notp (%coerce-callable-to-fun test-not) test-not)))
(declare (type function test test-not))
(labels ((s (subtree)
(cond ((satisfies-the-test old subtree) new)
((atom subtree) subtree)
(t (let ((car (s (car subtree)))
(cdr (s (cdr subtree))))
(if (and (eq car (car subtree))
(eq cdr (cdr subtree)))
subtree
(cons car cdr)))))))
(s tree))))
(defun subst-if (new test tree &key key)
"Substitutes new for subtrees for which test is true."
(declare (dynamic-extent test key))
(let ((test (%coerce-callable-to-fun test))
(key (and key (%coerce-callable-to-fun key))))
(labels ((s (subtree)
(cond ((funcall test (apply-key key subtree)) new)
((atom subtree) subtree)
(t (let ((car (s (car subtree)))
(cdr (s (cdr subtree))))
(if (and (eq car (car subtree))
(eq cdr (cdr subtree)))
subtree
(cons car cdr)))))))
(s tree))))
(defun subst-if-not (new test tree &key key)
"Substitutes new for subtrees for which test is false."
(declare (dynamic-extent test key))
(let ((test (%coerce-callable-to-fun test))
(key (and key (%coerce-callable-to-fun key))))
(labels ((s (subtree)
(cond ((not (funcall test (apply-key key subtree))) new)
((atom subtree) subtree)
(t (let ((car (s (car subtree)))
(cdr (s (cdr subtree))))
(if (and (eq car (car subtree))
(eq cdr (cdr subtree)))
subtree
(cons car cdr)))))))
(s tree))))
(defun nsubst (new old tree &key key (test #'eql testp) (test-not #'eql notp))
"Substitute NEW for subtrees matching OLD."
(declare (dynamic-extent key test test-not))
(when (and testp notp)
(error ":TEST and :TEST-NOT were both supplied."))
(let ((key (and key (%coerce-callable-to-fun key)))
(test (if testp (%coerce-callable-to-fun test) test))
(test-not (if notp (%coerce-callable-to-fun test-not) test-not)))
(declare (type function test test-not))
(labels ((s (subtree)
(cond ((satisfies-the-test old subtree) new)
((atom subtree) subtree)
(t (do* ((last nil subtree)
(subtree subtree (cdr subtree)))
((atom subtree)
(if (satisfies-the-test old subtree)
(setf (cdr last) new)))
(if (satisfies-the-test old subtree)
(return (setf (cdr last) new))
(setf (car subtree) (s (car subtree)))))
subtree))))
(s tree))))
(defun nsubst-if (new test tree &key key)
"Substitute NEW for subtrees of TREE for which TEST is true."
(declare (dynamic-extent test key))
(let ((test (%coerce-callable-to-fun test))
(key (and key (%coerce-callable-to-fun key))))
(labels ((s (subtree)
(cond ((funcall test (apply-key key subtree)) new)
((atom subtree) subtree)
(t (do* ((last nil subtree)
(subtree subtree (cdr subtree)))
((atom subtree)
(if (funcall test (apply-key key subtree))
(setf (cdr last) new)))
(if (funcall test (apply-key key subtree))
(return (setf (cdr last) new))
(setf (car subtree) (s (car subtree)))))
subtree))))
(s tree))))
(defun nsubst-if-not (new test tree &key key)
"Substitute NEW for subtrees of TREE for which TEST is false."
(declare (dynamic-extent test key))
(let ((test (%coerce-callable-to-fun test))
(key (and key (%coerce-callable-to-fun key))))
(labels ((s (subtree)
(cond ((not (funcall test (apply-key key subtree))) new)
((atom subtree) subtree)
(t (do* ((last nil subtree)
(subtree subtree (cdr subtree)))
((atom subtree)
(if (not (funcall test (apply-key key subtree)))
(setf (cdr last) new)))
(if (not (funcall test (apply-key key subtree)))
(return (setf (cdr last) new))
(setf (car subtree) (s (car subtree)))))
subtree))))
(s tree))))
(defun sublis (alist tree &key key (test #'eql testp) (test-not #'eql notp))
"Substitute from ALIST into TREE nondestructively."
(declare (dynamic-extent key test test-not))
(when (and testp notp)
(error ":TEST and :TEST-NOT were both supplied."))
(let ((key (and key (%coerce-callable-to-fun key)))
(test (if testp (%coerce-callable-to-fun test) test))
(test-not (if notp (%coerce-callable-to-fun test-not) test-not)))
(declare (type function test test-not))
(declare (inline assoc))
(labels ((s (subtree)
(let* ((key-val (apply-key key subtree))
(assoc (if notp
(assoc key-val alist :test-not test-not)
(assoc key-val alist :test test))))
(cond (assoc (cdr assoc))
((atom subtree) subtree)
(t (let ((car (s (car subtree)))
(cdr (s (cdr subtree))))
(if (and (eq car (car subtree))
(eq cdr (cdr subtree)))
subtree
(cons car cdr))))))))
(s tree))))
;;; This is in run-time env (i.e. not wrapped in EVAL-WHEN (COMPILE EVAL))
;;; because it can be referenced in inline expansions.
(defmacro nsublis-macro ()
(let ((key-tmp (gensym)))
`(let ((,key-tmp (apply-key key subtree)))
(if notp
(assoc ,key-tmp alist :test-not test-not)
(assoc ,key-tmp alist :test test)))))
(defun nsublis (alist tree &key key (test #'eql testp) (test-not #'eql notp))
"Substitute from ALIST into TREE destructively."
(declare (dynamic-extent key test test-not))
(when (and testp notp)
(error ":TEST and :TEST-NOT were both supplied."))
(let ((key (and key (%coerce-callable-to-fun key)))
(test (if testp (%coerce-callable-to-fun test) test))
(test-not (if notp (%coerce-callable-to-fun test-not) test-not)))
(declare (type function test test-not)
(inline assoc))
(let (temp)
(labels ((s (subtree)
(cond ((setq temp (nsublis-macro))
(cdr temp))
((atom subtree) subtree)
(t (do* ((last nil subtree)
(subtree subtree (cdr subtree)))
((atom subtree)
(if (setq temp (nsublis-macro))
(setf (cdr last) (cdr temp))))
(if (setq temp (nsublis-macro))
(return (setf (cdr last) (cdr temp)))
(setf (car subtree) (s (car subtree)))))
subtree))))
(s tree)))))
;;;; functions for using lists as sets
(defun member (item list &key key (test nil testp) (test-not nil notp))
"Return the tail of LIST beginning with first element satisfying EQLity,
:TEST, or :TEST-NOT with the given ITEM."
(declare (explicit-check))
(declare (dynamic-extent key test test-not))
(when (and testp notp)
(error ":TEST and :TEST-NOT were both supplied."))
(let ((key (and key (%coerce-callable-to-fun key)))
(test (and testp (%coerce-callable-to-fun test)))
(test-not (and notp (%coerce-callable-to-fun test-not))))
(cond (test
(if key
(%member-key-test item list key test)
(%member-test item list test)))
(test-not
(if key
(%member-key-test-not item list key test-not)
(%member-test-not item list test-not)))
(t
(if key
(%member-key item list key)
(%member item list))))))
(defun member-if (test list &key key)
"Return tail of LIST beginning with first element satisfying TEST."
(declare (explicit-check))
(declare (dynamic-extent test key))
(let ((test (%coerce-callable-to-fun test))
(key (and key (%coerce-callable-to-fun key))))
(if key
(%member-if-key test list key)
(%member-if test list))))
(defun member-if-not (test list &key key)
"Return tail of LIST beginning with first element not satisfying TEST."
(declare (explicit-check))
(declare (dynamic-extent test key))
(let ((test (%coerce-callable-to-fun test))
(key (and key (%coerce-callable-to-fun key))))
(if key
(%member-if-not-key test list key)
(%member-if-not test list))))
(defun tailp (object list)
"Return true if OBJECT is the same as some tail of LIST, otherwise
returns false. LIST must be a proper list or a dotted list."
(do ((list list (cdr list)))
((atom list) (eql list object))
(if (eql object list)
(return t))))
(defun adjoin (item list &key key (test #'eql testp) (test-not nil notp))
"Add ITEM to LIST unless it is already a member"
(declare (explicit-check))
(declare (dynamic-extent key test test-not))
(when (and testp notp)
(error ":TEST and :TEST-NOT were both supplied."))
(let ((key (and key (%coerce-callable-to-fun key)))
(test (and testp (%coerce-callable-to-fun test)))
(test-not (and notp (%coerce-callable-to-fun test-not))))
(cond (test
(if key
(%adjoin-key-test item list key test)
(%adjoin-test item list test)))
(test-not
(if key
(%adjoin-key-test-not item list key test-not)
(%adjoin-test-not item list test-not)))
(t
(if key
(%adjoin-key item list key)
(%adjoin item list))))))
;;; For cases where MEMBER is called in a loop this allows to perform
;;; the dispatch that the MEMBER function does only once.
(defmacro with-member-test ((test-var &optional first-clause) &body body)
`(let* ((key (and key (%coerce-callable-to-fun key)))
(,test-var (cond ,@(and first-clause ; used by LIST-REMOVE-DUPLICATES*
`(,first-clause))
(notp
(if key
(lambda (x list2 key test)
(%member-key-test-not (funcall (truly-the function key) x)
list2 key test))
(lambda (x list2 key test)
(declare (ignore key))
(%member-test-not x list2 test))))
(testp
(if key
(lambda (x list2 key test)
(%member-key-test (funcall (truly-the function key) x)
list2 key test))
(lambda (x list2 key test)
(declare (ignore key))
(%member-test x list2 test))))
(key
(lambda (x list2 key test)
(declare (ignore test))
(%member-key (funcall (truly-the function key) x) list2 key)))
(t
(lambda (x list2 key test)
(declare (ignore key test))
(%member x list2)))))
(test (cond (notp
(%coerce-callable-to-fun test-not))
(testp
(%coerce-callable-to-fun test)))))
,@body))
(defconstant +list-based-union-limit+ 80)
(defun hash-table-test-p (fun)
(or (eq fun #'eq)
(eq fun #'eql)
(eq fun #'equal)
(eq fun #'equalp)
(eq fun 'eq)
(eq fun 'eql)
(eq fun 'equal)
(eq fun 'equalp)))
(defun union (list1 list2 &key key (test nil testp) (test-not nil notp))
"Return the union of LIST1 and LIST2."
(declare (explicit-check))
(declare (dynamic-extent key test test-not))
(when (and testp notp)
(error ":TEST and :TEST-NOT were both supplied."))
;; We have two possibilities here: for shortish lists we pick up the
;; shorter one as the result, and add the other one to it. For long
;; lists we use a hash-table when possible.
(let ((n1 (length list1))
(n2 (length list2)))
(multiple-value-bind (short long n-short)
(if (< n1 n2)
(values list1 list2 n1)
(values list2 list1 n2))
(if (or (< n-short +list-based-union-limit+)
notp
(and testp
(not (hash-table-test-p test))))
(with-member-test (member-test)
(let ((orig short))
(dolist (elt long)
(unless (funcall member-test elt orig key test)
(push elt short)))
short))
(let ((table (make-hash-table :test (if testp
test
#'eql) :size (+ n1 n2)))
(key (and key (%coerce-callable-to-fun key)))
(union nil))
(dolist (elt long)
(setf (gethash (apply-key key elt) table) elt))
(dolist (elt short)
(setf (gethash (apply-key key elt) table) elt))
(maphash (lambda (k v)
(declare (ignore k))
(push v union))
table)
union)))))
(defun nunion (list1 list2 &key key (test nil testp) (test-not nil notp))
"Destructively return the union of LIST1 and LIST2."
(declare (explicit-check))
(declare (dynamic-extent key test test-not))
(when (and testp notp)
(error ":TEST and :TEST-NOT were both supplied."))
;; We have two possibilities here: for shortish lists we pick up the
;; shorter one as the result, and add the other one to it. For long
;; lists we use a hash-table when possible.
(let ((n1 (length list1))
(n2 (length list2)))
(multiple-value-bind (short long n-short)
(if (< n1 n2)
(values list1 list2 n1)
(values list2 list1 n2))