package frama-c

  1. Overview
  2. Docs
package frama-c
Legend:
Library
Module
Module type
Parameter
Class
Class type

Signature for the Hptmap module

Functions on hptmaps are divided into two module types:

  • Shape contains only functions that do not create or modify a map: comparisons, tests, finding an element or a key, iterators.
  • S includes Shape, plus functions that create and modify maps: adding or removing elements, filter and maps, merge of two maps.
type cache_type =
  1. | NoCache
    (*

    The results of the function will not be cached.

    *)
  2. | PersistentCache of string
    (*

    The results of the function will be cached, and the function that uses the cache is a permanent closure (at the toplevel of an OCaml module).

    *)
  3. | TemporaryCache of string
    (*

    The results of the function will be cached, but the function itself is a local function which is garbage-collectable.

    *)

Some functions of this module may optionally use internal caches. It is the responsibility of the use to choose whether or not to use a cache, and whether this cache will be garbage-collectable by OCaml.

module type Shape = sig ... end

This module type contains only functions that do not create or modify maps. These functions can be applied to any maps from a given type key, regardless of the type of values bound.

module type S = sig ... end

Signature for hptmaps from hash-consed trees to values.

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