package batteries

You can search for identifiers within the package.

in-package search v0.2.0

A community-maintained standard library extension

Install

dune-project

Dependency

github.com Readme Edit opam file Versions (14)

Authors

O

OCaml batteries-included team

Maintainers

Sources

v3.7.2.tar.gz

md5=1fd7bddce07cf5d244fc9427f7b5e4d4

sha512=c0f2a0fdc8253e0ea999d8d4c58bfbf32b18d251a2e1d9656bf279de5f01a33e9aabac3af4d95f465f8b671e7711ebd37218043face233340a0c11b08fa62f78

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

Module `BatRefList.Index`Source

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.

Sourceval 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

Sourceval 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

Sourceval 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

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

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

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

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