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

base-v0.14.0.tar.gz
sha256=e89c4b898d9e93527f1c84f6784f9a92a1dfa86877f39ac4450a6cb69e866de6
md5=5a00382c724e97b6768aaa27481dd3cc

doc/base/Base/Sign/index.html

Module Base.Sign

A type for representing the sign of a numeric value.

type t =
  1. | Neg
  2. | Zero
  3. | Pos
val all : t list

This provides to_string/of_string, sexp conversion, Map, Hashtbl, etc.

include Identifiable.S with type t := t
val hash_fold_t : Hash.state -> t -> Hash.state
val hash : t -> Hash.hash_value
include Sexpable.S with type t := t
val t_of_sexp : Sexplib0.Sexp.t -> t
val sexp_of_t : t -> Sexplib0.Sexp.t
include Stringable.S with type t := t
val of_string : string -> t
val to_string : t -> string
include Comparable.S with type t := t
include Comparisons.S with type t := t
include Comparisons.Infix with type t := t
val (>=) : t -> t -> bool
val (<=) : t -> t -> bool
val (=) : t -> t -> bool
val (>) : t -> t -> bool
val (<) : t -> t -> bool
val (<>) : t -> t -> bool
val equal : t -> t -> bool
val 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.

val min : t -> t -> t
val max : t -> t -> t
val 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.

val descending : t -> t -> int
val between : t -> low:t -> high:t -> bool

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

val 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).

val clamp : t -> min:t -> max:t -> t Or_error.t
include Comparator.S with type t := t
type comparator_witness
val validate_lbound : min:t Maybe_bound.t -> t Validate.check
val validate_ubound : max:t Maybe_bound.t -> t Validate.check
val validate_bound : min:t Maybe_bound.t -> max:t Maybe_bound.t -> t Validate.check
include Pretty_printer.S with type t := t
val pp : Formatter.t -> t -> unit
val of_int : int -> t
val to_int : t -> int

Map Neg/Zero/Pos to -1/0/1 respectively.

val to_float : t -> float

Map Neg/Zero/Pos to -1./0./1. respectively. (There is no of_float here, but see Float.sign_exn.)

val flip : t -> t

Map Neg/Zero/Pos to Pos/Zero/Neg respectively.

val (*) : t -> t -> t

Neg * Neg = Pos, etc.