manpagez: man pages & more
man Map(3)
Home | html | info | man
Map(3)                           OCaml library                          Map(3)




NAME

       Map - Association tables over ordered types.


Module

       Module   Map


Documentation

       Module Map
        : sig end


       Association tables over ordered types.

       This  module  implements  applicative association tables, also known as
       finite maps or dictionaries, given a total ordering function  over  the
       keys.    All   operations   over   maps   are  purely  applicative  (no
       side-effects).  The implementation  uses  balanced  binary  trees,  and
       therefore  searching and insertion take time logarithmic in the size of
       the map.

       For instance: module IntPairs = struct type t = int * int  let  compare
       (x0,y0)  (x1,y1)  =  match  Pervasives.compare  x0  x1 with 0 -> Perva-
       sives.compare y0 y1 | c -> c end module PairsMap  =  Map.Make(IntPairs)
       let m = PairsMap.(empty |> add (0,1) hello |> add (1,0) world )

       This  creates  a new module PairsMap , with a new type 'a PairsMap.t of
       maps from int * int to 'a . In this example, m contains  string  values
       so its type is string PairsMap.t .





       module type OrderedType = sig end


       Input signature of the functor Map.Make .


       module type S = sig end


       Output signature of the functor Map.Make .


       module Make : functor (Ord : OrderedType) -> sig end


       Functor building an implementation of the map structure given a totally
       ordered type.





OCamldoc                          2014-10-18                            Map(3)

ocaml 4.02.1 - Generated Sun Oct 19 19:03:51 CDT 2014
© manpagez.com 2000-2024
Individual documents may contain additional copyright information.