procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

* doc/lispref/sequences.texi (Sequence Functions): Improve indexing.

Browse source
This commit is contained in:
Eli Zaretskii 2017-12-16 16:54:32 +02:00
parent f274cbd185
commit ffd4771560
1 changed files with 13 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

13
doc/lispref/sequences.texi
View file

@ -425,6 +425,7 @@ useful example of @code{sort}.
@cindex sequence functions in seq @cindex sequence functions in seq
@cindex seq library @cindex seq library
@cindex sequences, generalized
The @file{seq.el} library provides the following additional sequence The @file{seq.el} library provides the following additional sequence
manipulation macros and functions, prefixed with @code{seq-}. To use manipulation macros and functions, prefixed with @code{seq-}. To use
them, you must first load the @file{seq} library. them, you must first load the @file{seq} library.
@ -859,6 +860,7 @@ it is a function of two arguments to use instead of the default @code{equal}.
@end defun @end defun
@defun seq-subseq sequence start &optional end @defun seq-subseq sequence start &optional end
@cindex sub-sequence
This function returns a subset of @var{sequence} from @var{start} This function returns a subset of @var{sequence} from @var{start}
to @var{end}, both integers (@var{end} defaults to the last element). to @var{end}, both integers (@var{end} defaults to the last element).
If @var{start} or @var{end} is negative, it counts from the end of If @var{start} or @var{end} is negative, it counts from the end of
@ -926,6 +928,8 @@ contain less elements than @var{n}. @var{n} must be an integer. If
@end defun @end defun
@defun seq-intersection sequence1 sequence2 &optional function @defun seq-intersection sequence1 sequence2 &optional function
@cindex sequences, intersection of
@cindex intersection of sequences
This function returns a list of the elements that appear both in This function returns a list of the elements that appear both in
@var{sequence1} and @var{sequence2}. If the optional argument @var{sequence1} and @var{sequence2}. If the optional argument
@var{function} is non-@code{nil}, it is a function of two arguments to @var{function} is non-@code{nil}, it is a function of two arguments to
@ -972,6 +976,10 @@ of @var{sequence}. Keys are compared using @code{equal}.
@end defun @end defun
@defun seq-into sequence type @defun seq-into sequence type
@cindex convert sequence to another type
@cindex list to vector
@cindex vector to list
@cindex string to vector
This function converts the sequence @var{sequence} into a sequence This function converts the sequence @var{sequence} into a sequence
of type @var{type}. @var{type} can be one of the following symbols: of type @var{type}. @var{type} can be one of the following symbols:
@code{vector}, @code{string} or @code{list}. @code{vector}, @code{string} or @code{list}.
@ -993,6 +1001,8 @@ of type @var{type}. @var{type} can be one of the following symbols:
@end defun @end defun
@defun seq-min sequence @defun seq-min sequence
@cindex minimum value of sequence
@cindex sequence minimum
This function returns the smallest element of @var{sequence}. The This function returns the smallest element of @var{sequence}. The
elements of @var{sequence} must be numbers or markers elements of @var{sequence} must be numbers or markers
(@pxref{Markers}). (@pxref{Markers}).
@ -1010,6 +1020,8 @@ elements of @var{sequence} must be numbers or markers
@end defun @end defun
@defun seq-max sequence @defun seq-max sequence
@cindex maximum value of sequence
@cindex sequence maximum
This function returns the largest element of @var{sequence}. The This function returns the largest element of @var{sequence}. The
elements of @var{sequence} must be numbers or markers. elements of @var{sequence} must be numbers or markers.
@ -1027,6 +1039,7 @@ elements of @var{sequence} must be numbers or markers.
@defmac seq-doseq (var sequence) body@dots{} @defmac seq-doseq (var sequence) body@dots{}
@cindex sequence iteration @cindex sequence iteration
@cindex iteration over vector or string
This macro is like @code{dolist} (@pxref{Iteration, dolist}), except This macro is like @code{dolist} (@pxref{Iteration, dolist}), except
that @var{sequence} can be a list, vector or string. This is that @var{sequence} can be a list, vector or string. This is
primarily useful for side-effects. primarily useful for side-effects.