Add documentation of unsafe-fxvector-length and friends

This commit is contained in:
Gustavo Massaccesi 2015-01-23 23:31:52 -03:00 committed by Matthew Flatt
parent e2261096cb
commit 9ecf98a0a0

View File

@ -2,6 +2,7 @@
@(require "mz.rkt"
(for-label racket/unsafe/ops
racket/flonum
racket/fixnum
racket/extflonum
(only-in ffi/vector
f64vector?
@ -281,6 +282,18 @@ Unsafe versions of @racket[bytes-length], @racket[bytes-ref], and
fixnum).}
@deftogether[(
@defproc[(unsafe-fxvector-length [v fxvector?]) fixnum?]
@defproc[(unsafe-fxvector-ref [v fxvector?] [k fixnum?]) any/c]
@defproc[(unsafe-fxvector-set! [v fxvector?] [k fixnum?] [x fixnum?]) void?]
)]{
Unsafe versions of @racket[fxvector-length], @racket[fxvector-ref], and
@racket[fxvector-set!]. A @tech{fxvector}'s size can never be larger than a
@tech{fixnum} (so even @racket[fxvector-length] always returns a
fixnum).}
@deftogether[(
@defproc[(unsafe-flvector-length [v flvector?]) fixnum?]
@defproc[(unsafe-flvector-ref [v flvector?] [k fixnum?]) any/c]