List-Manipulation Functions

With that background out of the way, you’re ready to look at the library of functions Common Lisp provides for manipulating lists.

You’ve already seen the basic functions for getting at the elements of a list: **FIRST** and **REST**. Although you can get at any element of a list by combining enough calls to **REST** (to move down the list) with a **FIRST** (to extract the element), that can be a bit tedious. So Common Lisp provides functions named for the other ordinals from **SECOND** to **TENTH** that return the appropriate element. More generally, the function **NTH** takes two arguments, an index and a list, and returns the nth (zero-based) element of the list. Similarly, **NTHCDR** takes an index and a list and returns the result of calling **CDR** n times. (Thus, (nthcdr 0 ...) simply returns the original list, and (nthcdr 1 ...) is equivalent to **REST**.) Note, however, that none of these functions is any more efficient, in terms of work done by the computer, than the equivalent combinations of **FIRST**s and **REST**s—there’s no way to get to the nth element of a list without following n **CDR** references.11

The 28 composite **CAR**/**CDR** functions are another family of functions you may see used from time to time. Each function is named by placing a sequence of up to four As and Ds between a C and R, with each A representing a call to **CAR** and each D a call to **CDR**. Thus:

  1. (caar list) === (car (car list))
  2. (cadr list) === (car (cdr list))
  3. (cadadr list) === (car (cdr (car (cdr list))))

Note, however, that many of these functions make sense only when applied to lists that contain other lists. For instance, **CAAR** extracts the **CAR** of the **CAR** of the list it’s given; thus, the list it’s passed must contain another list as its first element. In other words, these are really functions on trees rather than lists:

  1. (caar (list 1 2 3)) ==> error
  2. (caar (list (list 1 2) 3)) ==> 1
  3. (cadr (list (list 1 2) (list 3 4))) ==> (3 4)
  4. (caadr (list (list 1 2) (list 3 4))) ==> 3

These functions aren’t used as often now as in the old days. And even the most die-hard old-school Lisp hackers tend to avoid the longer combinations. However, they’re used quite a bit in older Lisp code, so it’s worth at least understanding how they work.12

The **FIRST**-**TENTH** and **CAR**, **CADR**, and so on, functions can also be used as **SETF**able places if you’re using lists nonfunctionally.

Table 12-1 summarizes some other list functions that I won’t cover in detail.

Table 12-1. Other List Functions

FunctionDescription
LASTReturns the last cons cell in a list. With an integer, argument returns the last n cons cells.
BUTLASTReturns a copy of the list, excluding the last cons cell. With an integer argument, excludes the last n cells.
NBUTLASTThe recycling version of BUTLAST; may modify and return the argument list but has no reliable side effects.
LDIFFReturns a copy of a list up to a given cons cell.
TAILPReturns true if a given object is a cons cell that’s part of the structure of a list.
LIST*Builds a list to hold all but the last of its arguments and then makes the last argument the CDR of the last cell in the list. In other words, a cross between LIST and APPEND.
MAKE-LISTBuilds an n item list. The initial elements of the list are NIL or the value specified with the :initial-element keyword argument.
REVAPPENDCombination of REVERSE and APPEND; reverses first argument as with REVERSE and then appends the second argument.
NRECONCRecycling version of REVAPPEND; reverses first argument as if by NREVERSE and then appends the second argument. No reliable side effects.
CONSPPredicate to test whether an object is a cons cell.
ATOMPredicate to test whether an object is not a cons cell.
LISTPPredicate to test whether an object is either a cons cell or NIL.
NULLPredicate to test whether an object is NIL. Functionally equivalent to NOT but stylistically preferable when testing for an empty list as opposed to boolean false.