package core_kernel

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

Parameters

Signature

module Key = Key
type 'a t
val create : ?min_size:int -> ('a -> 'a -> int) -> 'a t
val copy : 'a t -> 'a t
val push : 'a t -> key:Key.t -> data:'a -> [ `Ok | `Key_already_present ]
val push_exn : 'a t -> key:Key.t -> data:'a -> unit
val replace : 'a t -> key:Key.t -> data:'a -> unit
val remove : 'a t -> Key.t -> unit
val mem : 'a t -> Key.t -> bool
val top : 'a t -> 'a option
val top_exn : 'a t -> 'a
val top_with_key : 'a t -> (Key.t * 'a) option
val top_with_key_exn : 'a t -> Key.t * 'a
val pop_with_key : 'a t -> (Key.t * 'a) option
val pop_with_key_exn : 'a t -> Key.t * 'a
val pop : 'a t -> 'a option
val pop_exn : 'a t -> 'a
val pop_if_with_key : 'a t -> (key:Key.t -> data:'a -> bool) -> (Key.t * 'a) option
val pop_if : 'a t -> ('a -> bool) -> 'a option
val find : 'a t -> Key.t -> 'a option
val find_pop : 'a t -> Key.t -> 'a option
val find_exn : 'a t -> Key.t -> 'a
val find_pop_exn : 'a t -> Key.t -> 'a
val iter_keys : _ t -> f:(Key.t -> unit) -> unit

Mutation of the heap during iteration is not supported, but there is no check to prevent it. The behavior of a heap that is mutated during iteration is undefined.

val iter : 'a t -> f:('a -> unit) -> unit
val iteri : 'a t -> f:(key:Key.t -> data:'a -> unit) -> unit
val iter_vals : 'a t -> f:('a -> unit) -> unit
  • deprecated [since 2016-04] Use iter instead
val to_alist : 'a t -> (Key.t * 'a) list

Returns the list of all (key, value) pairs for given Hash_heap.

val length : 'a t -> int
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