summaryrefslogtreecommitdiff
path: root/doc/ref
diff options
context:
space:
mode:
authorDaniel Llorens <daniel.llorens@bluewin.ch>2013-01-23 09:59:58 +0100
committerAndy Wingo <wingo@pobox.com>2013-02-18 16:57:16 +0100
commit739941679c2c7dc36c29c30aff7d4c1b436ba773 (patch)
tree97604e206e2770753dd26b51535678a88b77ea08 /doc/ref
parent118ff892be199f0af359d1b027645d4783a364ec (diff)
downloadguile-739941679c2c7dc36c29c30aff7d4c1b436ba773.tar.gz
Array documentation fixes
* libguile/generalized-arrays.c: Fix wording of docstring for array-length. * doc/ref/api-compund.texi: - Document scm_array_type(), scm_array_ref(), array-length, scm_array_length(), scm_c_array_length(). - Fix wording of documentation for array-in-bounds?
Diffstat (limited to 'doc/ref')
-rw-r--r--doc/ref/api-compound.texi11
1 files changed, 10 insertions, 1 deletions
diff --git a/doc/ref/api-compound.texi b/doc/ref/api-compound.texi
index ab2bd3087..6dfc5fdc0 100644
--- a/doc/ref/api-compound.texi
+++ b/doc/ref/api-compound.texi
@@ -1392,6 +1392,7 @@ as elements in the list.
@end deffn
@deffn {Scheme Procedure} array-type array
+@deffnx {C Function} scm_array_type (array)
Return the type of @var{array}. This is the `vectag' used for
printing @var{array} (or @code{#t} for ordinary arrays) and can be
used with @code{make-typed-array} to create an array of the same kind
@@ -1399,6 +1400,7 @@ as @var{array}.
@end deffn
@deffn {Scheme Procedure} array-ref array idx @dots{}
+@deffnx {C Function} scm_array_ref (array, idxlist)
Return the element at @code{(idx @dots{})} in @var{array}.
@example
@@ -1409,7 +1411,7 @@ Return the element at @code{(idx @dots{})} in @var{array}.
@deffn {Scheme Procedure} array-in-bounds? array idx @dots{}
@deffnx {C Function} scm_array_in_bounds_p (array, idxlist)
-Return @code{#t} if the given index would be acceptable to
+Return @code{#t} if the given indices would be acceptable to
@code{array-ref}.
@example
@@ -1450,6 +1452,13 @@ For example,
@end example
@end deffn
+@deffn {Scheme Procedure} array-length array
+@deffnx {C Function} scm_array_length (array)
+@deffnx {C Function} size_t scm_c_array_length (array)
+Return the length of an array: its first dimension. It is an error to
+ask for the length of an array of rank 0.
+@end deffn
+
@deffn {Scheme Procedure} array-rank array
@deffnx {C Function} scm_array_rank (array)
Return the rank of @var{array}.