package oma

You can search for identifiers within the package.

in-package search v0.2.0

oma
- Oma
  - Unsafe

Legend:
Library
Module
Module type
Parameter
Class
Class type

The operations in the submodule Unsafe are deemed unsafe because they expose unstable information, that is, information that will become out of date when further operations are performed. This unstable information includes a point's current tag, predecessor, and successor, as well as a region's current sequence of points. Unsafe operations can be useful in some situations (e.g., when debugging).

val tag : point -> int

tag p is the current (internal) integer tag of the point p. This tag lies in the semi-open interval [0, capacity).

val prev : point -> point option

prev p returns the current predecessor of the point p in the total order, if there is one.

val next : point -> point option

next p returns the current successor of the point p in the total order, if there is one.

val first : region -> point option

first r returns the smallest point that currently inhabits the region r, if there is one.

val last : region -> point option

last r returns the greatest point that currently inhabits the region r, if there is one.

val cardinal : region -> int

cardinal r returns the number of points that currently exist in the region r. Invalidated points are not counted.

val iter : (point -> unit) -> region -> unit

iter f r applies the function f to every point that currently inhabits the region r, in increasing order. Invalidated points are not included.