lloda pushed a commit to branch wip-vector-cleanup in repository guile. commit bd16ee925b032b2e369ec200eb3b883226c46083 Author: Daniel Llorens <ll...@sarc.name> 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