package graphlib

  1. Overview
  2. Docs
package graphlib
Legend:
Library
Module
Module type
Parameter
Class
Class type
module Key : sig ... end
type 'a t

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

val sexp_of_t : ('a -> Ppx_sexp_conv_lib.Sexp.t) -> 'a t -> Ppx_sexp_conv_lib.Sexp.t
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
val fold_result : 'a t -> init:'accum -> f:('accum -> 'a -> ('accum, 'e) Base__.Result.t) -> ('accum, 'e) Base__.Result.t
val fold_until : 'a t -> init:'accum -> f:('accum -> 'a -> ('accum, 'final) Base__.Container_intf.Continue_or_stop.t) -> finish:('accum -> 'final) -> 'final
val exists : 'a t -> f:('a -> bool) -> bool
val for_all : 'a t -> f:('a -> bool) -> bool
val count : 'a t -> f:('a -> bool) -> int
val sum : (module Base__.Commutative_group.S with type t = 'sum) -> 'a t -> f:('a -> 'sum) -> 'sum
val find : 'a t -> f:('a -> bool) -> 'a option
val find_map : 'a t -> f:('a -> 'b option) -> 'b option
val to_list : 'a t -> 'a list
val to_array : 'a t -> 'a array
val min_elt : 'a t -> compare:('a -> 'a -> int) -> 'a option
val max_elt : 'a t -> compare:('a -> 'a -> int) -> 'a option

invariant t checks the invariants of the queue.

val invariant : 'a t -> Base.Unit.t
val create : ?growth_allowed:Base.Bool.t -> ?size:Base.Int.t -> Base.Unit.t -> 'a 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 : 'a t -> Base.Unit.t

Clears the queue.

Finding elements

val mem : 'a t -> Key.t -> Base.Bool.t

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

val lookup : 'a t -> Key.t -> 'a 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 : 'a t -> Key.t -> 'a

Adding, removing, and replacing elements

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

val enqueue : 'a t -> Key.t -> 'a -> [ `Ok | `Key_already_present ]

enqueue t k v adds the key-value pair (k, v) to the end 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 : 'a t -> Key.t -> 'a -> Base.Unit.t
val lookup_and_move_to_back : 'a t -> Key.t -> 'a Base.Option.t
val lookup_and_move_to_back_exn : 'a t -> Key.t -> 'a
val first : 'a t -> 'a Base.Option.t

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

val first_with_key : 'a t -> (Key.t * 'a) Base.Option.t

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

val keys : 'a t -> Key.t Base.List.t

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

val dequeue : 'a t -> 'a Base.Option.t

dequeue t returns the front element of the queue.

val dequeue_exn : 'a t -> 'a
val dequeue_with_key : 'a t -> (Key.t * 'a) Base.Option.t

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

val dequeue_with_key_exn : 'a t -> Key.t * 'a
val dequeue_all : 'a t -> f:('a -> Base.Unit.t) -> Base.Unit.t

dequeue_all t ~f dequeues every element of the queue and applies f to each one.

val remove : 'a t -> Key.t -> [ `Ok | `No_such_key ]

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

val remove_exn : 'a t -> Key.t -> Base.Unit.t
val replace : 'a t -> Key.t -> 'a -> [ `Ok | `No_such_key ]

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

val replace_exn : 'a t -> Key.t -> 'a -> Base.Unit.t

Iterating over elements

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

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

val foldi : 'a t -> init:'b -> f:('b -> key:Key.t -> data:'a -> 'b) -> 'b
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