Module `PatriciaTree.SetNode`Source

An optimized representation for sets, i.e. maps to unit: we do not store a reference to unit (note that you can further optimize when you know the representation of the key). This is the node used in MakeHeterogeneousSet and MakeSet.

We use a uniform type 'map view to pattern match on maps and sets The actual types 'map t can be a bit different from 'map view to allow for more efficient representations, but view should be a constant time operation for quick conversions.

Parameters

module Key : sig ... end

Signature

Types

Sourcetype 'a key = 'a Key.t

The type of keys.

Sourcetype ('key, 'map) value = unit

The type of value, which depends on the type of the key and the type of the map.

Sourcetype 'map t

The type of the map, which is parameterized by a type.

Constructors: build values

Sourceval empty : 'map t

The empty map

Sourceval leaf : 'key key -> ('key, 'map) value -> 'map t

A singleton leaf, similar to BASE_MAP.singleton

Source

val branch : 
  prefix:int ->
  branching_bit:int ->
  tree0:'map t ->
  tree1:'map t ->
  'map t

A branch node. This shouldn't be called externally unless you know what you're doing! Doing so could easily break the data structure's invariants.

When called, it assumes that:

Neither tree0 nor tree1 should be empty.
branching_bit should have a single bit set
prefix should be normalized (bits below branching_bit set to zero)
All elements of tree0 should have their to_int start by prefix followed by 0 at position branching_bit).
All elements of tree1 should have their to_int start by prefix followed by 0 at position branching_bit).

Destructors: access the value

Sourcetype 'map view = private

| Empty : 'map view
(*
Can happen only at the toplevel: there is no empty interior node.
*)
| Branch : {
1. prefix : int;
2. branching_bit : int;
3. tree0 : 'map t;
4. tree1 : 'map t;
} -> 'map view
(*
Same constraints as branch:
- branching_bit contains only one bit set; the corresponding mask is (branching_bit - 1).
- prefix is normalized: the bits below the branching_bit are set to zero (i.e. prefix & (branching_bit - 1) = 0).
- All elements of tree0 should have their to_int start by prefix followed by 0 at position branching_bit).
- All elements of tree1 should have their to_int start by prefix followed by 0 at position branching_bit).
*)
| Leaf : {
1. key : 'key key;
2. value : ('key, 'map) value;
} -> 'map view
(*
A key -> value mapping.
*)

This makes the map nodes accessible to the pattern matching algorithm; this corresponds 1:1 to the SimpleNode implementation. This just needs to be copy-and-pasted for every node type.

Sourceval is_empty : 'map t -> bool

Check if the map is empty. Should be constant time.

Sourceval view : 'a t -> 'a view

Convert the map to a view. Should be constant time.

Install

Dune Dependency

Authors

Maintainers

Sources

doc/patricia-tree/PatriciaTree/SetNode/index.html

Module `PatriciaTree.SetNode`Source

Parameters

Signature

Types

Constructors: build values

Destructors: access the value

package patricia-tree

Install

Dune Dependency

Authors

Maintainers

Sources

doc/patricia-tree/PatriciaTree/SetNode/index.html

Module PatriciaTree.SetNodeSource

Parameters

Signature

Types

Constructors: build values

Destructors: access the value

Module `PatriciaTree.SetNode`Source