diff options
| -rw-r--r-- | doc/lispref/sequences.texi | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/lispref/sequences.texi b/doc/lispref/sequences.texi index 4fba880803e..8d56e022d8f 100644 --- a/doc/lispref/sequences.texi +++ b/doc/lispref/sequences.texi | |||
| @@ -425,6 +425,7 @@ useful example of @code{sort}. | |||
| 425 | 425 | ||
| 426 | @cindex sequence functions in seq | 426 | @cindex sequence functions in seq |
| 427 | @cindex seq library | 427 | @cindex seq library |
| 428 | @cindex sequences, generalized | ||
| 428 | The @file{seq.el} library provides the following additional sequence | 429 | The @file{seq.el} library provides the following additional sequence |
| 429 | manipulation macros and functions, prefixed with @code{seq-}. To use | 430 | manipulation macros and functions, prefixed with @code{seq-}. To use |
| 430 | them, you must first load the @file{seq} library. | 431 | 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}. | |||
| 859 | @end defun | 860 | @end defun |
| 860 | 861 | ||
| 861 | @defun seq-subseq sequence start &optional end | 862 | @defun seq-subseq sequence start &optional end |
| 863 | @cindex sub-sequence | ||
| 862 | This function returns a subset of @var{sequence} from @var{start} | 864 | This function returns a subset of @var{sequence} from @var{start} |
| 863 | to @var{end}, both integers (@var{end} defaults to the last element). | 865 | to @var{end}, both integers (@var{end} defaults to the last element). |
| 864 | If @var{start} or @var{end} is negative, it counts from the end of | 866 | 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 | |||
| 926 | @end defun | 928 | @end defun |
| 927 | 929 | ||
| 928 | @defun seq-intersection sequence1 sequence2 &optional function | 930 | @defun seq-intersection sequence1 sequence2 &optional function |
| 931 | @cindex sequences, intersection of | ||
| 932 | @cindex intersection of sequences | ||
| 929 | This function returns a list of the elements that appear both in | 933 | This function returns a list of the elements that appear both in |
| 930 | @var{sequence1} and @var{sequence2}. If the optional argument | 934 | @var{sequence1} and @var{sequence2}. If the optional argument |
| 931 | @var{function} is non-@code{nil}, it is a function of two arguments to | 935 | @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}. | |||
| 972 | @end defun | 976 | @end defun |
| 973 | 977 | ||
| 974 | @defun seq-into sequence type | 978 | @defun seq-into sequence type |
| 979 | @cindex convert sequence to another type | ||
| 980 | @cindex list to vector | ||
| 981 | @cindex vector to list | ||
| 982 | @cindex string to vector | ||
| 975 | This function converts the sequence @var{sequence} into a sequence | 983 | This function converts the sequence @var{sequence} into a sequence |
| 976 | of type @var{type}. @var{type} can be one of the following symbols: | 984 | of type @var{type}. @var{type} can be one of the following symbols: |
| 977 | @code{vector}, @code{string} or @code{list}. | 985 | @code{vector}, @code{string} or @code{list}. |
| @@ -993,6 +1001,8 @@ of type @var{type}. @var{type} can be one of the following symbols: | |||
| 993 | @end defun | 1001 | @end defun |
| 994 | 1002 | ||
| 995 | @defun seq-min sequence | 1003 | @defun seq-min sequence |
| 1004 | @cindex minimum value of sequence | ||
| 1005 | @cindex sequence minimum | ||
| 996 | This function returns the smallest element of @var{sequence}. The | 1006 | This function returns the smallest element of @var{sequence}. The |
| 997 | elements of @var{sequence} must be numbers or markers | 1007 | elements of @var{sequence} must be numbers or markers |
| 998 | (@pxref{Markers}). | 1008 | (@pxref{Markers}). |
| @@ -1010,6 +1020,8 @@ elements of @var{sequence} must be numbers or markers | |||
| 1010 | @end defun | 1020 | @end defun |
| 1011 | 1021 | ||
| 1012 | @defun seq-max sequence | 1022 | @defun seq-max sequence |
| 1023 | @cindex maximum value of sequence | ||
| 1024 | @cindex sequence maximum | ||
| 1013 | This function returns the largest element of @var{sequence}. The | 1025 | This function returns the largest element of @var{sequence}. The |
| 1014 | elements of @var{sequence} must be numbers or markers. | 1026 | elements of @var{sequence} must be numbers or markers. |
| 1015 | 1027 | ||
| @@ -1027,6 +1039,7 @@ elements of @var{sequence} must be numbers or markers. | |||
| 1027 | 1039 | ||
| 1028 | @defmac seq-doseq (var sequence) body@dots{} | 1040 | @defmac seq-doseq (var sequence) body@dots{} |
| 1029 | @cindex sequence iteration | 1041 | @cindex sequence iteration |
| 1042 | @cindex iteration over vector or string | ||
| 1030 | This macro is like @code{dolist} (@pxref{Iteration, dolist}), except | 1043 | This macro is like @code{dolist} (@pxref{Iteration, dolist}), except |
| 1031 | that @var{sequence} can be a list, vector or string. This is | 1044 | that @var{sequence} can be a list, vector or string. This is |
| 1032 | primarily useful for side-effects. | 1045 | primarily useful for side-effects. |