package core

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

S_time is a signature that's used below to define the interfaces for Time and Time_ns without duplication.

module Time : sig ... end
include Interval_intf.S with type bound = Time.t with type 'a poly_t := 'a t with type 'a poly_set := 'a Set.t
type t
include Core_kernel.Bin_prot.Binable.S with type t := t
include Bin_prot.Binable.S_only_functions with type t := t
val bin_size_t : t Bin_prot.Size.sizer
val bin_write_t : t Bin_prot.Write.writer
val bin_read_t : t Bin_prot.Read.reader
val __bin_read_t__ : (int -> t) Bin_prot.Read.reader

This function only needs implementation if t exposed to be a polymorphic variant. Despite what the type reads, this does *not* produce a function after reading; instead it takes the constructor tag (int) before reading and reads the rest of the variant t afterwards.

val bin_shape_t : Bin_prot.Shape.t
val bin_writer_t : t Bin_prot.Type_class.writer
val bin_reader_t : t Bin_prot.Type_class.reader
include Ppx_sexp_conv_lib.Sexpable.S with type t := t
val t_of_sexp : Sexplib0.Sexp.t -> t
val sexp_of_t : t -> Sexplib0.Sexp.t
val compare : t -> t -> int
val hash_fold_t : Base.Hash.state -> t -> Base.Hash.state
val hash : t -> Base.Hash.hash_value
type bound = Time.t
type 'a t_ = t
type 'a bound_ = bound
val empty : 'a t_
val intersect : 'a t_ -> 'a t_ -> 'a t_
val is_empty : 'a t_ -> bool
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 t
module Set : sig ... end
val create_ending_after : ?zone:Interval_intf.Zone.t -> (Time.Ofday.t * Time.Ofday.t) -> now:Time.t -> t

create_ending_after ?zone (od1, od2) ~now returns the smallest interval (t1 t2) with minimum t2 such that t2 >= now, to_ofday t1 = od1, and to_ofday t2 = od2. If a zone is specified, it is used to translate od1 and od2 into times, otherwise the machine's time zone is used.

It is not guaranteed that the interval will contain now: for instance if it's 11:15am, od1 is 12pm, and od2 is 2pm, the returned interval will be 12pm-2pm today, which obviously doesn't include 11:15am. In general contains (t1 t2) now will only be true when now is between to_ofday od1 and to_ofday od2.

You might want to use this function if, for example, there's a daily meeting from 10:30am-11:30am and you want to find the next instance of the meeting, relative to now.

val create_ending_before : ?zone:Interval_intf.Zone.t -> (Time.Ofday.t * Time.Ofday.t) -> ubound:Time.t -> t

create_ending_before ?zone (od1, od2) ~ubound returns the smallest interval (t1 t2) with maximum t2 such that t2 <= ubound, to_ofday t1 = od1, and to_ofday t2 = od2. If a zone is specified, it is used to translate od1 and od2 into times, otherwise the machine's time zone is used.

You might want to use this function if, for example, there's a lunch hour from noon to 1pm and you want to find the first instance of that lunch hour (an interval) before ubound. The result will either be on the same day as ubound, if to_ofday ubound is after 1pm, or the day before, if to_ofday ubound is any earlier.