package core_kernel

You can search for identifiers within the package.

in-package search v0.2.0

Industrial strength alternative to OCaml's standard library

Install

Dune Dependency

github.com Readme Changelog MIT License Edit opam file Versions (10)

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street developers

Sources

v0.14.1.tar.gz

sha256=1d91a0d58e9a98809eb3bc888ae716e786c68ad5d07a874c37d9c1ef9fd24438

md5=77b25affd5155128ca757d38e496d89f

doc/core_kernel.weak_array/Weak_array/index.html

Module `Weak_array`

Module for dealing with weak pointers, i.e., pointers that don't prevent garbage collection of what they point to.

This module is like the OCaml standard library module of the same name, except that it requires that the values in the weak set are heap blocks.

type 'a t

val sexp_of_t : 
  ('a -> Ppx_sexp_conv_lib.Sexp.t) ->
  'a t ->
  Ppx_sexp_conv_lib.Sexp.t

val create : len:int -> _ t

val length : _ t -> int

val set : 'a t -> int -> 'a Core_kernel.Heap_block.t option -> unit

val set_exn : 'a t -> int -> 'a option -> unit

set_exn raises an exception if given Some x with x not being a heap block. This is in addition to raising exceptions on bounds violation as set does.

val get : 'a t -> int -> 'a Core_kernel.Heap_block.t option

val is_some : _ t -> int -> bool

val is_none : _ t -> int -> bool

val iter : 'a t -> f:('a -> unit) -> unit

val iteri : 'a t -> f:(int -> 'a -> unit) -> unit

val blit : 
  src:'a t ->
  src_pos:int ->
  dst:'a t ->
  dst_pos:int ->
  len:int ->
  unit

Warning! blit often takes time linear in the size of the arrays, not in the size of the range being copied. This issue is being tracked in https://github.com/ocaml/ocaml/issues/9258.

Other than that, blit is generally preferred over get followed by set because, unlike get, it doesn't have to make the value strongly-referenced. Making a value strongly-referenced, even temporarily, may result in delaying its garbage collection by a whole GC cycle.