package containers

  1. Overview
  2. Docs
package containers
Legend:
Library
Module
Module type
Parameter
Class
Class type
type t
type left
type right
val empty : t
val is_empty : t -> bool
val equal : t -> t -> bool
val compare : t -> t -> int
val add : left -> right -> t -> t

Add left and right correspondence to bijection such that left and right are unique in their respective sets and only correspond to each other.

val cardinal : t -> int

Number of bindings. O(n) time

val mem : left -> right -> t -> bool

Checks both sides for key membership.

val mem_left : left -> t -> bool

Checks for membership of correspondence using left key

val mem_right : right -> t -> bool

Checks for membership of correspondence using right key

val find_left : left -> t -> right
  • raises Not_found

    if left is not found

val find_right : right -> t -> left
  • raises Not_found

    if right is not found

val remove : left -> right -> t -> t

Removes the left, right binding if it exists. Returns the same bijection otherwise.

val remove_left : left -> t -> t

Remove the binding with left key if it exists. Returns the same bijection otherwise

val remove_right : right -> t -> t

Remove the binding with right key if it exists. Returns the same bijection otherwise

val list_left : t -> (left * right) list

returns the bindings as a list of (left, right) values

val list_right : t -> (right * left) list

returns the bindings as a list of (right, [left]) values

val add_seq : (left * right) sequence -> t -> t
val of_seq : (left * right) sequence -> t
val to_seq : t -> (left * right) sequence
val add_list : (left * right) list -> t -> t
val of_list : (left * right) list -> t
val to_list : t -> (left * right) list
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events Blog 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