package core_kernel

  1. Overview
  2. Docs
package core_kernel
Legend:
Library
Module
Module type
Parameter
Class
Class type

doubly-linked lists

Compared to other doubly-linked lists, in this one:

1. Calls to modification functions (insert*, move*, ...) detect if the list is being iterated over (iter, fold, ...), and if so raise an exception. For example, a use like the following would raise.

iter t ~f:(fun _ -> ... remove t e ...)

2. There is a designated "front" and "back" of each list, rather than viewing each element as an equal in a ring.

3. Elements know which list they're in. Each operation that takes an Elt.t also takes a t, first checks that the Elt belongs to the t, and if not, raises.

4. Related to (3), lists cannot be split, though a sort of splicing is available as transfer. In other words, no operation will cause one list to become two. This makes this module unsuitable for maintaining the faces of a planar graph under edge insertion and deletion, for example.

5. Another property permitted by (3) and (4) is that length is O(1).

module Elt : sig ... end
type 'a t
include sig ... end
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
include Container.S1 with type 'a t := 'a t
val mem : 'a t -> 'a -> equal:('a -> 'a -> bool) -> bool

Checks whether the provided element is there, using equal.

val length : 'a t -> int
val is_empty : 'a t -> bool
val iter : 'a t -> f:('a -> unit) -> unit
val fold : 'a t -> init:'accum -> f:('accum -> 'a -> 'accum) -> 'accum

fold t ~init ~f returns f (... f (f (f init e1) e2) e3 ...) en, where e1..en are the elements of t

val fold_result : 'a t -> init:'accum -> f:('accum -> 'a -> ('accum, 'e) Base.Result.t) -> ('accum, 'e) Base.Result.t

fold_result t ~init ~f is a short-circuiting version of fold that runs in the Result monad. If f returns an Error _, that value is returned without any additional invocations of f.

val fold_until : 'a t -> init:'accum -> f:('accum -> 'a -> ('accum, 'stop) Base.Container_intf.Continue_or_stop.t) -> ('accum, 'stop) Base.Container_intf.Finished_or_stopped_early.t

fold_until t ~init ~f is a short-circuiting version of fold. If f returns Stop _ the computation ceases and results in that value. If f returns Continue _, the fold will proceed.

val exists : 'a t -> f:('a -> bool) -> bool

Returns true if and only if there exists an element for which the provided function evaluates to true. This is a short-circuiting operation.

val for_all : 'a t -> f:('a -> bool) -> bool

Returns true if and only if the provided function evaluates to true for all elements. This is a short-circuiting operation.

val count : 'a t -> f:('a -> bool) -> int

Returns the number of elements for which the provided function evaluates to true.

val sum : (module Base.Commutative_group.S with type t = 'sum) -> 'a t -> f:('a -> 'sum) -> 'sum

Returns the sum of f i for i in the container

val find : 'a t -> f:('a -> bool) -> 'a option

Returns as an option the first element for which f evaluates to true.

val find_map : 'a t -> f:('a -> 'b option) -> 'b option

Returns the first evaluation of f that returns Some, and returns None if there is no such element.

val to_list : 'a t -> 'a list
val to_array : 'a t -> 'a array
val min_elt : 'a t -> cmp:('a -> 'a -> int) -> 'a option

Returns a minimum (resp maximum) element from the collection using the provided cmp function, or None if the collection is empty. In case of a tie, the first element encountered while traversing the collection is returned. The implementation uses fold so it has the same complexity as fold.

val max_elt : 'a t -> cmp:('a -> 'a -> int) -> 'a option
include Base.Invariant.S1 with type 'a t := 'a t
val invariant : ('a -> unit) -> 'a t -> unit
val create : Base.Unit.t -> 'a t

creating doubly-linked lists

val of_list : 'a Base.List.t -> 'a t

of_list l returns a doubly-linked list t with the same elements as l and in the same order (i.e. the first element of l is the first element of t). It is always the case that l = to_list (of_list l).

val of_array : 'a Base.Array.t -> 'a t
val equal : 'a t -> 'a t -> Base.Bool.t

predicates

pointer equality

val is_first : 'a t -> 'a Elt.t -> Base.Bool.t
val is_last : 'a t -> 'a Elt.t -> Base.Bool.t
val mem_elt : 'a t -> 'a Elt.t -> Base.Bool.t
val first_elt : 'a t -> 'a Elt.t Base.Option.t

constant-time extraction of first and last elements.

val last_elt : 'a t -> 'a Elt.t Base.Option.t
val first : 'a t -> 'a Base.Option.t
val last : 'a t -> 'a Base.Option.t
val next : 'a t -> 'a Elt.t -> 'a Elt.t Base.Option.t

constant-time retrieval of next or previous element.

val prev : 'a t -> 'a Elt.t -> 'a Elt.t Base.Option.t
val insert_before : 'a t -> 'a Elt.t -> 'a -> 'a Elt.t

constant-time insertion of a new element.

val insert_after : 'a t -> 'a Elt.t -> 'a -> 'a Elt.t
val insert_first : 'a t -> 'a -> 'a Elt.t
val insert_last : 'a t -> 'a -> 'a Elt.t
val move_to_front : 'a t -> 'a Elt.t -> Base.Unit.t

constant-time move of an element from and to positions in the same list. An exception is raised if elt is equal to anchor.

val move_to_back : 'a t -> 'a Elt.t -> Base.Unit.t
val move_after : 'a t -> 'a Elt.t -> anchor:'a Elt.t -> Base.Unit.t
val move_before : 'a t -> 'a Elt.t -> anchor:'a Elt.t -> Base.Unit.t
val remove : 'a t -> 'a Elt.t -> Base.Unit.t

constant-time removal of an element.

val remove_first : 'a t -> 'a Base.Option.t
val remove_last : 'a t -> 'a Base.Option.t
val fold_elt : 'a t -> init:'b -> f:('b -> 'a Elt.t -> 'b) -> 'b

fold_elt t ~init ~f is the same as fold, except f is called with the 'a Elt.t's from the list instead of the contained 'a values.

Note that like other iteration functions, it is an error to mutate t inside the fold. If you'd like to call remove on any of the 'a Elt.t's, use filter_inplace.

val iter_elt : 'a t -> f:('a Elt.t -> Base.Unit.t) -> Base.Unit.t
val fold_right : 'a t -> init:'b -> f:('a -> 'b -> 'b) -> 'b
val find_elt : 'a t -> f:('a -> Base.Bool.t) -> 'a Elt.t Base.Option.t

find_elt t ~f finds the first element in t that satisfies f, by testing each of element of t in turn until f succeeds.

val clear : 'a t -> Base.Unit.t

clear t removes all elements from the list in constant time.

val copy : 'a t -> 'a t
val transfer : src:'a t -> dst:'a t -> Base.Unit.t

transfer ~src ~dst has the same behavior as iter src ~f:(insert_last dst); clear src except that it runs in constant time.

If s = to_list src and d = to_list dst, then after transfer ~src ~dst: to_list src = [] to_list dst = d @ s

val filter_inplace : 'a t -> f:('a -> Base.Bool.t) -> Base.Unit.t

filter_inplace t ~f removes all elements of t that don't satisfy f.

val unchecked_iter : 'a t -> f:('a -> Base.Unit.t) -> Base.Unit.t

unchecked_iter t ~f behaves like iter t ~f except that f is allowed to modify t. Adding or removing elements before the element currently being visited has no effect on the traversal. Elements added after the element currently being visited will be traversed. Elements deleted after the element currently being visited will not be traversed. Deleting the element currently visited is an error that is not detected (presumably leading to an infinite loop) .

val to_sequence : 'a t -> 'a Sequence.t

A sequence of values from the doubly linked list. It makes an intermediate copy of the list so that the returned sequence is immune to any subsequent mutation of the original list.

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