type key = tval length : ('a, 'b) Core_kernel.Hash_queue.t -> intval is_empty : ('a, 'b) Core_kernel.Hash_queue.t -> boolval iter : ('b, 'a) Core_kernel.Hash_queue.t -> f:('a -> unit) -> unitval fold :
('b, 'a) Core_kernel.Hash_queue.t ->
init:'accum ->
f:('accum -> 'a -> 'accum) ->
'accumval fold_result :
('b, 'a) Core_kernel.Hash_queue.t ->
init:'accum ->
f:('accum -> 'a -> ('accum, 'e) Base__.Result.t) ->
('accum, 'e) Base__.Result.tval fold_until :
('b, 'a) Core_kernel.Hash_queue.t ->
init:'accum ->
f:('accum -> 'a -> ('accum, 'final) Base__Container_intf.Continue_or_stop.t) ->
finish:('accum -> 'final) ->
'finalval exists : ('b, 'a) Core_kernel.Hash_queue.t -> f:('a -> bool) -> boolval for_all : ('b, 'a) Core_kernel.Hash_queue.t -> f:('a -> bool) -> boolval count : ('b, 'a) Core_kernel.Hash_queue.t -> f:('a -> bool) -> intval sum :
(module Base__Container_intf.Summable with type t = 'sum) ->
('b, 'a) Core_kernel.Hash_queue.t ->
f:('a -> 'sum) ->
'sumval find : ('b, 'a) Core_kernel.Hash_queue.t -> f:('a -> bool) -> 'a optionval find_map :
('c, 'a) Core_kernel.Hash_queue.t ->
f:('a -> 'b option) ->
'b optionval to_list : ('b, 'a) Core_kernel.Hash_queue.t -> 'a listval to_array : ('b, 'a) Core_kernel.Hash_queue.t -> 'a arrayval min_elt :
('b, 'a) Core_kernel.Hash_queue.t ->
compare:('a -> 'a -> int) ->
'a optionval max_elt :
('b, 'a) Core_kernel.Hash_queue.t ->
compare:('a -> 'a -> int) ->
'a optioninvariant t checks the invariants of the queue.
val invariant : ('key, 'data) Core_kernel.Hash_queue.t -> Base.Unit.tval create :
?growth_allowed:Base.Bool.t ->
?size:Base.Int.t ->
Base.Unit.t ->
(key, 'data) Core_kernel.Hash_queue.tcreate () returns an empty queue. The arguments growth_allowed and size are referring to the underlying hashtable.
val clear : ('key, 'data) Core_kernel.Hash_queue.t -> Base.Unit.tClears the queue.
val mem : ('key, 'data) Core_kernel.Hash_queue.t -> 'key -> Base.Bool.tmem q k returns true iff there is some (k, v) in the queue.
val lookup :
('key, 'data) Core_kernel.Hash_queue.t ->
'key ->
'data Base.Option.tlookup 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) Core_kernel.Hash_queue.t -> 'key -> 'dataNote that even the non-*_exn versions can raise, but only if there is an ongoing iteration.
val enqueue :
('key, 'data) Core_kernel.Hash_queue.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) Core_kernel.Hash_queue.t ->
[ `back | `front ] ->
'key ->
'data ->
Base.Unit.tLike enqueue, but it raises in the `Key_already_present case
val enqueue_back :
('key, 'data) Core_kernel.Hash_queue.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) Core_kernel.Hash_queue.t ->
'key ->
'data ->
Base.Unit.tSee enqueue_exn. enqueue_back_exn t k v is the same as enqueue_exn t `back k v
val enqueue_front :
('key, 'data) Core_kernel.Hash_queue.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) Core_kernel.Hash_queue.t ->
'key ->
'data ->
Base.Unit.tSee 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) Core_kernel.Hash_queue.t ->
'key ->
'data Base.Option.tlookup_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) Core_kernel.Hash_queue.t ->
'key ->
'dataLike lookup_and_move_to_back, but raises instead of returning an option
val lookup_and_move_to_front :
('key, 'data) Core_kernel.Hash_queue.t ->
'key ->
'data Base.Option.tLike lookup_and_move_to_back, but moves element to the front of the queue
val lookup_and_move_to_front_exn :
('key, 'data) Core_kernel.Hash_queue.t ->
'key ->
'dataLike lookup_and_move_to_front, but raises instead of returning an option
val first : ('key, 'data) Core_kernel.Hash_queue.t -> 'data Base.Option.tfirst t returns the front element of the queue, without removing it.
val first_with_key :
('key, 'data) Core_kernel.Hash_queue.t ->
('key * 'data) Base.Option.tfirst_with_key t returns the front element of the queue and its key, without removing it.
val keys : ('key, 'data) Core_kernel.Hash_queue.t -> 'key Base.List.tkeys t returns the keys in the order of the queue.
val dequeue :
('key, 'data) Core_kernel.Hash_queue.t ->
[ `back | `front ] ->
'data Base.Option.tdequeue t front_or_back returns the front or back element of the queue.
val dequeue_exn :
('key, 'data) Core_kernel.Hash_queue.t ->
[ `back | `front ] ->
'dataLike dequeue, but it raises if the queue is empty.
val dequeue_back :
('key, 'data) Core_kernel.Hash_queue.t ->
'data Base.Option.tdequeue_back t returns the back element of the queue.
val dequeue_back_exn : ('key, 'data) Core_kernel.Hash_queue.t -> 'dataLike dequeue_back, but it raises if the queue is empty.
val dequeue_front :
('key, 'data) Core_kernel.Hash_queue.t ->
'data Base.Option.tdequeue_front t returns the front element of the queue.
val dequeue_front_exn : ('key, 'data) Core_kernel.Hash_queue.t -> 'dataLike dequeue_front, but it raises if the queue is empty.
val dequeue_with_key :
('key, 'data) Core_kernel.Hash_queue.t ->
[ `back | `front ] ->
('key * 'data) Base.Option.tdequeue_with_key t returns the front or back element of the queue and its key.
val dequeue_with_key_exn :
('key, 'data) Core_kernel.Hash_queue.t ->
[ `back | `front ] ->
'key * 'dataLike dequeue_with_key, but it raises if the queue is empty.
val dequeue_back_with_key :
('key, 'data) Core_kernel.Hash_queue.t ->
('key * 'data) Base.Option.tdequeue_back_with_key t returns the back element of the queue and its key.
val dequeue_back_with_key_exn :
('key, 'data) Core_kernel.Hash_queue.t ->
'key * 'dataLike dequeue_back_with_key, but it raises if the queue is empty.
val dequeue_front_with_key :
('key, 'data) Core_kernel.Hash_queue.t ->
('key * 'data) Base.Option.tdequeue_front_with_key t returns the front element of the queue and its key.
val dequeue_front_with_key_exn :
('key, 'data) Core_kernel.Hash_queue.t ->
'key * 'dataLike dequeue_front_with_key, but it raises if the queue is empty.
val dequeue_all :
('key, 'data) Core_kernel.Hash_queue.t ->
f:('data -> Base.Unit.t) ->
Base.Unit.tdequeue_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) Core_kernel.Hash_queue.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) Core_kernel.Hash_queue.t -> 'key -> Base.Unit.tval lookup_and_remove :
('key, 'data) Core_kernel.Hash_queue.t ->
'key ->
'data Base.Option.tlike remove, but returns the removed element
val replace :
('key, 'data) Core_kernel.Hash_queue.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) Core_kernel.Hash_queue.t ->
'key ->
'data ->
Base.Unit.tval drop :
?n:Base.Int.t ->
('key, 'data) Core_kernel.Hash_queue.t ->
[ `back | `front ] ->
Base.Unit.tdrop ?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) Core_kernel.Hash_queue.t ->
Base.Unit.tEquivalent to drop ?n q `front.
val drop_back :
?n:Base.Int.t ->
('key, 'data) Core_kernel.Hash_queue.t ->
Base.Unit.tEquivalent to drop ?n q `back.
val iteri :
('key, 'data) Core_kernel.Hash_queue.t ->
f:(key:'key -> data:'data -> Base.Unit.t) ->
Base.Unit.titer t ~f applies f to each key and element of the queue.
val foldi :
('key, 'data) Core_kernel.Hash_queue.t ->
init:'b ->
f:('b -> key:'key -> data:'data -> 'b) ->
'btype 'data t = (key, 'data) Core_kernel.Hash_queue.tval sexp_of_t :
('data -> Ppx_sexp_conv_lib.Sexp.t) ->
'data t ->
Ppx_sexp_conv_lib.Sexp.t