package core

  1. Overview
  2. Docs
package core
Legend:
Library
Module
Module type
Parameter
Class
Class type
module type Key = Hashtbl.Key_plain
module type S_backend = sig ... end

equivalent to Make_backend (Hashtbl)

include S_backend
type ('key, 'data) t

A hash-queue, where the values are of type 'data.

val sexp_of_t : ('key -> Sexplib0.Sexp.t) -> ('data -> Sexplib0.Sexp.t) -> ('key, 'data) t -> Sexplib0.Sexp.t
val length : ('a, 'b) t -> int
val is_empty : ('a, 'b) t -> bool
val iter : ('b, 'a) t -> f:('a -> unit) -> unit
val fold : ('b, 'a) t -> init:'accum -> f:('accum -> 'a -> 'accum) -> 'accum
val fold_result : ('b, 'a) t -> init:'accum -> f:('accum -> 'a -> ('accum, 'e) Base__.Result.t) -> ('accum, 'e) Base__.Result.t
val fold_until : ('b, 'a) t -> init:'accum -> f:('accum -> 'a -> ('accum, 'final) Base__.Container_intf.Continue_or_stop.t) -> finish:('accum -> 'final) -> 'final
val exists : ('b, 'a) t -> f:('a -> bool) -> bool
val for_all : ('b, 'a) t -> f:('a -> bool) -> bool
val count : ('b, 'a) t -> f:('a -> bool) -> int
val sum : (module Base__.Container_intf.Summable with type t = 'sum) -> ('b, 'a) t -> f:('a -> 'sum) -> 'sum
val find : ('b, 'a) t -> f:('a -> bool) -> 'a option
val find_map : ('c, 'a) t -> f:('a -> 'b option) -> 'b option
val to_list : ('b, 'a) t -> 'a list
val to_array : ('b, 'a) t -> 'a array
val min_elt : ('b, 'a) t -> compare:('a -> 'a -> int) -> 'a option
val max_elt : ('b, 'a) t -> compare:('a -> 'a -> int) -> 'a option

invariant t checks the invariants of the queue.

val invariant : ('key, 'data) t -> Base.Unit.t
val create : ?growth_allowed:Base.Bool.t -> ?size:Base.Int.t -> 'key Core__.Hashtbl.Hashable.t -> ('key, 'data) t

create () returns an empty queue. The arguments growth_allowed and size are referring to the underlying hashtable.

  • parameter growth_allowed

    defaults to true

  • parameter size

    initial size -- default to 16

val clear : ('key, 'data) t -> Base.Unit.t

Clears the queue.

val copy : ('key, 'data) t -> ('key, 'data) t

Makes a fresh copy of the queue with identical contents to the original.

Finding elements

val mem : ('key, 'data) t -> 'key -> Base.Bool.t

mem q k returns true iff there is some (k, v) in the queue.

val lookup : ('key, 'data) t -> 'key -> 'data Base.Option.t

lookup t k returns the value of the key-value pair in the queue with key k, if there is one.

val lookup_exn : ('key, 'data) t -> 'key -> 'data

Adding, removing, and replacing elements

Note that even the non-*_exn versions can raise, but only if there is an ongoing iteration.

val enqueue : ('key, 'data) t -> [ `back | `front ] -> 'key -> 'data -> [ `Ok | `Key_already_present ]

enqueue t back_or_front k v adds the key-value pair (k, v) to the front or back of the queue, returning `Ok if the pair was added, or `Key_already_present if there is already a (k, v') in the queue.

val enqueue_exn : ('key, 'data) t -> [ `back | `front ] -> 'key -> 'data -> Base.Unit.t

Like enqueue, but it raises in the `Key_already_present case

val enqueue_back : ('key, 'data) t -> 'key -> 'data -> [ `Ok | `Key_already_present ]

See enqueue. enqueue_back t k v is the same as enqueue t `back k v

val enqueue_back_exn : ('key, 'data) t -> 'key -> 'data -> Base.Unit.t

See enqueue_exn. enqueue_back_exn t k v is the same as enqueue_exn t `back k v

val enqueue_front : ('key, 'data) t -> 'key -> 'data -> [ `Ok | `Key_already_present ]

See enqueue. enqueue_front t k v is the same as enqueue t `front k v

val enqueue_front_exn : ('key, 'data) t -> 'key -> 'data -> Base.Unit.t

See enqueue_exn. enqueue_front_exn t k v is the same as enqueue_exn t `front k v

val lookup_and_move_to_back : ('key, 'data) t -> 'key -> 'data Base.Option.t

lookup_and_move_to_back finds the key-value pair (k, v) and moves it to the back of the queue if it exists, otherwise returning None.

The _exn versions of these functions raise if key-value pair does not exist.

val lookup_and_move_to_back_exn : ('key, 'data) t -> 'key -> 'data

Like lookup_and_move_to_back, but raises instead of returning an option

val lookup_and_move_to_front : ('key, 'data) t -> 'key -> 'data Base.Option.t

Like lookup_and_move_to_back, but moves element to the front of the queue

val lookup_and_move_to_front_exn : ('key, 'data) t -> 'key -> 'data

Like lookup_and_move_to_front, but raises instead of returning an option

val last : ('key, 'data) t -> 'data Base.Option.t

last t returns the last element of the queue, without removing it.

val last_with_key : ('key, 'data) t -> ('key * 'data) Base.Option.t

last_with_key t returns the last element of the queue and its key, without removing it.

val first : ('key, 'data) t -> 'data Base.Option.t

first t returns the front element of the queue, without removing it.

val first_with_key : ('key, 'data) t -> ('key * 'data) Base.Option.t

first_with_key t returns the front element of the queue and its key, without removing it.

val keys : ('key, 'data) t -> 'key Base.List.t

keys t returns the keys in the order of the queue.

val dequeue : ('key, 'data) t -> [ `back | `front ] -> 'data Base.Option.t

dequeue t front_or_back returns the front or back element of the queue.

val dequeue_exn : ('key, 'data) t -> [ `back | `front ] -> 'data

Like dequeue, but it raises if the queue is empty.

val dequeue_back : ('key, 'data) t -> 'data Base.Option.t

dequeue_back t returns the back element of the queue.

val dequeue_back_exn : ('key, 'data) t -> 'data

Like dequeue_back, but it raises if the queue is empty.

val dequeue_front : ('key, 'data) t -> 'data Base.Option.t

dequeue_front t returns the front element of the queue.

val dequeue_front_exn : ('key, 'data) t -> 'data

Like dequeue_front, but it raises if the queue is empty.

val dequeue_with_key : ('key, 'data) t -> [ `back | `front ] -> ('key * 'data) Base.Option.t

dequeue_with_key t returns the front or back element of the queue and its key.

val dequeue_with_key_exn : ('key, 'data) t -> [ `back | `front ] -> 'key * 'data

Like dequeue_with_key, but it raises if the queue is empty.

val dequeue_back_with_key : ('key, 'data) t -> ('key * 'data) Base.Option.t

dequeue_back_with_key t returns the back element of the queue and its key.

val dequeue_back_with_key_exn : ('key, 'data) t -> 'key * 'data

Like dequeue_back_with_key, but it raises if the queue is empty.

val dequeue_front_with_key : ('key, 'data) t -> ('key * 'data) Base.Option.t

dequeue_front_with_key t returns the front element of the queue and its key.

val dequeue_front_with_key_exn : ('key, 'data) t -> 'key * 'data

Like dequeue_front_with_key, but it raises if the queue is empty.

val dequeue_all : ('key, 'data) t -> f:('data -> Base.Unit.t) -> Base.Unit.t

dequeue_all t ~f dequeues every element of the queue and applies f to each one. The dequeue order is from front to back.

val remove : ('key, 'data) t -> 'key -> [ `Ok | `No_such_key ]

remove q k removes the key-value pair with key k from the queue.

val remove_exn : ('key, 'data) t -> 'key -> Base.Unit.t
val lookup_and_remove : ('key, 'data) t -> 'key -> 'data Base.Option.t

like remove, but returns the removed element

val replace : ('key, 'data) t -> 'key -> 'data -> [ `Ok | `No_such_key ]

replace q k v changes the value of key k in the queue to v.

val replace_exn : ('key, 'data) t -> 'key -> 'data -> Base.Unit.t
val drop : ?n:Base.Int.t -> ('key, 'data) t -> [ `back | `front ] -> Base.Unit.t

drop ?n q back_or_front drops n elements (default 1) from the back or front of the queue. If the queue has fewer than n elements then it is cleared.

val drop_front : ?n:Base.Int.t -> ('key, 'data) t -> Base.Unit.t

Equivalent to drop ?n q `front.

val drop_back : ?n:Base.Int.t -> ('key, 'data) t -> Base.Unit.t

Equivalent to drop ?n q `back.

Iterating over elements

val iteri : ('key, 'data) t -> f:(key:'key -> data:'data -> Base.Unit.t) -> Base.Unit.t

iter t ~f applies f to each key and element of the queue.

val foldi : ('key, 'data) t -> init:'b -> f:('b -> key:'key -> data:'data -> 'b) -> 'b
module type S = sig ... end
module Make (Key : Hashtbl.Key_plain) : S with type key = Key.t
module Make_with_hashable (T : sig ... end) : S with type key = T.Key.t
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