package batteries
Install
dune-project
Dependency
Authors
Maintainers
Sources
md5=b7f3b99f12f21b1da6b6aa13d993206d
sha512=8b7f2479eb0271bcfd9168887c1e4a9a815c512eab3ee61b150fc4dfa9ec803e4f73115155f20b3017e4a822148d0e6d1c1e8e5f96790fd691b419dd39a908a2
doc/batteries.unthreaded/BatCache/index.html
Module BatCache
Source
The data structure for a manual cache with keys 'a
and values 'b
.
This cache gives access to some internals of a memoized function f
, called the generating function. This function is usually pure; always returning the same output for a given input. This module allows the results of complex functions to be cached so that the function does not need to be called again to get that result.
When c.get k
is called, an internal structure is first consulted to see if f k
has been stored in that structure. If it has, then that previous result is returned, otherwise, f k
is evaluated, the result stored in the caching structure and also returned to the user.
The user is allowed to remove a value from the caching structure with c.del k
. This allows the user to prevent unbounded growth of the cache by removing unneeded entries. If the user prefers an automatically managed cache, this module provides !auto_cache
.
Last, c.enum ()
will enumerate all the currently memorized bindings as pairs. This allows inspection of what is currently cached.
Make a manual cache backed by a hashtable. The generating function is passed with ~gen
and the initial size of the hashtable is ~init_size
. The hashtable uses the polymorphic hash
and (=)
.
Make a manual cache for function ~gen
backed by a Set.t. This set uses the polymorphic (<)
for comparison, so 'a
should be properly comparable by it.
Automatically managed caches
This type of cache is more transparent than the !manual_cache
above. It does not provide inspection of the caching structure, but guarantees bounded memory usage through some policy of discarding some entries.
Each auto-cache can have a different policy to decide which entry to discard.