package batteries

  1. Overview
  2. Docs
package batteries
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module BatRefList.IndexSource

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

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct