Option_array (core_kernel.Core_kernel.Option

'a Option_array.t is a compact representation of 'a option array: it avoids allocating heap objects representing Some x, usually representing them with x instead. It uses a special representation for None that's guaranteed to never collide with any representation of Some x.

type 'a t

include sig ... end

val bin_t : 'a Bin_prot.Type_class.t ‑> 'a t Bin_prot.Type_class.t

val bin_read_t : 'a Bin_prot.Read.reader ‑> 'a t Bin_prot.Read.reader

val __bin_read_t__ : 'a Bin_prot.Read.reader ‑> (Core_kernel__.Import.int ‑> 'a t) Bin_prot.Read.reader

val bin_reader_t : 'a Bin_prot.Type_class.reader ‑> 'a t Bin_prot.Type_class.reader

val bin_size_t : 'a Bin_prot.Size.sizer ‑> 'a t Bin_prot.Size.sizer

val bin_write_t : 'a Bin_prot.Write.writer ‑> 'a t Bin_prot.Write.writer

val bin_writer_t : 'a Bin_prot.Type_class.writer ‑> 'a t Bin_prot.Type_class.writer

val bin_shape_t : Bin_prot.Shape.t ‑> Bin_prot.Shape.t

val t_of_sexp : (Sexplib.Sexp.t ‑> 'a) ‑> Sexplib.Sexp.t ‑> 'a t

val sexp_of_t : ('a ‑> Sexplib.Sexp.t) ‑> 'a t ‑> Sexplib.Sexp.t

val create : len:Core_kernel__.Import.int ‑> _ t

Initially filled with all None

val init_some : Core_kernel__.Import.int ‑> f:(Core_kernel__.Import.int ‑> 'a) ‑> 'a t

val init : Core_kernel__.Import.int ‑> f:(Core_kernel__.Import.int ‑> 'a Core_kernel__.Import.option) ‑> 'a t

val length : _ t ‑> Core_kernel__.Import.int

val get : 'a t ‑> Core_kernel__.Import.int ‑> 'a Core_kernel__.Import.option

get t i returns the element number i of array t, raising if i is outside the range 0 to length t - 1.

val get_some_exn : 'a t ‑> Core_kernel__.Import.int ‑> 'a

Raises if the element number i is None.

val is_none : _ t ‑> Core_kernel__.Import.int ‑> Core_kernel__.Import.bool

is_none t i = Option.is_none (get t i)

val is_some : _ t ‑> Core_kernel__.Import.int ‑> Core_kernel__.Import.bool

is_some t i = Option.is_some (get t i)

val unsafe_get : 'a t ‑> Core_kernel__.Import.int ‑> 'a Core_kernel__.Import.option

These can cause arbitrary behavior when used for an out-of-bounds array access.

val unsafe_get_some_exn : 'a t ‑> Core_kernel__.Import.int ‑> 'a

val unsafe_is_some : _ t ‑> Core_kernel__.Import.int ‑> Core_kernel__.Import.bool

val set : 'a t ‑> Core_kernel__.Import.int ‑> 'a Core_kernel__.Import.option ‑> Core_kernel__.Import.unit

set t i x modifies array t in place, replacing element number i with x, raising if i is outside the range 0 to length t - 1.

val set_some : 'a t ‑> Core_kernel__.Import.int ‑> 'a ‑> Core_kernel__.Import.unit

val set_none : _ t ‑> Core_kernel__.Import.int ‑> Core_kernel__.Import.unit

val clear : _ t ‑> Core_kernel__.Import.unit

Replaces all the elements of the array with None.

val unsafe_set : 'a t ‑> Core_kernel__.Import.int ‑> 'a Core_kernel__.Import.option ‑> Core_kernel__.Import.unit

Unsafe versions of set*. Can cause arbitrary behaviour when used for an out-of-bounds array access.

val unsafe_set_some : 'a t ‑> Core_kernel__.Import.int ‑> 'a ‑> Core_kernel__.Import.unit

val unsafe_set_none : _ t ‑> Core_kernel__.Import.int ‑> Core_kernel__.Import.unit

include Blit.S1 with type a t := a t

type 'a t

val blit : ('a t, 'a t) Base.Blit_intf.blit

val blito : ('a t, 'a t) Base.Blit_intf.blito

val unsafe_blit : ('a t, 'a t) Base.Blit_intf.blit

val sub : ('a t, 'a t) Base.Blit_intf.sub

val subo : ('a t, 'a t) Base.Blit_intf.subo