package grenier

You can search for identifiers within the package.

in-package search v0.2.0

A collection of various algorithms in OCaml

Install

Dune Dependency

github.com Readme Changelog Edit opam file Versions (11)

Authors

F

Frederic Bour <frederic.bour@lakaban.net>

Maintainers

F

Frederic Bour <frederic.bour@lakaban.net>

Sources

grenier-0.15.tbz

sha256=dec7f84b9e93d5825f10c7dea84d5a74d7365ede45664ae63c26b5e8045c1c44

sha512=b8aa1569c2e24b89674d1b34de34cd1798896bb6a53aa5a1287f68cee880125e6b687f66ad73da9069a01cc3ece1f0684f48328b099d43529bff736b772c8fd8

doc/grenier.orderme/Order_interval/index.html

Module `Order_interval`Source

Basic ordering operations

Sourcetype t

An element of an ordering.

Sourceval root : unit -> t

Create a new ordering with a single element. O(1)

Sourceval after : t -> t

after t inserts a new element to the ordering, greater than t but less than all existing elements greater than t.

O(1) amortized.

Sourceval before : t -> t

before t inserts a new element to the ordering, less than t but greater than all existing elements less than t.

O(1) amortized.

Sourceval inside : t -> t

Sourceval outside : t -> t

Sourceval same_order : t -> t -> bool

Check if two elements belong to the same order. O(1)

Sourcetype rel =

| Before
| Inside
| Equal
| Outside
| After

Compare two elements. O(1)

Sourceval compare : t -> t -> rel

Sourceval cardinal : t -> int

How many elements are ordered. O(1)

Memory management

Sourceval forget : t -> unit

When you know you are not going to use an element any longer, forget it to release memory. It makes operations slightly faster to not have to wait for the GC to release elements.

Sourceval is_valid : t -> bool

After calling forget, an element should not be used. You can check if it is the case with is_valid.

Algorithm due to: Two Simplified Algorithms for Maintaining Order in a List Bender et al., 2002

Sourceval unsafe_check : t -> string -> unit

On This Page

Basic ordering operations
1. Memory management