package core_kernel

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

Conversions between units of measure based on bytes.

module Measure : sig ... end
type t
include sig ... end
val bin_read_t : t Bin_prot.Read.reader
val __bin_read_t__ : (Base.Int.t -> t) Bin_prot.Read.reader
val bin_reader_t : t Bin_prot.Type_class.reader
val bin_size_t : t Bin_prot.Size.sizer
val bin_write_t : t Bin_prot.Write.writer
val bin_writer_t : t Bin_prot.Type_class.writer
val bin_shape_t : Bin_prot.Shape.t
val t_of_sexp : Sexplib.Sexp.t -> t
val sexp_of_t : t -> Sexplib.Sexp.t
val create : Measure.t -> Base.Float.t -> t

create measure value creates a t from value units of the given measure.

include Comparable.S with type t := t
include Base.Comparable_intf.S with type t := t
include Base.Comparable_intf.Polymorphic_compare with type t := t
include Base.Polymorphic_compare_intf.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 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 ~cmp: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
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 Base.Or_error.t
include Base.Comparator.S with type t := t
type comparator_witness
include Base.Comparable_intf.Validate with type t := t
val validate_lbound : min:t Base.Maybe_bound.t -> t Base.Validate.check
val validate_ubound : max:t Base.Maybe_bound.t -> t Base.Validate.check
val validate_bound : min:t Base.Maybe_bound.t -> max:t Base.Maybe_bound.t -> t Base.Validate.check
module Replace_polymorphic_compare : sig ... end
module Map : sig ... end
module Set : sig ... end
include Hashable.S with type t := t
include Hashable.Common with type t := t
val hash : t -> Base.Int.t
val compare : t -> t -> Base.Int.t
module Table : sig ... end
module Hash_set : sig ... end
module Hash_queue : sig ... end
include Base.Stringable.S with type t := t
val of_string : string -> t
val to_string : t -> string
val to_string_hum : ?measure:Measure.t -> t -> Base.String.t

to_string_hum ?measure t returns a string representation of t. If measure is not given then the largest measure (excluding `Words) is used that causes the translated value to exceed 1.

val bytes : t -> Base.Float.t
val kilobytes : t -> Base.Float.t
val megabytes : t -> Base.Float.t
val gigabytes : t -> Base.Float.t
val words : t -> Base.Float.t
val scale : t -> Base.Float.t -> t

scale t mul scale the measure t by mul

module Infix : sig ... end
module Stable : sig ... end