Replace formfeeds removed on 2001/01/22.
[emacs.git] / lispref / lists.texi
blob6ae9e68d4025058b88bdc97348f14255a5ee809e
1 @c -*-texinfo-*-
2 @c This is part of the GNU Emacs Lisp Reference Manual.
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999
4 @c   Free Software Foundation, Inc. 
5 @c See the file elisp.texi for copying conditions.
6 @setfilename ../info/lists
7 @node Lists, Sequences Arrays Vectors, Strings and Characters, Top
8 @chapter Lists
9 @cindex list
10 @cindex element (of list)
12   A @dfn{list} represents a sequence of zero or more elements (which may
13 be any Lisp objects).  The important difference between lists and
14 vectors is that two or more lists can share part of their structure; in
15 addition, you can insert or delete elements in a list without copying
16 the whole list.
18 @menu
19 * Cons Cells::          How lists are made out of cons cells.
20 * Lists as Boxes::                 Graphical notation to explain lists.
21 * List-related Predicates::        Is this object a list?  Comparing two lists.
22 * List Elements::       Extracting the pieces of a list.
23 * Building Lists::      Creating list structure.
24 * Modifying Lists::     Storing new pieces into an existing list.
25 * Sets And Lists::      A list can represent a finite mathematical set.
26 * Association Lists::   A list can represent a finite relation or mapping.
27 @end menu
29 @node Cons Cells
30 @section Lists and Cons Cells
31 @cindex lists and cons cells
32 @cindex @code{nil} and lists
34   Lists in Lisp are not a primitive data type; they are built up from
35 @dfn{cons cells}.  A cons cell is a data object that represents an
36 ordered pair.  That is, it has two slots, and each slot @dfn{holds}, or
37 @dfn{refers to}, some Lisp object.  One slot is known as the @sc{car},
38 and the other is known as the @sc{cdr}.  (These names are traditional;
39 see @ref{Cons Cell Type}.)  @sc{cdr} is pronounced ``could-er.''
41   We say that ``the @sc{car} of this cons cell is'' whatever object
42 its @sc{car} slot currently holds, and likewise for the @sc{cdr}.
44   A list is a series of cons cells ``chained together,'' so that each
45 cell refers to the next one.  There is one cons cell for each element of
46 the list.  By convention, the @sc{car}s of the cons cells hold the
47 elements of the list, and the @sc{cdr}s are used to chain the list: the
48 @sc{cdr} slot of each cons cell refers to the following cons cell.  The
49 @sc{cdr} of the last cons cell is @code{nil}.  This asymmetry between
50 the @sc{car} and the @sc{cdr} is entirely a matter of convention; at the
51 level of cons cells, the @sc{car} and @sc{cdr} slots have the same
52 characteristics.
54 @cindex list structure
55   Because most cons cells are used as part of lists, the phrase
56 @dfn{list structure} has come to mean any structure made out of cons
57 cells.
59   The symbol @code{nil} is considered a list as well as a symbol; it is
60 the list with no elements.  For convenience, the symbol @code{nil} is
61 considered to have @code{nil} as its @sc{cdr} (and also as its
62 @sc{car}).
64   The @sc{cdr} of any nonempty list @var{l} is a list containing all the
65 elements of @var{l} except the first.
67 @node Lists as Boxes
68 @comment  node-name,  next,  previous,  up
69 @section Lists as Linked Pairs of Boxes
70 @cindex box representation for lists
71 @cindex lists represented as boxes
72 @cindex cons cell as box
74   A cons cell can be illustrated as a pair of boxes.  The first box
75 represents the @sc{car} and the second box represents the @sc{cdr}.
76 Here is an illustration of the two-element list, @code{(tulip lily)},
77 made from two cons cells:
79 @example
80 @group
81  ---------------         ---------------
82 | car   | cdr   |       | car   | cdr   |
83 | tulip |   o---------->| lily  |  nil  |
84 |       |       |       |       |       |
85  ---------------         ---------------
86 @end group
87 @end example
89   Each pair of boxes represents a cons cell.  Each box ``refers to'',
90 ``points to'' or ``holds'' a Lisp object.  (These terms are
91 synonymous.)  The first box, which describes the @sc{car} of the first
92 cons cell, contains the symbol @code{tulip}.  The arrow from the
93 @sc{cdr} box of the first cons cell to the second cons cell indicates
94 that the @sc{cdr} of the first cons cell is the second cons cell.
96   The same list can be illustrated in a different sort of box notation
97 like this:
99 @example
100 @group
101     --- ---      --- ---
102    |   |   |--> |   |   |--> nil
103     --- ---      --- ---
104      |            |
105      |            |
106       --> tulip    --> lily
107 @end group
108 @end example
110   Here is a more complex illustration, showing the three-element list,
111 @code{((pine needles) oak maple)}, the first element of which is a
112 two-element list:
114 @example
115 @group
116     --- ---      --- ---      --- ---
117    |   |   |--> |   |   |--> |   |   |--> nil
118     --- ---      --- ---      --- ---
119      |            |            |
120      |            |            |
121      |             --> oak      --> maple
122      |
123      |     --- ---      --- ---
124       --> |   |   |--> |   |   |--> nil
125            --- ---      --- ---
126             |            |
127             |            |
128              --> pine     --> needles
129 @end group
130 @end example
132   The same list represented in the first box notation looks like this:
134 @example
135 @group
136  --------------       --------------       --------------
137 | car   | cdr  |     | car   | cdr  |     | car   | cdr  |
138 |   o   |   o------->| oak   |   o------->| maple |  nil |
139 |   |   |      |     |       |      |     |       |      |
140  -- | ---------       --------------       --------------
141     |
142     |
143     |        --------------       ----------------
144     |       | car   | cdr  |     | car     | cdr  |
145      ------>| pine  |   o------->| needles |  nil |
146             |       |      |     |         |      |
147              --------------       ----------------
148 @end group
149 @end example
151   @xref{Cons Cell Type}, for the read and print syntax of cons cells and
152 lists, and for more ``box and arrow'' illustrations of lists.
154 @node List-related Predicates
155 @section Predicates on Lists
157   The following predicates test whether a Lisp object is an atom, is a
158 cons cell or is a list, or whether it is the distinguished object
159 @code{nil}.  (Many of these predicates can be defined in terms of the
160 others, but they are used so often that it is worth having all of them.)
162 @defun consp object
163 This function returns @code{t} if @var{object} is a cons cell, @code{nil}
164 otherwise.  @code{nil} is not a cons cell, although it @emph{is} a list.
165 @end defun
167 @defun atom object
168 @cindex atoms
169 This function returns @code{t} if @var{object} is an atom, @code{nil}
170 otherwise.  All objects except cons cells are atoms.  The symbol
171 @code{nil} is an atom and is also a list; it is the only Lisp object
172 that is both.
174 @example
175 (atom @var{object}) @equiv{} (not (consp @var{object}))
176 @end example
177 @end defun
179 @defun listp object
180 This function returns @code{t} if @var{object} is a cons cell or
181 @code{nil}.  Otherwise, it returns @code{nil}.
183 @example
184 @group
185 (listp '(1))
186      @result{} t
187 @end group
188 @group
189 (listp '())
190      @result{} t
191 @end group
192 @end example
193 @end defun
195 @defun nlistp object
196 This function is the opposite of @code{listp}: it returns @code{t} if
197 @var{object} is not a list.  Otherwise, it returns @code{nil}.
199 @example
200 (listp @var{object}) @equiv{} (not (nlistp @var{object}))
201 @end example
202 @end defun
204 @defun null object
205 This function returns @code{t} if @var{object} is @code{nil}, and
206 returns @code{nil} otherwise.  This function is identical to @code{not},
207 but as a matter of clarity we use @code{null} when @var{object} is
208 considered a list and @code{not} when it is considered a truth value
209 (see @code{not} in @ref{Combining Conditions}).
211 @example
212 @group
213 (null '(1))
214      @result{} nil
215 @end group
216 @group
217 (null '())
218      @result{} t
219 @end group
220 @end example
221 @end defun
223 @need 2000
225 @node List Elements
226 @section Accessing Elements of Lists
227 @cindex list elements
229 @defun car cons-cell
230 This function returns the value referred to by the first slot of the
231 cons cell @var{cons-cell}.  Expressed another way, this function
232 returns the @sc{car} of @var{cons-cell}.
234 As a special case, if @var{cons-cell} is @code{nil}, then @code{car}
235 is defined to return @code{nil}; therefore, any list is a valid argument
236 for @code{car}.  An error is signaled if the argument is not a cons cell
237 or @code{nil}.
239 @example
240 @group
241 (car '(a b c))
242      @result{} a
243 @end group
244 @group
245 (car '())
246      @result{} nil
247 @end group
248 @end example
249 @end defun
251 @defun cdr cons-cell
252 This function returns the value referred to by the second slot of
253 the cons cell @var{cons-cell}.  Expressed another way, this function
254 returns the @sc{cdr} of @var{cons-cell}.
256 As a special case, if @var{cons-cell} is @code{nil}, then @code{cdr}
257 is defined to return @code{nil}; therefore, any list is a valid argument
258 for @code{cdr}.  An error is signaled if the argument is not a cons cell
259 or @code{nil}.
261 @example
262 @group
263 (cdr '(a b c))
264      @result{} (b c)
265 @end group
266 @group
267 (cdr '())
268      @result{} nil
269 @end group
270 @end example
271 @end defun
273 @defun car-safe object
274 This function lets you take the @sc{car} of a cons cell while avoiding
275 errors for other data types.  It returns the @sc{car} of @var{object} if
276 @var{object} is a cons cell, @code{nil} otherwise.  This is in contrast
277 to @code{car}, which signals an error if @var{object} is not a list.
279 @example
280 @group
281 (car-safe @var{object})
282 @equiv{}
283 (let ((x @var{object}))
284   (if (consp x)
285       (car x)
286     nil))
287 @end group
288 @end example
289 @end defun
291 @defun cdr-safe object
292 This function lets you take the @sc{cdr} of a cons cell while
293 avoiding errors for other data types.  It returns the @sc{cdr} of
294 @var{object} if @var{object} is a cons cell, @code{nil} otherwise.
295 This is in contrast to @code{cdr}, which signals an error if
296 @var{object} is not a list.
298 @example
299 @group
300 (cdr-safe @var{object})
301 @equiv{}
302 (let ((x @var{object}))
303   (if (consp x)
304       (cdr x)
305     nil))
306 @end group
307 @end example
308 @end defun
310 @tindex pop
311 @defmac pop listname
312 This macro is a way of examining the @sc{car} of a list,
313 and taking it off the list, all at once.  It is new in Emacs 21.
315 It operates on the list which is stored in the symbol @var{listname}.
316 It removes this element from the list by setting @var{listname}
317 to the @sc{cdr} of its old value---but it also returns the @sc{car}
318 of that list, which is the element being removed.
320 @example
322      @result{} (a b c)
323 (pop x)
324      @result{} a
326      @result{} (b c)
327 @end example
328 @end defmac
330 @defun nth n list
331 This function returns the @var{n}th element of @var{list}.  Elements
332 are numbered starting with zero, so the @sc{car} of @var{list} is
333 element number zero.  If the length of @var{list} is @var{n} or less,
334 the value is @code{nil}.
336 If @var{n} is negative, @code{nth} returns the first element of
337 @var{list}.
339 @example
340 @group
341 (nth 2 '(1 2 3 4))
342      @result{} 3
343 @end group
344 @group
345 (nth 10 '(1 2 3 4))
346      @result{} nil
347 @end group
348 @group
349 (nth -3 '(1 2 3 4))
350      @result{} 1
352 (nth n x) @equiv{} (car (nthcdr n x))
353 @end group
354 @end example
356 The function @code{elt} is similar, but applies to any kind of sequence.
357 For historical reasons, it takes its arguments in the opposite order.
358 @xref{Sequence Functions}.
359 @end defun
361 @defun nthcdr n list
362 This function returns the @var{n}th @sc{cdr} of @var{list}.  In other
363 words, it skips past the first @var{n} links of @var{list} and returns
364 what follows.
366 If @var{n} is zero or negative, @code{nthcdr} returns all of
367 @var{list}.  If the length of @var{list} is @var{n} or less,
368 @code{nthcdr} returns @code{nil}.
370 @example
371 @group
372 (nthcdr 1 '(1 2 3 4))
373      @result{} (2 3 4)
374 @end group
375 @group
376 (nthcdr 10 '(1 2 3 4))
377      @result{} nil
378 @end group
379 @group
380 (nthcdr -3 '(1 2 3 4))
381      @result{} (1 2 3 4)
382 @end group
383 @end example
384 @end defun
386 @defun last list &optional n
387 This function reruns the last link of the given @var{list}.  The
388 @code{car} of this link is the list's last element.  If @var{list} is
389 null, @code{nil} is returned.  If @var{n} is non-nil the
390 @var{n}-th-to-last link is returned instead, or the whole @var{list} if
391 @var{n} is bigger than @var{list}'s length.
392 @end defun
394 @defun safe-length list
395 This function returns the length of @var{list}, with no risk
396 of either an error or an infinite loop.
398 If @var{list} is not really a list, @code{safe-length} returns 0.  If
399 @var{list} is circular, it returns a finite value which is at least the
400 number of distinct elements.
401 @end defun
403   The most common way to compute the length of a list, when you are not
404 worried that it may be circular, is with @code{length}.  @xref{Sequence
405 Functions}.
407 @defun caar cons-cell
408 This is the same as @code{(car (car @var{cons-cell}))}.
409 @end defun
411 @defun cadr cons-cell
412 This is the same as @code{(car (cdr @var{cons-cell}))}
413 or @code{(nth 1 @var{cons-cell})}.
414 @end defun
416 @defun cdar cons-cell
417 This is the same as @code{(cdr (car @var{cons-cell}))}.
418 @end defun
420 @defun cddr cons-cell
421 This is the same as @code{(cdr (cdr @var{cons-cell}))}
422 or @code{(nthcdr 2 @var{cons-cell})}.
423 @end defun
425 @defun butlast x &optional n
426 This function returns the list @var{x} with the last element,
427 or the last @var{n} elements, removed.  If @var{n} is greater
428 than zero it makes a copy of the list so as not to damage the
429 original list.  In general, @code{(append (butlast @var{x} @var{n})
430 (last @var{x} @var{n}))} will return a list equal to @var{x}.
431 @end defun
433 @defun nbutlast x &optional n
434 This is a version of @code{butlast} that works by destructively
435 modifying the @code{cdr} of the appropriate element, rather than
436 making a copy of the list.
437 @end defun
439 @node Building Lists
440 @comment  node-name,  next,  previous,  up
441 @section Building Cons Cells and Lists
442 @cindex cons cells
443 @cindex building lists
445   Many functions build lists, as lists reside at the very heart of Lisp.
446 @code{cons} is the fundamental list-building function; however, it is
447 interesting to note that @code{list} is used more times in the source
448 code for Emacs than @code{cons}.
450 @defun cons object1 object2
451 This function is the fundamental function used to build new list
452 structure.  It creates a new cons cell, making @var{object1} the
453 @sc{car}, and @var{object2} the @sc{cdr}.  It then returns the new cons
454 cell.  The arguments @var{object1} and @var{object2} may be any Lisp
455 objects, but most often @var{object2} is a list.
457 @example
458 @group
459 (cons 1 '(2))
460      @result{} (1 2)
461 @end group
462 @group
463 (cons 1 '())
464      @result{} (1)
465 @end group
466 @group
467 (cons 1 2)
468      @result{} (1 . 2)
469 @end group
470 @end example
472 @cindex consing
473 @code{cons} is often used to add a single element to the front of a
474 list.  This is called @dfn{consing the element onto the list}.
475 @footnote{There is no strictly equivalent way to add an element to
476 the end of a list.  You can use @code{(append @var{listname} (list
477 @var{newelt}))}, which creates a whole new list by copying @var{listname}
478 and adding @var{newelt} to its end.  Or you can use @code{(nconc
479 @var{listname} (list @var{newelt}))}, which modifies @var{listname}
480 by following all the @sc{cdr}s and then replacing the terminating
481 @code{nil}.  Compare this to adding an element to the beginning of a
482 list with @code{cons}, which neither copies nor modifies the list.}
483 For example:
485 @example
486 (setq list (cons newelt list))
487 @end example
489 Note that there is no conflict between the variable named @code{list}
490 used in this example and the function named @code{list} described below;
491 any symbol can serve both purposes.
492 @end defun
494 @tindex push
495 @defmac push newelt listname
496 This macro provides an alternative way to write
497 @code{(setq @var{listname} (cons @var{newelt} @var{listname}))}.
498 It is new in Emacs 21.
499 @end defmac
501 @defun list &rest objects
502 This function creates a list with @var{objects} as its elements.  The
503 resulting list is always @code{nil}-terminated.  If no @var{objects}
504 are given, the empty list is returned.
506 @example
507 @group
508 (list 1 2 3 4 5)
509      @result{} (1 2 3 4 5)
510 @end group
511 @group
512 (list 1 2 '(3 4 5) 'foo)
513      @result{} (1 2 (3 4 5) foo)
514 @end group
515 @group
516 (list)
517      @result{} nil
518 @end group
519 @end example
520 @end defun
522 @defun make-list length object
523 This function creates a list of length @var{length}, in which all the
524 elements have the identical value @var{object}.  Compare
525 @code{make-list} with @code{make-string} (@pxref{Creating Strings}).
527 @example
528 @group
529 (make-list 3 'pigs)
530      @result{} (pigs pigs pigs)
531 @end group
532 @group
533 (make-list 0 'pigs)
534      @result{} nil
535 @end group
536 @end example
537 @end defun
539 @defun append &rest sequences
540 @cindex copying lists
541 This function returns a list containing all the elements of
542 @var{sequences}.  The @var{sequences} may be lists, vectors,
543 bool-vectors, or strings, but the last one should usually be a list.
544 All arguments except the last one are copied, so none of the arguments
545 is altered.  (See @code{nconc} in @ref{Rearrangement}, for a way to join
546 lists with no copying.)
548 More generally, the final argument to @code{append} may be any Lisp
549 object.  The final argument is not copied or converted; it becomes the
550 @sc{cdr} of the last cons cell in the new list.  If the final argument
551 is itself a list, then its elements become in effect elements of the
552 result list.  If the final element is not a list, the result is a
553 ``dotted list'' since its final @sc{cdr} is not @code{nil} as required
554 in a true list.
556 The @code{append} function also allows integers as arguments.  It
557 converts them to strings of digits, making up the decimal print
558 representation of the integer, and then uses the strings instead of the
559 original integers.  @strong{Don't use this feature; we plan to eliminate
560 it.  If you already use this feature, change your programs now!}  The
561 proper way to convert an integer to a decimal number in this way is with
562 @code{format} (@pxref{Formatting Strings}) or @code{number-to-string}
563 (@pxref{String Conversion}).
564 @end defun
566   Here is an example of using @code{append}:
568 @example
569 @group
570 (setq trees '(pine oak))
571      @result{} (pine oak)
572 (setq more-trees (append '(maple birch) trees))
573      @result{} (maple birch pine oak)
574 @end group
576 @group
577 trees
578      @result{} (pine oak)
579 more-trees
580      @result{} (maple birch pine oak)
581 @end group
582 @group
583 (eq trees (cdr (cdr more-trees)))
584      @result{} t
585 @end group
586 @end example
588   You can see how @code{append} works by looking at a box diagram.  The
589 variable @code{trees} is set to the list @code{(pine oak)} and then the
590 variable @code{more-trees} is set to the list @code{(maple birch pine
591 oak)}.  However, the variable @code{trees} continues to refer to the
592 original list:
594 @smallexample
595 @group
596 more-trees                trees
597 |                           |
598 |     --- ---      --- ---   -> --- ---      --- ---
599  --> |   |   |--> |   |   |--> |   |   |--> |   |   |--> nil
600       --- ---      --- ---      --- ---      --- ---
601        |            |            |            |
602        |            |            |            |
603         --> maple    -->birch     --> pine     --> oak
604 @end group
605 @end smallexample
607   An empty sequence contributes nothing to the value returned by
608 @code{append}.  As a consequence of this, a final @code{nil} argument
609 forces a copy of the previous argument:
611 @example
612 @group
613 trees
614      @result{} (pine oak)
615 @end group
616 @group
617 (setq wood (append trees nil))
618      @result{} (pine oak)
619 @end group
620 @group
621 wood
622      @result{} (pine oak)
623 @end group
624 @group
625 (eq wood trees)
626      @result{} nil
627 @end group
628 @end example
630 @noindent
631 This once was the usual way to copy a list, before the function
632 @code{copy-sequence} was invented.  @xref{Sequences Arrays Vectors}.
634   Here we show the use of vectors and strings as arguments to @code{append}:
636 @example
637 @group
638 (append [a b] "cd" nil)
639      @result{} (a b 99 100)
640 @end group
641 @end example
643   With the help of @code{apply} (@pxref{Calling Functions}), we can append
644 all the lists in a list of lists:
646 @example
647 @group
648 (apply 'append '((a b c) nil (x y z) nil))
649      @result{} (a b c x y z)
650 @end group
651 @end example
653   If no @var{sequences} are given, @code{nil} is returned:
655 @example
656 @group
657 (append)
658      @result{} nil
659 @end group
660 @end example
662   Here are some examples where the final argument is not a list:
664 @example
665 (append '(x y) 'z)
666      @result{} (x y . z)
667 (append '(x y) [z])
668      @result{} (x y . [z])
669 @end example
671 @noindent
672 The second example shows that when the final argument is a sequence but
673 not a list, the sequence's elements do not become elements of the
674 resulting list.  Instead, the sequence becomes the final @sc{cdr}, like
675 any other non-list final argument.
677 @defun reverse list
678 This function creates a new list whose elements are the elements of
679 @var{list}, but in reverse order.  The original argument @var{list} is
680 @emph{not} altered.
682 @example
683 @group
684 (setq x '(1 2 3 4))
685      @result{} (1 2 3 4)
686 @end group
687 @group
688 (reverse x)
689      @result{} (4 3 2 1)
691      @result{} (1 2 3 4)
692 @end group
693 @end example
694 @end defun
696 @defun remq object list
697 This function returns a copy of @var{list}, with all elements removed
698 which are @code{eq} to @var{object}.  The letter @samp{q} in @code{remq}
699 says that it uses @code{eq} to compare @var{object} against the elements
700 of @code{list}.
702 @example
703 @group
704 (setq sample-list '(a b c a b c))
705      @result{} (a b c a b c)
706 @end group
707 @group
708 (remq 'a sample-list)
709      @result{} (b c b c)
710 @end group
711 @group
712 sample-list
713      @result{} (a b c a b c)
714 @end group
715 @end example
716 @noindent
717 The function @code{delq} offers a way to perform this operation
718 destructively.  See @ref{Sets And Lists}.
719 @end defun
721 @node Modifying Lists
722 @section Modifying Existing List Structure
723 @cindex destructive list operations
725   You can modify the @sc{car} and @sc{cdr} contents of a cons cell with the
726 primitives @code{setcar} and @code{setcdr}.  We call these ``destructive'' 
727 operations because they change existing list structure.
729 @cindex CL note---@code{rplaca} vrs @code{setcar}
730 @quotation
731 @findex rplaca
732 @findex rplacd
733 @b{Common Lisp note:} Common Lisp uses functions @code{rplaca} and
734 @code{rplacd} to alter list structure; they change structure the same
735 way as @code{setcar} and @code{setcdr}, but the Common Lisp functions
736 return the cons cell while @code{setcar} and @code{setcdr} return the
737 new @sc{car} or @sc{cdr}.
738 @end quotation
740 @menu
741 * Setcar::          Replacing an element in a list.
742 * Setcdr::          Replacing part of the list backbone.
743                       This can be used to remove or add elements.
744 * Rearrangement::   Reordering the elements in a list; combining lists.
745 @end menu
747 @node Setcar
748 @subsection Altering List Elements with @code{setcar}
750   Changing the @sc{car} of a cons cell is done with @code{setcar}.  When
751 used on a list, @code{setcar} replaces one element of a list with a
752 different element.
754 @defun setcar cons object
755 This function stores @var{object} as the new @sc{car} of @var{cons},
756 replacing its previous @sc{car}.  In other words, it changes the
757 @sc{car} slot of @var{cons} to refer to @var{object}.  It returns the
758 value @var{object}.  For example:
760 @example
761 @group
762 (setq x '(1 2))
763      @result{} (1 2)
764 @end group
765 @group
766 (setcar x 4)
767      @result{} 4
768 @end group
769 @group
771      @result{} (4 2)
772 @end group
773 @end example
774 @end defun
776   When a cons cell is part of the shared structure of several lists,
777 storing a new @sc{car} into the cons changes one element of each of
778 these lists.  Here is an example:
780 @example
781 @group
782 ;; @r{Create two lists that are partly shared.}
783 (setq x1 '(a b c))
784      @result{} (a b c)
785 (setq x2 (cons 'z (cdr x1)))
786      @result{} (z b c)
787 @end group
789 @group
790 ;; @r{Replace the @sc{car} of a shared link.}
791 (setcar (cdr x1) 'foo)
792      @result{} foo
793 x1                           ; @r{Both lists are changed.}
794      @result{} (a foo c)
796      @result{} (z foo c)
797 @end group
799 @group
800 ;; @r{Replace the @sc{car} of a link that is not shared.}
801 (setcar x1 'baz)
802      @result{} baz
803 x1                           ; @r{Only one list is changed.}
804      @result{} (baz foo c)
806      @result{} (z foo c)
807 @end group
808 @end example
810   Here is a graphical depiction of the shared structure of the two lists
811 in the variables @code{x1} and @code{x2}, showing why replacing @code{b}
812 changes them both:
814 @example
815 @group
816         --- ---        --- ---      --- ---
817 x1---> |   |   |----> |   |   |--> |   |   |--> nil
818         --- ---        --- ---      --- ---
819          |        -->   |            |
820          |       |      |            |
821           --> a  |       --> b        --> c
822                  |
823        --- ---   |
824 x2--> |   |   |--
825        --- ---
826         |
827         |
828          --> z
829 @end group
830 @end example
832   Here is an alternative form of box diagram, showing the same relationship:
834 @example
835 @group
837  --------------       --------------       --------------
838 | car   | cdr  |     | car   | cdr  |     | car   | cdr  |
839 |   a   |   o------->|   b   |   o------->|   c   |  nil |
840 |       |      |  -->|       |      |     |       |      |
841  --------------  |    --------------       --------------
842                  |
843 x2:              |
844  --------------  |
845 | car   | cdr  | |
846 |   z   |   o----
847 |       |      |
848  --------------
849 @end group
850 @end example
852 @node Setcdr
853 @subsection Altering the CDR of a List
855   The lowest-level primitive for modifying a @sc{cdr} is @code{setcdr}:
857 @defun setcdr cons object
858 This function stores @var{object} as the new @sc{cdr} of @var{cons},
859 replacing its previous @sc{cdr}.  In other words, it changes the
860 @sc{cdr} slot of @var{cons} to refer to @var{object}.  It returns the
861 value @var{object}.
862 @end defun
864   Here is an example of replacing the @sc{cdr} of a list with a
865 different list.  All but the first element of the list are removed in
866 favor of a different sequence of elements.  The first element is
867 unchanged, because it resides in the @sc{car} of the list, and is not
868 reached via the @sc{cdr}.
870 @example
871 @group
872 (setq x '(1 2 3))
873      @result{} (1 2 3)
874 @end group
875 @group
876 (setcdr x '(4))
877      @result{} (4)
878 @end group
879 @group
881      @result{} (1 4)
882 @end group
883 @end example
885   You can delete elements from the middle of a list by altering the
886 @sc{cdr}s of the cons cells in the list.  For example, here we delete
887 the second element, @code{b}, from the list @code{(a b c)}, by changing
888 the @sc{cdr} of the first cons cell:
890 @example
891 @group
892 (setq x1 '(a b c))
893      @result{} (a b c)
894 (setcdr x1 (cdr (cdr x1)))
895      @result{} (c)
897      @result{} (a c)
898 @end group
899 @end example
901 @need 4000
902   Here is the result in box notation:
904 @example
905 @group
906                    --------------------
907                   |                    |
908  --------------   |   --------------   |    --------------
909 | car   | cdr  |  |  | car   | cdr  |   -->| car   | cdr  |
910 |   a   |   o-----   |   b   |   o-------->|   c   |  nil |
911 |       |      |     |       |      |      |       |      |
912  --------------       --------------        --------------
913 @end group
914 @end example
916 @noindent
917 The second cons cell, which previously held the element @code{b}, still
918 exists and its @sc{car} is still @code{b}, but it no longer forms part
919 of this list.
921   It is equally easy to insert a new element by changing @sc{cdr}s:
923 @example
924 @group
925 (setq x1 '(a b c))
926      @result{} (a b c)
927 (setcdr x1 (cons 'd (cdr x1)))
928      @result{} (d b c)
930      @result{} (a d b c)
931 @end group
932 @end example
934   Here is this result in box notation:
936 @smallexample
937 @group
938  --------------        -------------       -------------
939 | car  | cdr   |      | car  | cdr  |     | car  | cdr  |
940 |   a  |   o   |   -->|   b  |   o------->|   c  |  nil |
941 |      |   |   |  |   |      |      |     |      |      |
942  --------- | --   |    -------------       -------------
943            |      |
944      -----         --------
945     |                      |
946     |    ---------------   |
947     |   | car   | cdr   |  |
948      -->|   d   |   o------
949         |       |       |
950          ---------------
951 @end group
952 @end smallexample
954 @node Rearrangement
955 @subsection Functions that Rearrange Lists
956 @cindex rearrangement of lists
957 @cindex modification of lists
959   Here are some functions that rearrange lists ``destructively'' by
960 modifying the @sc{cdr}s of their component cons cells.  We call these
961 functions ``destructive'' because they chew up the original lists passed
962 to them as arguments, relinking their cons cells to form a new list that
963 is the returned value.
965 @ifnottex
966   See @code{delq}, in @ref{Sets And Lists}, for another function
967 that modifies cons cells.
968 @end ifnottex
969 @iftex
970    The function @code{delq} in the following section is another example
971 of destructive list manipulation.
972 @end iftex
974 @defun nconc &rest lists
975 @cindex concatenating lists
976 @cindex joining lists
977 This function returns a list containing all the elements of @var{lists}.
978 Unlike @code{append} (@pxref{Building Lists}), the @var{lists} are
979 @emph{not} copied.  Instead, the last @sc{cdr} of each of the
980 @var{lists} is changed to refer to the following list.  The last of the
981 @var{lists} is not altered.  For example:
983 @example
984 @group
985 (setq x '(1 2 3))
986      @result{} (1 2 3)
987 @end group
988 @group
989 (nconc x '(4 5))
990      @result{} (1 2 3 4 5)
991 @end group
992 @group
994      @result{} (1 2 3 4 5)
995 @end group
996 @end example
998    Since the last argument of @code{nconc} is not itself modified, it is
999 reasonable to use a constant list, such as @code{'(4 5)}, as in the
1000 above example.  For the same reason, the last argument need not be a
1001 list:
1003 @example
1004 @group
1005 (setq x '(1 2 3))
1006      @result{} (1 2 3)
1007 @end group
1008 @group
1009 (nconc x 'z)
1010      @result{} (1 2 3 . z)
1011 @end group
1012 @group
1014      @result{} (1 2 3 . z)
1015 @end group
1016 @end example
1018 However, the other arguments (all but the last) must be lists.
1020 A common pitfall is to use a quoted constant list as a non-last
1021 argument to @code{nconc}.  If you do this, your program will change
1022 each time you run it!  Here is what happens:
1024 @smallexample
1025 @group
1026 (defun add-foo (x)            ; @r{We want this function to add}
1027   (nconc '(foo) x))           ;   @r{@code{foo} to the front of its arg.}
1028 @end group
1030 @group
1031 (symbol-function 'add-foo)
1032      @result{} (lambda (x) (nconc (quote (foo)) x))
1033 @end group
1035 @group
1036 (setq xx (add-foo '(1 2)))    ; @r{It seems to work.}
1037      @result{} (foo 1 2)
1038 @end group
1039 @group
1040 (setq xy (add-foo '(3 4)))    ; @r{What happened?}
1041      @result{} (foo 1 2 3 4)
1042 @end group
1043 @group
1044 (eq xx xy)
1045      @result{} t
1046 @end group
1048 @group
1049 (symbol-function 'add-foo)
1050      @result{} (lambda (x) (nconc (quote (foo 1 2 3 4) x)))
1051 @end group
1052 @end smallexample
1053 @end defun
1055 @defun nreverse list
1056 @cindex reversing a list
1057   This function reverses the order of the elements of @var{list}.
1058 Unlike @code{reverse}, @code{nreverse} alters its argument by reversing
1059 the @sc{cdr}s in the cons cells forming the list.  The cons cell that
1060 used to be the last one in @var{list} becomes the first cons cell of the
1061 value.
1063   For example:
1065 @example
1066 @group
1067 (setq x '(1 2 3 4))
1068      @result{} (1 2 3 4)
1069 @end group
1070 @group
1072      @result{} (1 2 3 4)
1073 (nreverse x)
1074      @result{} (4 3 2 1)
1075 @end group
1076 @group
1077 ;; @r{The cons cell that was first is now last.}
1079      @result{} (1)
1080 @end group
1081 @end example
1083   To avoid confusion, we usually store the result of @code{nreverse}
1084 back in the same variable which held the original list:
1086 @example
1087 (setq x (nreverse x))
1088 @end example
1090   Here is the @code{nreverse} of our favorite example, @code{(a b c)},
1091 presented graphically:
1093 @smallexample
1094 @group
1095 @r{Original list head:}                       @r{Reversed list:}
1096  -------------        -------------        ------------
1097 | car  | cdr  |      | car  | cdr  |      | car | cdr  |
1098 |   a  |  nil |<--   |   b  |   o  |<--   |   c |   o  |
1099 |      |      |   |  |      |   |  |   |  |     |   |  |
1100  -------------    |   --------- | -    |   -------- | -
1101                   |             |      |            |
1102                    -------------        ------------
1103 @end group
1104 @end smallexample
1105 @end defun
1107 @defun sort list predicate
1108 @cindex stable sort
1109 @cindex sorting lists
1110 This function sorts @var{list} stably, though destructively, and
1111 returns the sorted list.  It compares elements using @var{predicate}.  A
1112 stable sort is one in which elements with equal sort keys maintain their
1113 relative order before and after the sort.  Stability is important when
1114 successive sorts are used to order elements according to different
1115 criteria.
1117 The argument @var{predicate} must be a function that accepts two
1118 arguments.  It is called with two elements of @var{list}.  To get an
1119 increasing order sort, the @var{predicate} should return @code{t} if the
1120 first element is ``less than'' the second, or @code{nil} if not.
1122 The comparison function @var{predicate} must give reliable results for
1123 any given pair of arguments, at least within a single call to
1124 @code{sort}.  It must be @dfn{antisymmetric}; that is, if @var{a} is
1125 less than @var{b}, @var{b} must not be less than @var{a}.  It must be
1126 @dfn{transitive}---that is, if @var{a} is less than @var{b}, and @var{b}
1127 is less than @var{c}, then @var{a} must be less than @var{c}.  If you
1128 use a comparison function which does not meet these requirements, the
1129 result of @code{sort} is unpredictable.
1131 The destructive aspect of @code{sort} is that it rearranges the cons
1132 cells forming @var{list} by changing @sc{cdr}s.  A nondestructive sort
1133 function would create new cons cells to store the elements in their
1134 sorted order.  If you wish to make a sorted copy without destroying the
1135 original, copy it first with @code{copy-sequence} and then sort.
1137 Sorting does not change the @sc{car}s of the cons cells in @var{list};
1138 the cons cell that originally contained the element @code{a} in
1139 @var{list} still has @code{a} in its @sc{car} after sorting, but it now
1140 appears in a different position in the list due to the change of
1141 @sc{cdr}s.  For example:
1143 @example
1144 @group
1145 (setq nums '(1 3 2 6 5 4 0))
1146      @result{} (1 3 2 6 5 4 0)
1147 @end group
1148 @group
1149 (sort nums '<)
1150      @result{} (0 1 2 3 4 5 6)
1151 @end group
1152 @group
1153 nums
1154      @result{} (1 2 3 4 5 6)
1155 @end group
1156 @end example
1158 @noindent
1159 @strong{Warning}: Note that the list in @code{nums} no longer contains
1160 0; this is the same cons cell that it was before, but it is no longer
1161 the first one in the list.  Don't assume a variable that formerly held
1162 the argument now holds the entire sorted list!  Instead, save the result
1163 of @code{sort} and use that.  Most often we store the result back into
1164 the variable that held the original list:
1166 @example
1167 (setq nums (sort nums '<))
1168 @end example
1170 @xref{Sorting}, for more functions that perform sorting.
1171 See @code{documentation} in @ref{Accessing Documentation}, for a
1172 useful example of @code{sort}.
1173 @end defun
1175 @node Sets And Lists
1176 @section Using Lists as Sets
1177 @cindex lists as sets
1178 @cindex sets
1180   A list can represent an unordered mathematical set---simply consider a
1181 value an element of a set if it appears in the list, and ignore the
1182 order of the list.  To form the union of two sets, use @code{append} (as
1183 long as you don't mind having duplicate elements).  Other useful
1184 functions for sets include @code{memq} and @code{delq}, and their
1185 @code{equal} versions, @code{member} and @code{delete}.
1187 @cindex CL note---lack @code{union}, @code{intersection}
1188 @quotation
1189 @b{Common Lisp note:} Common Lisp has functions @code{union} (which
1190 avoids duplicate elements) and @code{intersection} for set operations,
1191 but GNU Emacs Lisp does not have them.  You can write them in Lisp if
1192 you wish.
1193 @end quotation
1195 @defun memq object list
1196 @cindex membership in a list
1197 This function tests to see whether @var{object} is a member of
1198 @var{list}.  If it is, @code{memq} returns a list starting with the
1199 first occurrence of @var{object}.  Otherwise, it returns @code{nil}.
1200 The letter @samp{q} in @code{memq} says that it uses @code{eq} to
1201 compare @var{object} against the elements of the list.  For example:
1203 @example
1204 @group
1205 (memq 'b '(a b c b a))
1206      @result{} (b c b a)
1207 @end group
1208 @group
1209 (memq '(2) '((1) (2)))    ; @r{@code{(2)} and @code{(2)} are not @code{eq}.}
1210      @result{} nil
1211 @end group
1212 @end example
1213 @end defun
1215 @defun delq object list
1216 @cindex deletion of elements
1217 This function destructively removes all elements @code{eq} to
1218 @var{object} from @var{list}.  The letter @samp{q} in @code{delq} says
1219 that it uses @code{eq} to compare @var{object} against the elements of
1220 the list, like @code{memq} and @code{remq}.
1221 @end defun
1223 When @code{delq} deletes elements from the front of the list, it does so
1224 simply by advancing down the list and returning a sublist that starts
1225 after those elements:
1227 @example
1228 @group
1229 (delq 'a '(a b c)) @equiv{} (cdr '(a b c))
1230 @end group
1231 @end example
1233 When an element to be deleted appears in the middle of the list,
1234 removing it involves changing the @sc{cdr}s (@pxref{Setcdr}).
1236 @example
1237 @group
1238 (setq sample-list '(a b c (4)))
1239      @result{} (a b c (4))
1240 @end group
1241 @group
1242 (delq 'a sample-list)
1243      @result{} (b c (4))
1244 @end group
1245 @group
1246 sample-list
1247      @result{} (a b c (4))
1248 @end group
1249 @group
1250 (delq 'c sample-list)
1251      @result{} (a b (4))
1252 @end group
1253 @group
1254 sample-list
1255      @result{} (a b (4))
1256 @end group
1257 @end example
1259 Note that @code{(delq 'c sample-list)} modifies @code{sample-list} to
1260 splice out the third element, but @code{(delq 'a sample-list)} does not
1261 splice anything---it just returns a shorter list.  Don't assume that a
1262 variable which formerly held the argument @var{list} now has fewer
1263 elements, or that it still holds the original list!  Instead, save the
1264 result of @code{delq} and use that.  Most often we store the result back
1265 into the variable that held the original list:
1267 @example
1268 (setq flowers (delq 'rose flowers))
1269 @end example
1271 In the following example, the @code{(4)} that @code{delq} attempts to match
1272 and the @code{(4)} in the @code{sample-list} are not @code{eq}:
1274 @example
1275 @group
1276 (delq '(4) sample-list)
1277      @result{} (a c (4))
1278 @end group
1279 @end example
1281 The following two functions are like @code{memq} and @code{delq} but use
1282 @code{equal} rather than @code{eq} to compare elements.  @xref{Equality
1283 Predicates}.
1285 @defun member object list
1286 The function @code{member} tests to see whether @var{object} is a member
1287 of @var{list}, comparing members with @var{object} using @code{equal}.
1288 If @var{object} is a member, @code{member} returns a list starting with
1289 its first occurrence in @var{list}.  Otherwise, it returns @code{nil}.
1291 Compare this with @code{memq}:
1293 @example
1294 @group
1295 (member '(2) '((1) (2)))  ; @r{@code{(2)} and @code{(2)} are @code{equal}.}
1296      @result{} ((2))
1297 @end group
1298 @group
1299 (memq '(2) '((1) (2)))    ; @r{@code{(2)} and @code{(2)} are not @code{eq}.}
1300      @result{} nil
1301 @end group
1302 @group
1303 ;; @r{Two strings with the same contents are @code{equal}.}
1304 (member "foo" '("foo" "bar"))
1305      @result{} ("foo" "bar")
1306 @end group
1307 @end example
1308 @end defun
1310 @defun delete object sequence
1311 If @code{sequence} is a list, this function destructively removes all
1312 elements @code{equal} to @var{object} from @var{sequence}.  For lists,
1313 @code{delete} is to @code{delq} as @code{member} is to @code{memq}: it
1314 uses @code{equal} to compare elements with @var{object}, like
1315 @code{member}; when it finds an element that matches, it removes the
1316 element just as @code{delq} would.
1318 If @code{sequence} is a vector or string, @code{delete} returns a copy
1319 of @code{sequence} with all elements @code{equal} to @code{object}
1320 removed.
1322 For example:
1324 @example
1325 @group
1326 (delete '(2) '((2) (1) (2)))
1327      @result{} ((1))
1328 @end group
1329 @group
1330 (delete '(2) [(2) (1) (2)])
1331      @result{} [(1)]
1332 @end group
1333 @end example
1334 @end defun
1336 @defun remove object sequence
1337 This function is the non-destructive counterpart of @code{delete}.  If
1338 returns a copy of @code{sequence}, a list, vector, or string, with
1339 elements @code{equal} to @code{object} removed.  For example:
1341 @example
1342 @group
1343 (remove '(2) '((2) (1) (2)))
1344      @result{} ((1))
1345 @end group
1346 @group
1347 (remove '(2) [(2) (1) (2)])
1348      @result{} [(1)]
1349 @end group
1350 @end example
1351 @end defun
1353 @quotation
1354 @b{Common Lisp note:} The functions @code{member}, @code{delete} and
1355 @code{remove} in GNU Emacs Lisp are derived from Maclisp, not Common
1356 Lisp.  The Common Lisp versions do not use @code{equal} to compare
1357 elements.
1358 @end quotation
1360   See also the function @code{add-to-list}, in @ref{Setting Variables},
1361 for another way to add an element to a list stored in a variable.
1363 @node Association Lists
1364 @section Association Lists
1365 @cindex association list
1366 @cindex alist
1368   An @dfn{association list}, or @dfn{alist} for short, records a mapping
1369 from keys to values.  It is a list of cons cells called
1370 @dfn{associations}: the @sc{car} of each cons cell is the @dfn{key}, and the
1371 @sc{cdr} is the @dfn{associated value}.@footnote{This usage of ``key''
1372 is not related to the term ``key sequence''; it means a value used to
1373 look up an item in a table.  In this case, the table is the alist, and
1374 the alist associations are the items.}
1376   Here is an example of an alist.  The key @code{pine} is associated with
1377 the value @code{cones}; the key @code{oak} is associated with
1378 @code{acorns}; and the key @code{maple} is associated with @code{seeds}.
1380 @example
1381 @group
1382 '((pine . cones)
1383   (oak . acorns)
1384   (maple . seeds))
1385 @end group
1386 @end example
1388   The associated values in an alist may be any Lisp objects; so may the
1389 keys.  For example, in the following alist, the symbol @code{a} is
1390 associated with the number @code{1}, and the string @code{"b"} is
1391 associated with the @emph{list} @code{(2 3)}, which is the @sc{cdr} of
1392 the alist element:
1394 @example
1395 ((a . 1) ("b" 2 3))
1396 @end example
1398   Sometimes it is better to design an alist to store the associated
1399 value in the @sc{car} of the @sc{cdr} of the element.  Here is an
1400 example:
1402 @example
1403 '((rose red) (lily white) (buttercup yellow))
1404 @end example
1406 @noindent
1407 Here we regard @code{red} as the value associated with @code{rose}.  One
1408 advantage of this kind of alist is that you can store other related
1409 information---even a list of other items---in the @sc{cdr} of the
1410 @sc{cdr}.  One disadvantage is that you cannot use @code{rassq} (see
1411 below) to find the element containing a given value.  When neither of
1412 these considerations is important, the choice is a matter of taste, as
1413 long as you are consistent about it for any given alist.
1415   Note that the same alist shown above could be regarded as having the
1416 associated value in the @sc{cdr} of the element; the value associated
1417 with @code{rose} would be the list @code{(red)}.
1419   Association lists are often used to record information that you might
1420 otherwise keep on a stack, since new associations may be added easily to
1421 the front of the list.  When searching an association list for an
1422 association with a given key, the first one found is returned, if there
1423 is more than one.
1425   In Emacs Lisp, it is @emph{not} an error if an element of an
1426 association list is not a cons cell.  The alist search functions simply
1427 ignore such elements.  Many other versions of Lisp signal errors in such
1428 cases.
1430   Note that property lists are similar to association lists in several
1431 respects.  A property list behaves like an association list in which
1432 each key can occur only once.  @xref{Property Lists}, for a comparison
1433 of property lists and association lists.
1435 @defun assoc key alist
1436 This function returns the first association for @var{key} in
1437 @var{alist}.  It compares @var{key} against the alist elements using
1438 @code{equal} (@pxref{Equality Predicates}).  It returns @code{nil} if no
1439 association in @var{alist} has a @sc{car} @code{equal} to @var{key}.
1440 For example:
1442 @smallexample
1443 (setq trees '((pine . cones) (oak . acorns) (maple . seeds)))
1444      @result{} ((pine . cones) (oak . acorns) (maple . seeds))
1445 (assoc 'oak trees)
1446      @result{} (oak . acorns)
1447 (cdr (assoc 'oak trees))
1448      @result{} acorns
1449 (assoc 'birch trees)
1450      @result{} nil
1451 @end smallexample
1453 Here is another example, in which the keys and values are not symbols:
1455 @smallexample
1456 (setq needles-per-cluster
1457       '((2 "Austrian Pine" "Red Pine")
1458         (3 "Pitch Pine")
1459         (5 "White Pine")))
1461 (cdr (assoc 3 needles-per-cluster))
1462      @result{} ("Pitch Pine")
1463 (cdr (assoc 2 needles-per-cluster))
1464      @result{} ("Austrian Pine" "Red Pine")
1465 @end smallexample
1466 @end defun
1468   The functions @code{assoc-ignore-representation} and
1469 @code{assoc-ignore-case} are much like @code{assoc} except using
1470 @code{compare-strings} to do the comparison.  @xref{Text Comparison}.
1472 @defun rassoc value alist
1473 This function returns the first association with value @var{value} in
1474 @var{alist}.  It returns @code{nil} if no association in @var{alist} has
1475 a @sc{cdr} @code{equal} to @var{value}.
1477 @code{rassoc} is like @code{assoc} except that it compares the @sc{cdr} of
1478 each @var{alist} association instead of the @sc{car}.  You can think of
1479 this as ``reverse @code{assoc}'', finding the key for a given value.
1480 @end defun
1482 @defun assq key alist
1483 This function is like @code{assoc} in that it returns the first
1484 association for @var{key} in @var{alist}, but it makes the comparison
1485 using @code{eq} instead of @code{equal}.  @code{assq} returns @code{nil}
1486 if no association in @var{alist} has a @sc{car} @code{eq} to @var{key}.
1487 This function is used more often than @code{assoc}, since @code{eq} is
1488 faster than @code{equal} and most alists use symbols as keys.
1489 @xref{Equality Predicates}.
1491 @smallexample
1492 (setq trees '((pine . cones) (oak . acorns) (maple . seeds)))
1493      @result{} ((pine . cones) (oak . acorns) (maple . seeds))
1494 (assq 'pine trees)
1495      @result{} (pine . cones)
1496 @end smallexample
1498 On the other hand, @code{assq} is not usually useful in alists where the
1499 keys may not be symbols:
1501 @smallexample
1502 (setq leaves
1503       '(("simple leaves" . oak)
1504         ("compound leaves" . horsechestnut)))
1506 (assq "simple leaves" leaves)
1507      @result{} nil
1508 (assoc "simple leaves" leaves)
1509      @result{} ("simple leaves" . oak)
1510 @end smallexample
1511 @end defun
1513 @defun rassq value alist
1514 This function returns the first association with value @var{value} in
1515 @var{alist}.  It returns @code{nil} if no association in @var{alist} has
1516 a @sc{cdr} @code{eq} to @var{value}.
1518 @code{rassq} is like @code{assq} except that it compares the @sc{cdr} of
1519 each @var{alist} association instead of the @sc{car}.  You can think of
1520 this as ``reverse @code{assq}'', finding the key for a given value.
1522 For example:
1524 @smallexample
1525 (setq trees '((pine . cones) (oak . acorns) (maple . seeds)))
1527 (rassq 'acorns trees)
1528      @result{} (oak . acorns)
1529 (rassq 'spores trees)
1530      @result{} nil
1531 @end smallexample
1533 Note that @code{rassq} cannot search for a value stored in the @sc{car}
1534 of the @sc{cdr} of an element:
1536 @smallexample
1537 (setq colors '((rose red) (lily white) (buttercup yellow)))
1539 (rassq 'white colors)
1540      @result{} nil
1541 @end smallexample
1543 In this case, the @sc{cdr} of the association @code{(lily white)} is not
1544 the symbol @code{white}, but rather the list @code{(white)}.  This
1545 becomes clearer if the association is written in dotted pair notation:
1547 @smallexample
1548 (lily white) @equiv{} (lily . (white))
1549 @end smallexample
1550 @end defun
1552 @defun assoc-default key alist test default
1553 This function searches @var{alist} for a match for @var{key}.  For each
1554 element of @var{alist}, it compares the element (if it is an atom) or
1555 the element's @sc{car} (if it is a cons) against @var{key}, by calling
1556 @var{test} with two arguments: the element or its @sc{car}, and
1557 @var{key}.  The arguments are passed in that order so that you can get
1558 useful results using @code{string-match} with an alist that contains
1559 regular expressions (@pxref{Regexp Search}).  If @var{test} is omitted
1560 or @code{nil}, @code{equal} is used for comparison.
1562 If an alist element matches @var{key} by this criterion,
1563 then @code{assoc-default} returns a value based on this element.
1564 If the element is a cons, then the value is the element's @sc{cdr}.
1565 Otherwise, the return value is @var{default}.
1567 If no alist element matches @var{key}, @code{assoc-default} returns
1568 @code{nil}.
1569 @end defun
1571 @defun copy-alist alist
1572 @cindex copying alists
1573 This function returns a two-level deep copy of @var{alist}: it creates a
1574 new copy of each association, so that you can alter the associations of
1575 the new alist without changing the old one.
1577 @smallexample
1578 @group
1579 (setq needles-per-cluster
1580       '((2 . ("Austrian Pine" "Red Pine"))
1581         (3 . ("Pitch Pine"))
1582 @end group
1583         (5 . ("White Pine"))))
1584 @result{}
1585 ((2 "Austrian Pine" "Red Pine")
1586  (3 "Pitch Pine")
1587  (5 "White Pine"))
1589 (setq copy (copy-alist needles-per-cluster))
1590 @result{}
1591 ((2 "Austrian Pine" "Red Pine")
1592  (3 "Pitch Pine")
1593  (5 "White Pine"))
1595 (eq needles-per-cluster copy)
1596      @result{} nil
1597 (equal needles-per-cluster copy)
1598      @result{} t
1599 (eq (car needles-per-cluster) (car copy))
1600      @result{} nil
1601 (cdr (car (cdr needles-per-cluster)))
1602      @result{} ("Pitch Pine")
1603 @group
1604 (eq (cdr (car (cdr needles-per-cluster)))
1605     (cdr (car (cdr copy))))
1606      @result{} t
1607 @end group
1608 @end smallexample
1610   This example shows how @code{copy-alist} makes it possible to change
1611 the associations of one copy without affecting the other:
1613 @smallexample
1614 @group
1615 (setcdr (assq 3 copy) '("Martian Vacuum Pine"))
1616 (cdr (assq 3 needles-per-cluster))
1617      @result{} ("Pitch Pine")
1618 @end group
1619 @end smallexample
1620 @end defun
1622 @defun assoc-delete-all key alist
1623 @tindex assoc-delete-all
1624 This function deletes from @var{alist} all the elements whose @sc{car}
1625 is @var{key}.  It returns the modified alist.
1627 @example
1628 (assoc-delete-all 'foo
1629                   '((foo 1) (bar 2) (foo 3) (lose 4)))
1630      @result{} ((bar 2) (lose 4))
1631 @end example
1632 @end defun