Updated documentation

This commit is contained in:
retropikzel 2025-05-03 08:13:51 +03:00
parent 99a23fac0a
commit 37c6d1433a
1 changed files with 13 additions and 2 deletions

View File

@ -449,8 +449,9 @@ with u16 in their names deal with the unsigned representation; those with s16
in their names deal with the twos-complement representation. in their names deal with the twos-complement representation.
The procedures with native in their names employ the native endianness, and The procedures with native in their names employ the native endianness, and
work only at aligned indices: _k_ must be a multiple of 2. The ...-set! work only at aligned indices: _k_ must be a multiple of 2.
procedures return unspecified values.
The ...-set! procedures return unspecified values.
(**c-bytevector-u32-ref** _bytevector_ _k_ _endianness_) (**c-bytevector-u32-ref** _bytevector_ _k_ _endianness_)
(**c-bytevector-s32-ref** _bytevector_ _k_ _endianness_) (**c-bytevector-s32-ref** _bytevector_ _k_ _endianness_)
@ -467,6 +468,16 @@ interval {0,...,232 1}. For bytevector-s32-set! and
bytevector-s32-native-set!, _n_ must be an exact integer object in the bytevector-s32-native-set!, _n_ must be an exact integer object in the
interval {231,...,232 1}. interval {231,...,232 1}.
These retrieve and set four-byte representations of numbers at indices
_k_,...,_k_ + 3, according to the endianness specified by _endianness_.
The procedures with u32 in their names deal with the unsigned representation;
those with s32 with the twos-complement representation.
The procedures with native in their names employ the native endianness, and
work only at aligned indices: _k_ must be a multiple of 4.
The ...-set! procedures return unspecified values.
(**c-bytevector-s64-set!**) (**c-bytevector-s64-set!**)
(**c-bytevector-s64-ref**) (**c-bytevector-s64-ref**)
(**c-bytevector-s64-native-set!**) (**c-bytevector-s64-native-set!**)