summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarius Vollmer <mvo@zagadka.de>2005-01-11 00:35:20 +0000
committerMarius Vollmer <mvo@zagadka.de>2005-01-11 00:35:20 +0000
commit8789459042bae679e332515b6b15e30405935ac2 (patch)
tree54242951216782204ed25b9f8166a8f4044f7d52
parentdc91d8de1a93e7e151e7213b3a17d95019a1e55b (diff)
downloadguile-8789459042bae679e332515b6b15e30405935ac2.tar.gz
Docs for scm_array_handle_pos.
-rw-r--r--doc/ref/api-compound.texi8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/ref/api-compound.texi b/doc/ref/api-compound.texi
index 9bebdeb75..30db9796f 100644
--- a/doc/ref/api-compound.texi
+++ b/doc/ref/api-compound.texi
@@ -2280,6 +2280,14 @@ for (i = 0; i < RANK; i++)
@end example
@end deftypefn
+@deftypefn {C Function} ssize_t scm_array_handle_pos (scm_t_array_handle *handle, SCM indices)
+Compute the position corresponding to @var{indices}, a list of
+indices. The position is computed as described above for
+@code{scm_array_handle_dims}. The number of the indices and their
+range is checked and an approrpiate error is signalled for invalid
+indices.
+@end deftypefn
+
@deftypefn {C Function} SCM scm_array_handle_ref (scm_t_array_handle *handle, ssize_t pos)
Return the element at position @var{pos} in the storage block of the
array represented by @var{handle}. Any kind of array is acceptable. No