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.7.tbz

sha256=c2ab40ae80bce5e48f940925dc594f0886c1e54281ed32f28902bea3a3fe5de9

md5=fea64f9534b5a99df7d53665692af0be

doc/grenier.orderme/Order_managed/index.html

Module `Order_managed`

Basic ordering operations

type t

An element of an ordering.

val root : unit -> t

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

val 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.

val 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.

val same_order : t -> t -> bool

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

val compare : t -> t -> int

Compare two elements. O(1)

val cardinal : t -> int

How many elements are ordered. O(1)

Memory management

val 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.

val 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

val unsafe_check : t -> string -> unit

On This Page

Basic ordering operations
1. Memory management