Next: Association Lists, Previous: Modifying Lists, Up: Lists
A list can represent an unordered mathematical set—simply consider a
value an element of a set if it appears in the list, and ignore the
order of the list. To form the union of two sets, use append (as
long as you don't mind having duplicate elements). You can remove
equal duplicates using delete-dups. Other useful
functions for sets include memq and delq, and their
equal versions, member and delete.
Common Lisp note: Common Lisp has functionsunion(which avoids duplicate elements) andintersectionfor set operations. Although standard GNU Emacs Lisp does not have them, the cl-lib library provides versions. See Lists as Sets.
This function tests to see whether object is a member of list. If it is,
memqreturns a list starting with the first occurrence of object. Otherwise, it returnsnil. The letter ‘q’ inmemqsays that it useseqto compare object against the elements of the list. For example:(memq 'b '(a b c b a)) ⇒ (b c b a) (memq '(2) '((1) (2))) ;(2)and(2)are noteq. ⇒ nil
This function destructively removes all elements
eqto object from list, and returns the resulting list. The letter ‘q’ indelqsays that it useseqto compare object against the elements of the list, likememqandremq.Typically, when you invoke
delq, you should use the return value by assigning it to the variable which held the original list. The reason for this is explained below.
The delq function deletes elements from the front of the list
by simply advancing down the list, and returning a sublist that starts
after those elements. For example:
(delq 'a '(a b c)) == (cdr '(a b c))
When an element to be deleted appears in the middle of the list, removing it involves changing the cdrs (see Setcdr).
(setq sample-list '(a b c (4)))
⇒ (a b c (4))
(delq 'a sample-list)
⇒ (b c (4))
sample-list
⇒ (a b c (4))
(delq 'c sample-list)
⇒ (a b (4))
sample-list
⇒ (a b (4))
Note that (delq 'c sample-list) modifies sample-list to
splice out the third element, but (delq 'a sample-list) does not
splice anything—it just returns a shorter list. Don't assume that a
variable which formerly held the argument list now has fewer
elements, or that it still holds the original list! Instead, save the
result of delq and use that. Most often we store the result back
into the variable that held the original list:
(setq flowers (delq 'rose flowers))
In the following example, the (4) that delq attempts to match
and the (4) in the sample-list are not eq:
(delq '(4) sample-list)
⇒ (a c (4))
If you want to delete elements that are equal to a given value,
use delete (see below).
This function returns a copy of list, with all elements removed which are
eqto object. The letter ‘q’ inremqsays that it useseqto compare object against the elements oflist.(setq sample-list '(a b c a b c)) ⇒ (a b c a b c) (remq 'a sample-list) ⇒ (b c b c) sample-list ⇒ (a b c a b c)
The function
memqltests to see whether object is a member of list, comparing members with object usingeql, so floating-point elements are compared by value. If object is a member,memqlreturns a list starting with its first occurrence in list. Otherwise, it returnsnil.Compare this with
memq:(memql 1.2 '(1.1 1.2 1.3)) ;1.2and1.2areeql. ⇒ (1.2 1.3) (memq 1.2 '(1.1 1.2 1.3)) ;1.2and1.2are noteq. ⇒ nil
The following three functions are like memq, delq and
remq, but use equal rather than eq to compare
elements. See Equality Predicates.
The function
membertests to see whether object is a member of list, comparing members with object usingequal. If object is a member,memberreturns a list starting with its first occurrence in list. Otherwise, it returnsnil.Compare this with
memq:(member '(2) '((1) (2))) ;(2)and(2)areequal. ⇒ ((2)) (memq '(2) '((1) (2))) ;(2)and(2)are noteq. ⇒ nil ;; Two strings with the same contents areequal. (member "foo" '("foo" "bar")) ⇒ ("foo" "bar")
This function removes all elements
equalto object from sequence, and returns the resulting sequence.If sequence is a list,
deleteis todelqasmemberis tomemq: it usesequalto compare elements with object, likemember; when it finds an element that matches, it cuts the element out just asdelqwould. As withdelq, you should typically use the return value by assigning it to the variable which held the original list.If
sequenceis a vector or string,deletereturns a copy ofsequencewith all elementsequaltoobjectremoved.For example:
(setq l '((2) (1) (2))) (delete '(2) l) ⇒ ((1)) l ⇒ ((2) (1)) ;; If you want to changelreliably, ;; write(setq l (delete '(2) l)). (setq l '((2) (1) (2))) (delete '(1) l) ⇒ ((2) (2)) l ⇒ ((2) (2)) ;; In this case, it makes no difference whether you setl, ;; but you should do so for the sake of the other case. (delete '(2) [(2) (1) (2)]) ⇒ [(1)]
This function is the non-destructive counterpart of
delete. It returns a copy ofsequence, a list, vector, or string, with elementsequaltoobjectremoved. For example:(remove '(2) '((2) (1) (2))) ⇒ ((1)) (remove '(2) [(2) (1) (2)]) ⇒ [(1)]
Common Lisp note: The functionsmember,deleteandremovein GNU Emacs Lisp are derived from Maclisp, not Common Lisp. The Common Lisp versions do not useequalto compare elements.
This function is like
member, except that object should be a string and that it ignores differences in letter-case and text representation: upper-case and lower-case letters are treated as equal, and unibyte strings are converted to multibyte prior to comparison.
This function destructively removes all
equalduplicates from list, stores the result in list and returns it. Of severalequaloccurrences of an element in list,delete-dupskeeps the first one.
See also the function add-to-list, in List Variables,
for a way to add an element to a list stored in a variable and used as a
set.