mirror/guile
mirror/guile
1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-05-23 13:00:34 +02:00
Code Activity

(SRFI-1 Association Lists): Describe argument order for "=" procedure.

Browse source
This commit is contained in:
Kevin Ryde 2006-05-19 23:30:15 +00:00
parent 9d7b09897b
commit 0ad04acf58
1 changed files with 14 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

19
doc/ref/srfi-modules.texi
View file

@ -937,12 +937,21 @@ Lists}. The present section only documents the additional procedures
for dealing with association lists defined by SRFI-1.
@deffn {Scheme Procedure} assoc key alist [=]
Return the pair from @var{alist} which matches @var{key}. Equality is
determined by @var{=}, which defaults to @code{equal?} if not given.
@var{alist} must be an association lists---a list of pairs.
Return the pair from @var{alist} which matches @var{key}. This
extends the core @code{assoc} (@pxref{Retrieving Alist Entries}) by
taking an optional @var{=} comparison procedure.
This function extends the core @code{assoc} by accepting an equality
predicate. (@pxref{Association Lists})
The default comparison is @code{equal?}. If an @var{=} parameter is
given it's called @code{(@var{=} @var{key} @var{alistcar})}, ie. the
given target @var{key} is the first argument, and a @code{car} from
@var{alist} is second.
For example a case-insensitive string lookup,
@example
(assoc "yy" '(("XX" . 1) ("YY" . 2)) string-ci=?)
@result{} ("YY" . 2)
@end example
@end deffn
@deffn {Scheme Procedure} alist-cons key datum alist