module AtomicInt64Array: sig .. end
Atomic containers for arrays of int64
values.
type index = int32
The type of array indices.
val make : int32 -> t
Returns a new container holding an array of passed length.
Raises Java_error
if passed length is negative
val add_and_get : t -> index -> int64 -> int64
add_and_get a i d
atomically adds d
to the value at index i
,
and returns the new value.
Raises Java_error
if passed index is invalid
val compare_and_set : t -> index -> int64 -> int64 -> bool
compare_and_set a i e u
atomically sets the value of a
at index
i
to u
if the current value is e
. Returns whether the value of
a
at index i
was equal to e
.
Raises Java_error
if passed index is invalid
val decrement_and_get : t -> index -> int64
Atomically decrements the value at passed index, and returns the new
value.
Raises Java_error
if passed index is invalid
val get : t -> index -> int64
Returns the value at passed index.
Raises Java_error
if passed index is invalid
val get_and_add : t -> index -> int64 -> int64
get_and_add a i d
atomically adds d
to the value at index i
,
and returns the previous value.
Raises Java_error
if passed index is invalid
val get_and_decrement : t -> index -> int64
Atomically decrements the value at passed index, and returns the
previous value.
Raises Java_error
if passed index is invalid
val get_and_increment : t -> index -> int64
Atomically increments the value at passed index, and returns the
previous value.
Raises Java_error
if passed index is invalid
val get_and_set : t -> index -> int64 -> int64
get_and_set a i x
atomically sets the value of a
at index i
to
x
, and returns the previous value.
Raises Java_error
if passed index is invalid
val increment_and_get : t -> index -> int64
Atomically increments the value at passed index, and returns the new
value.
Raises Java_error
if passed index is invalid
val lazy_set : t -> index -> int64 -> unit
lazy_set a i x
eventually sets the value of a
at index i
to
x
.
Raises Java_error
if passed index is invalid
val length : t -> int32
Returns the length of the array.
val set : t -> index -> int64 -> unit
set a i x
sets the value of a
at index i
to x
.
Raises Java_error
if passed index is invalid
val weak_compare_and_set : t -> index -> int64 -> int64 -> bool
Similar to
AtomicInt64Array.compare_and_set
, with a
weak semantics: may be
faster on some platforms, but does not provide ordering guarantees.
Raises Java_error
if passed index is invalid
Null value
val null : t
The null
value.
val is_null : t -> bool
is_null obj
returns true
iff obj
is equal to null
.
val is_not_null : t -> bool
is_not_null obj
returns false
iff obj
is equal to null
.
Miscellaneous
val wrap : t -> t option
wrap obj
wraps the reference
obj
into an option type:
Some x
if obj
is not null
;
None
if obj
is null
.
val unwrap : t option -> t
unwrap obj
unwraps the option
obj
into a bare reference:
Some x
is mapped to x
;
None
is mapped to null
.