[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Guile-commits] 08/23: Fix doc for last bitvector patch
From: |
Daniel Llorens |
Subject: |
[Guile-commits] 08/23: Fix doc for last bitvector patch |
Date: |
Mon, 10 Feb 2020 03:56:59 -0500 (EST) |
lloda pushed a commit to branch wip-vector-cleanup
in repository guile.
commit 7d3ab5c38c62b19a2e7b33d893e2dc92d18963b2
Author: Daniel Llorens <address@hidden>
AuthorDate: Wed Feb 5 13:25:49 2020 +0100
Fix doc for last bitvector patch
---
doc/ref/api-data.texi | 23 +++++++++++++++++------
1 file changed, 17 insertions(+), 6 deletions(-)
diff --git a/doc/ref/api-data.texi b/doc/ref/api-data.texi
index 3b4d047..148900d 100644
--- a/doc/ref/api-data.texi
+++ b/doc/ref/api-data.texi
@@ -6663,15 +6663,13 @@ For example,
@end example
@end deffn
-@deftypefn {C Function} {const scm_t_uint32 *} scm_bitvector_elements (SCM
vec, scm_t_array_handle *handle, size_t *offp, size_t *lenp, ssize_t *incp)
+@deftypefn {C Function} {const scm_t_uint32 *} scm_bitvector_elements (SCM vec)
Like @code{scm_vector_elements} (@pxref{Vector Accessing from C}), but
-for bitvectors. The variable pointed to by @var{offp} is set to the
-value returned by @code{scm_array_handle_bit_elements_offset}. See
-@code{scm_array_handle_bit_elements} for how to use the returned
-pointer and the offset.
+for bitvectors. See @code{scm_array_handle_bit_elements} for how to use the
returned
+pointer.
@end deftypefn
-@deftypefn {C Function} {scm_t_uint32 *} scm_bitvector_writable_elements (SCM
vec, scm_t_array_handle *handle, size_t *offp, size_t *lenp, ssize_t *incp)
+@deftypefn {C Function} {scm_t_uint32 *} scm_bitvector_writable_elements (SCM
vec)
Like @code{scm_bitvector_elements}, but the pointer is good for reading
and writing.
@end deftypefn
@@ -8184,6 +8182,19 @@ reading and writing. You must take care not to modify
bits outside of
the allowed index range of the array, even for contiguous arrays.
@end deftypefn
+The following functions are provided as shortcuts for the @code{_elements}
functions for the specific case of rank-1 arrays. They avoid the need to manage
the array handle object.
+
+@deftypefn {C Function} {const scm_t_uint32 *} scm_array1_bit_elements (SCM
vec, size_t *lenp, ssize_t *incp, size_t *offp)
+Obtain the parameters of the first axis of rank-1 bit array @var{vec}, plus a
pointer to the elements.
+See @code{scm_array_handle_bit_elements} for how to use these values.
+@end deftypefn
+
+@deftypefn {C Function} {scm_t_uint32 *} scm_array1_bit_writable_elements (SCM
vec, size_t *lenp, ssize_t *incp, size_t *offp)
+Like @code{scm_array1_bit_writable_elements}, but the pointer is good for
reading
+and writing.
+@end deftypefn
+
+
@node VLists
@subsection VLists
- [Guile-commits] branch wip-vector-cleanup updated (9e44157 -> bf2d6f9), Daniel Llorens, 2020/02/10
- [Guile-commits] 01/23: Require vector as argument to vector-copy, Daniel Llorens, 2020/02/10
- [Guile-commits] 02/23: Require vector as argument to vector->list, Daniel Llorens, 2020/02/10
- [Guile-commits] 03/23: Require vector argument to scm_vector_elements, scm_vector_writable_elements, Daniel Llorens, 2020/02/10
- [Guile-commits] 08/23: Fix doc for last bitvector patch,
Daniel Llorens <=
- [Guile-commits] 13/23: Move bitvector functions using array_handle to libguile/array-handle.[ch], Daniel Llorens, 2020/02/10
- [Guile-commits] 16/23: Pull generalized-vectors from under bitvector/string/vector, Daniel Llorens, 2020/02/10
- [Guile-commits] 05/23: Simple vectors are just vectors, Daniel Llorens, 2020/02/10
- [Guile-commits] 19/23: Remove generalized-vectors.[hc], Daniel Llorens, 2020/02/10
- [Guile-commits] 04/23: Remove the unused argument from scm_array_p, Daniel Llorens, 2020/02/10
- [Guile-commits] 07/23: Simplify interfaces to scm_bitvector_elements and scm_bitvector_writable_elements, Daniel Llorens, 2020/02/10
- [Guile-commits] 23/23: Remove 'contiguous' flag in arrays, Daniel Llorens, 2020/02/10
- [Guile-commits] 06/23: Simplify interfaces to scm_vector_elements and scm_vector_writable_elements, Daniel Llorens, 2020/02/10
- [Guile-commits] 10/23: Add lenp parameter back to scm_vector_(writable_)elements, Daniel Llorens, 2020/02/10
- [Guile-commits] 11/23: Add lenp parameter back to scm_bitvector_(writable_)elements, Daniel Llorens, 2020/02/10