package core

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
include Interval.S with type bound = Core_kernel.Int.t
type t
include sig ... end
val __bin_read_t__ : (int -> t) Core_kernel.Bin_prot.Read.reader
val t_of_sexp : Sexplib.Sexp.t -> t
val sexp_of_t : t -> Sexplib.Sexp.t
type bound = Core_kernel.Int.t
type 'a t_ = t
type 'a bound_ = bound
val empty : 'a t_
val intersect : 'a t_ -> 'a t_ -> 'a t_
val is_empty_or_singleton : 'a t_ -> bool
val bounds : 'a t_ -> ('a bound_ * 'a bound_) option
val lbound : 'a t_ -> 'a bound_ option
val ubound : 'a t_ -> 'a bound_ option
val bounds_exn : 'a t_ -> 'a bound_ * 'a bound_
val lbound_exn : 'a t_ -> 'a bound_
val ubound_exn : 'a t_ -> 'a bound_
val convex_hull : 'a t_ list -> 'a t_

convex_hull ts returns an interval whose upper bound is the greatest upper bound of the intervals in the list, and whose lower bound is the least lower bound of the list.

Suppose you had three intervals a, b, and c:

             a:  (   )
             b:    (     )
             c:            ( )

          hull:  (           )

In this case the hull goes from lbound_exn a to ubound_exn c.

val contains : 'a t_ -> 'a bound_ -> bool
val compare_value : 'a t_ -> 'a bound_ -> [ `Below | `Within | `Above | `Interval_is_empty ]
val bound : 'a t_ -> 'a bound_ -> 'a bound_ option

bound t x returns None iff is_empty t. If bounds t = Some (a, b), then bound returns Some y where y is the element of t closest to x. I.e.:

        y = a  if x < a
        y = x  if a <= x <= b
        y = b  if x > b
val is_superset : 'a t_ -> of_:'a t_ -> bool

is_superset i1 of_:i2 is whether i1 contains i2. The empty interval is contained in every interval.

val is_subset : 'a t_ -> of_:'a t_ -> bool
val map : 'a t_ -> f:('a bound_ -> 'b bound_) -> 'b t_

map t ~f returns create (f l) (f u) if bounds t = Some (l, u), and empty if t is empty. Note that if f l > f u, the result of map is empty, by the definition of create.

If you think of an interval as a set of points, rather than a pair of its bounds, then map is not the same as the usual mathematical notion of mapping f over that set. For example, map ~f:(fun x -> x * x) maps the interval [-1,1] to [1,1], not to [0,1].

val are_disjoint : 'a t_ list -> bool

are_disjoint ts returns true iff the intervals in ts are pairwise disjoint.

val are_disjoint_as_open_intervals : 'a t_ list -> bool

Returns true iff a given set of intervals would be disjoint if considered as open intervals, e.g., (3,4) and (4,5) would count as disjoint according to this function.

val list_intersect : 'a t_ list -> 'a t_ list -> 'a t_ list

Assuming that ilist1 and ilist2 are lists of disjoint intervals, list_intersect ilist1 ilist2 considers the intersection (intersect i1 i2) of every pair of intervals (i1, i2), with i1 drawn from ilist1 and i2 from ilist2, returning just the non-empty intersections. By construction these intervals will be disjoint, too. For example:

let i = Interval.create;;
list_intersect [i 4 7; i 9 15] [i 2 4; i 5 10; i 14 20];;
[(4, 4), (5, 7), (9, 10), (14, 15)]

Raises an exception if either input list is non-disjoint.

val half_open_intervals_are_a_partition : 'a t_ list -> bool

Returns true if the intervals, when considered as half-open intervals, nestle up cleanly one to the next. I.e., if you sort the intervals by the lower bound, then the upper bound of the nth interval is equal to the lower bound of the n+1th interval. The intervals do not need to partition the entire space, they just need to partition their union.

val create : bound -> bound -> t

create has the same type as in Gen, but adding it here prevents a type-checker issue with nongeneralizable type variables.

val to_poly : t -> bound Interval.t
module Set : sig ... end
include Core_kernel.Container.S0 with type t := t with type elt := bound
val mem : t -> bound -> bool

Checks whether the provided element is there, using equality on elts.

val length : t -> int
val is_empty : t -> bool
val iter : t -> f:(bound -> unit) -> unit

iter must allow exceptions raised in f to escape, terminating the iteration cleanly. The same holds for all functions below taking an f.

val fold : t -> init:'accum -> f:('accum -> bound -> 'accum) -> 'accum

fold t ~init ~f returns f (... f (f (f init e1) e2) e3 ...) en, where e1..en are the elements of t.

val fold_result : t -> init:'accum -> f:('accum -> bound -> ('accum, 'e) Base.Result.t) -> ('accum, 'e) Base.Result.t

fold_result t ~init ~f is a short-circuiting version of fold that runs in the Result monad. If f returns an Error _, that value is returned without any additional invocations of f.

val fold_until : t -> init:'accum -> f: ('accum -> bound -> ('accum, 'stop) Base.Container_intf.Export.Continue_or_stop.t) -> ('accum, 'stop) Base.Container_intf.Export.Finished_or_stopped_early.t

fold_until t ~init ~f is a short-circuiting version of fold. If f returns Stop _ the computation ceases and results in that value. If f returns Continue _, the fold will proceed.

val exists : t -> f:(bound -> bool) -> bool

Returns true if and only if there exists an element for which the provided function evaluates to true. This is a short-circuiting operation.

val for_all : t -> f:(bound -> bool) -> bool

Returns true if and only if the provided function evaluates to true for all elements. This is a short-circuiting operation.

val count : t -> f:(bound -> bool) -> int

Returns the number of elements for which the provided function evaluates to true.

val sum : (module Base.Commutative_group.S with type t = 'sum) -> t -> f:(bound -> 'sum) -> 'sum

Returns the sum of f i for all i in the container.

val find : t -> f:(bound -> bool) -> bound option

Returns as an option the first element for which f evaluates to true.

val find_map : t -> f:(bound -> 'a option) -> 'a option

Returns the first evaluation of f that returns Some, and returns None if there is no such element.

val to_list : t -> bound list
val to_array : t -> bound array
val min_elt : t -> cmp:(bound -> bound -> int) -> bound option

Returns a min (resp. max) element from the collection using the provided cmp function. In case of a tie, the first element encountered while traversing the collection is returned. The implementation uses fold so it has the same complexity as fold. Returns None iff the collection is empty.

val max_elt : t -> cmp:(bound -> bound -> int) -> bound option
include Core_kernel.Binary_searchable.S with type t := t with type elt := bound

See Binary_search.binary_search in binary_search.ml

See Binary_search.binary_search_segmented in binary_search.ml

OCaml

Innovation. Community. Security.