package batteries

You can search for identifiers within the package.

in-package search v0.2.0

A community-maintained standard library extension

Install

Dune Dependency

batteries.forge.ocamlcore.org Edit opam file Versions (14)

Authors

O

OCaml batteries-included team

Maintainers

Sources

v3.2.0.tar.gz

sha256=00f34b9aed4e47f314425b2ca9ceac206f112095a17ea9a7ffa6dac8cfccc492

md5=066051f9a210277710c54ad57c3b9568

doc/batteries.unthreaded/BatRefList/Index/index.html

Module `BatRefList.Index`

Functions that operate on the element at index i in a list (with indices starting from 0).

While it is sometimes necessary to perform these operations on lists (hence their inclusion here), the functions were moved to an inner module to prevent their overuse: all functions work in O(n) time. You might prefer to use Array or DynArray for constant time indexed element access.

val index_of : 'a t -> 'a -> int

Return the index (position : 0 starting) of an element in a ref list, using ( = ) for testing element equality raise Not_found if no element was found

val index : ('a -> bool) -> 'a t -> int

Return the index (position : 0 starting) of an element in a ref list, using the specified comparator raise Not_found if no element was found

val at_index : 'a t -> int -> 'a

Return the element of ref list at the specified index raise Invalid_index if the index is outside 0 ; length-1

val set : 'a t -> int -> 'a -> unit

Change the element at the specified index raise Invalid_index if the index is outside 0 ; length-1

val remove_at : 'a t -> int -> unit

Remove the element at the specified index raise Invalid_index if the index is outside 0 ; length-1