Module Core_kernel.Percent

An abstract type of scale factors

type t
include sig ... end

of_string and t_of_sexp disallow nan, inf, etc.

include Core_kernel__.Std_internal.Stringable with type t := t
type t
val of_string : string ‑> t
val to_string : t ‑> string

sexps are of the form 5bp or 0.05% or 0.0005x

include Core_kernel__.Std_internal.Sexpable with type t := t
type t
val t_of_sexp : Base__.Sexplib.Sexp.t ‑> t
val sexp_of_t : t ‑> Base__.Sexplib.Sexp.t
include Core_kernel__.Std_internal.Binable with type t := t
type t
include Core_kernel__.Binable0.S_only_functions with type t := t
type 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 Core_kernel__.Std_internal.Comparable with type t := t
include Core_kernel__.Comparable_intf.S_common
include Base.Comparable_intf.S
include Base.Comparable_intf.Polymorphic_compare
include Base.Polymorphic_compare_intf.Infix
type 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

-1 means "less than", 0 means "equal", 1 means "greater than", and other values should not be returned

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 t
type comparator_witness
include Base.Comparable_intf.Validate with type t := t
type 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
include Comparable.With_zero with type t := t
type t
val validate_positive : t Base.Validate.check
val validate_non_negative : t Base.Validate.check
val validate_negative : t Base.Validate.check
val validate_non_positive : t Base.Validate.check
val is_positive : t ‑> bool
val is_non_negative : t ‑> bool
val is_negative : t ‑> bool
val is_non_positive : t ‑> bool
val sign : t ‑> Base__.Sign0.t

Returns Neg, Zero, or Pos in a way consistent with the above functions.

include Robustly_comparable.S with type t := t
type 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 robustly_compare : t ‑> t ‑> int
Arithmetic
include Core_kernel__.Import.Commutative_group.S with type t := t
type t
include sig ... end
val t_of_sexp : Base__.Sexplib.Sexp.t ‑> t
val sexp_of_t : t ‑> Base__.Sexplib.Sexp.t
val zero : t
val (+) : t ‑> t ‑> t
val (-) : t ‑> t ‑> t
val (*) : t ‑> t ‑> t
val neg : t ‑> t
val abs : t ‑> t
val is_zero : t ‑> Core_kernel__.Import.bool
val is_nan : t ‑> Core_kernel__.Import.bool
val is_inf : t ‑> Core_kernel__.Import.bool
val apply : t ‑> Core_kernel__.Import.float ‑> Core_kernel__.Import.float

apply t x multiplies the percent t by x, returning a float

val scale : t ‑> Core_kernel__.Import.float ‑> t

scale t x scales the percent t by x, returning a new t

val of_mult : Core_kernel__.Import.float ‑> t

of_mult 5. is 5x = 500% = 50_000bp

val to_mult : t ‑> Core_kernel__.Import.float
val of_percentage : Core_kernel__.Import.float ‑> t

of_percentage 5. is 5% = 0.05x = 500bp

val to_percentage : t ‑> Core_kernel__.Import.float
val of_bp : Core_kernel__.Import.float ‑> t

of_bp 5. is 5bp = 0.05% = 0.0005x

val to_bp : t ‑> Core_kernel__.Import.float
val of_bp_int : Core_kernel__.Import.int ‑> t
val to_bp_int : t ‑> Core_kernel__.Import.int

rounds down

val t_of_sexp_allow_nan_and_inf : Core_kernel__.Std_internal.Sexp.t ‑> t
val of_string_allow_nan_and_inf : Core_kernel__.Import.string ‑> t
module Format : sig ... end

A Format.t tells Percent.format how to render a floating-point value as a string. Many of the Format.t values correspond to printf conversion specifications. For example:

val format : t ‑> Format.t ‑> Core_kernel__.Import.string
val validate : t ‑> Core_kernel__.Import.Validate.t
module Stable : sig ... end