Module `Grace.Line_index`Source

Sourcetype t = private int

The type of indexes. An integer with the invariant that an index t satisfies t >= 0.

include Ppx_compare_lib.Equal.S with type t := t

include Ppx_compare_lib.Comparable.S with type t := t

include Ppx_hash_lib.Hashable.S with type t := t

Sourceval hash_fold_t : Base.Hash.state -> t -> Base.Hash.state

Sourceval hash : t -> Base.Hash.hash_value

include Sexplib0.Sexpable.S with type t := t

Sourceval t_of_sexp : Sexplib0.Sexp.t -> t

Sourceval sexp_of_t : t -> Sexplib0.Sexp.t

include Core.Comparable.S with type t := t

include Base.Comparable.S with type t := t

include Base.Comparisons.S with type t := t

include Base.Comparisons.Infix with type t := t

Sourceval (>=) : t -> t -> bool

Sourceval (<=) : t -> t -> bool

Sourceval (=) : t -> t -> bool

Sourceval (>) : t -> t -> bool

Sourceval (<) : t -> t -> bool

Sourceval (<>) : t -> t -> bool

Sourceval equal : t -> t -> bool

Sourceval compare : t -> t -> int

compare t1 t2 returns 0 if t1 is equal to t2, a negative integer if t1 is less than t2, and a positive integer if t1 is greater than t2.

Sourceval min : t -> t -> t

Sourceval max : t -> t -> t

Sourceval ascending : t -> t -> int

ascending is identical to compare. descending x y = ascending y x. These are intended to be mnemonic when used like List.sort ~compare:ascending and List.sort ~cmp:descending, since they cause the list to be sorted in ascending or descending order, respectively.

Sourceval descending : t -> t -> int

Sourceval between : t -> low:t -> high:t -> bool

between t ~low ~high means low <= t <= high

Sourceval clamp_exn : t -> min:t -> max:t -> t

clamp_exn t ~min ~max returns t', the closest value to t such that between t' ~low:min ~high:max is true.

Raises if not (min <= max).

Sourceval clamp : t -> min:t -> max:t -> t Base.Or_error.t

include Base.Comparator.S with type t := t

Sourcetype comparator_witness

Sourceval comparator : (t, comparator_witness) Base.Comparator.comparator

Sourceval validate_lbound : min:t Core.Maybe_bound.t -> t Validate.check

Sourceval validate_ubound : max:t Core.Maybe_bound.t -> t Validate.check

Source

val validate_bound : 
  min:t Core.Maybe_bound.t ->
  max:t Core.Maybe_bound.t ->
  t Validate.check

Source

module Replace_polymorphic_compare : 
  Base.Comparable.Comparisons with type t := t

Source

module Map : 
  Core.Map.S
    with type Key.t = t
    with type Key.comparator_witness = comparator_witness

Source

module Set : 
  Core.Set.S
    with type Elt.t = t
    with type Elt.comparator_witness = comparator_witness

include Core.Invariant.S with type t := t

Sourceval invariant : t -> unit

include Core.Pretty_printer.S with type t := t

Sourceval pp : Base.Formatter.t -> t -> unit

Sourceval to_string : t -> string

Sourceval of_int : int -> t

of_int n creates the index n.

raises Invalid_argument
if n < 0.

Sourceval initial : t

initial is the initial index, namely 0.

Sourceval add : t -> int -> t

add t off adds the offset off to the index t.

Sourceval sub : t -> int -> t

sub t off subtracts the offset off from the index t.

Sourceval diff : t -> t -> int

diff t1 t2 returns the (potentially negative) difference between t1 and t2.

Install

Dune Dependency

Authors

Maintainers

Sources

doc/grace/Grace/Line_index/index.html

Module `Grace.Line_index`Source

package grace

Install

Dune Dependency

Authors

Maintainers

Sources

doc/grace/Grace/Line_index/index.html

Module Grace.Line_indexSource

Module `Grace.Line_index`Source