Commit 8fc36a68 authored by Xue Fuqiao's avatar Xue Fuqiao
Browse files

Document new bool-vector set operation functions.

* doc/lispref/sequences.texi (Bool-Vectors): Document new bool-vector
set operation functions.
parent 05e8f1ae
2013-12-22 Xue Fuqiao <xfq.free@gmail.com>
* sequences.texi (Bool-Vectors): Document new bool-vector set operation functions.
* text.texi (Examining Properties): Document `get-pos-property'.
* variables.texi (Directory Local Variables): Document `enable-dir-local-variables'.
......
......@@ -711,6 +711,54 @@ each one initialized to @var{initial}.
@defun bool-vector-p object
This returns @code{t} if @var{object} is a bool-vector,
and @code{nil} otherwise.
@end defun
There are also some bool-vector set operation functions, described below:
@defun bool-vector-exclusive-or a b &optional c
Return @dfn{bitwise exclusive or} of bool vectors @var{a} and @var{b}.
If optional argument @var{c} is given, the result of this operation is
stored into @var{c}. All arguments should be bool vectors of the same length.
@end defun
@defun bool-vector-union a b &optional c
Return @dfn{bitwise or} of bool vectors @var{a} and @var{b}. If
optional argument @var{c} is given, the result of this operation is
stored into @var{c}. All arguments should be bool vectors of the same length.
@end defun
@defun bool-vector-intersection a b &optional c
Return @dfn{bitwise and} of bool vectors @var{a} and @var{b}. If
optional argument @var{c} is given, the result of this operation is
stored into @var{c}. All arguments should be bool vectors of the same length.
@end defun
@defun bool-vector-set-difference a b &optional c
Return @dfn{set difference} of bool vectors @var{a} and @var{b}. If
optional argument @var{c} is given, the result of this operation is
stored into @var{c}. All arguments should be bool vectors of the same length.
@end defun
@defun bool-vector-not a &optional b
Return @dfn{set complement} of bool vector @var{a}. If optional
argument @var{b} is given, the result of this operation is stored into
@var{b}. All arguments should be bool vectors of the same length.
@end defun
@defun bool-vector-subsetp a b
Return @code{t} if every @code{t} value in @var{a} is also t in
@var{b}, nil otherwise. All arguments should be bool vectors of the
same length.
@end defun
@defun bool-vector-count-consecutive a b i
Return the number of consecutive elements in @var{a} equal @var{b}
starting at @var{i}. @code{a} is a bool vector, @var{b} is @code{t}
or @code{nil}, and @var{i} is an index into @code{a}.
@end defun
@defun bool-vector-count-population a
Return the number of elements that are @code{t} in bool vector @var{a}.
@end defun
Here is an example of creating, examining, and updating a
......
......@@ -923,6 +923,7 @@ The function `display-popup-menus-p' will now return non-nil for a
display or frame whenever a mouse is supported on that display or
frame.
+++
** New bool-vector set operation functions:
*** `bool-vector-exclusive-or'
*** `bool-vector-union'
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment