package base

  1. Overview
  2. Docs
Full standard library replacement for OCaml

Install 

dune-project
 Dependency

github.com Changelog MIT License Edit opam file Versions (19)

Authors

  1. J
    Jane Street Group, LLC

Maintainers

  1. J
    Jane Street developers

Sources

v0.15.1.tar.gz
sha256=755e303171ea267e3ba5af7aa8ea27537f3394d97c77d340b10f806d6ef61a14

doc/base/Base/Comparable/Make/index.html

Module Comparable.MakeSource

Parameters

module T : sig ... end

Signature

include Comparisons.S with type t := T.t
include Comparisons.Infix with type t := T.t
Sourceval (>=) : T.t -> T.t -> bool
Sourceval (<=) : T.t -> T.t -> bool
Sourceval (=) : T.t -> T.t -> bool
Sourceval (>) : T.t -> T.t -> bool
Sourceval (<) : T.t -> T.t -> bool
Sourceval (<>) : T.t -> T.t -> bool
Sourceval equal : T.t -> T.t -> bool
Sourceval compare : T.t -> 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.t -> T.t
Sourceval max : T.t -> T.t -> T.t
Sourceval ascending : T.t -> 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 -> T.t -> int
Sourceval between : T.t -> low:T.t -> high:T.t -> bool

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

Sourceval clamp_exn : T.t -> min:T.t -> max:T.t -> 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.t -> min:T.t -> max:T.t -> T.t Or_error.t
include Comparator.S with type t := T.t
Sourcetype comparator_witness