Module Core_kernel.Percent
A scale factor, not bounded between 0% and 100%, represented as a float.
type t
= private Core_kernel__.Import.float
Exposing that this is a float allows for more optimization. E.g. compiler can optimize some local refs and not box them.
val hash_fold_t : Base.Hash.state -> t -> Base.Hash.state
val hash : t -> Base.Hash.hash_value
of_string
and t_of_sexp
disallow nan
, inf
, etc.
include Core_kernel__.Std_internal.Stringable with type t := t
Sexps are of the form 5bp or 0.05% or 0.0005x
include Core_kernel__.Std_internal.Sexpable with type t := t
val t_of_sexp : Sexplib0.Sexp.t -> t
val sexp_of_t : t -> Sexplib0.Sexp.t
include Core_kernel__.Std_internal.Binable with type t := t
include Core_kernel__.Binable0.S_only_functions with type t := 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 variantt
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
val bin_t : t Bin_prot.Type_class.t
include Core_kernel__.Std_internal.Comparable_binable with type t := t
include Core_kernel__.Comparable_intf.S_common
include Base.Comparable.S
include Base__.Comparable_intf.Polymorphic_compare
val ascending : t -> t -> int
ascending
is identical tocompare
.descending x y = ascending y x
. These are intended to be mnemonic when used likeList.sort ~compare:ascending
andList.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
meanslow <= t <= high
val clamp_exn : t -> min:t -> max:t -> t
clamp_exn t ~min ~max
returnst'
, the closest value tot
such thatbetween 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
val comparator : (t, comparator_witness) Base.Comparator.comparator
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 : Core_kernel__.Comparable_intf.Polymorphic_compare with type t := t
include Core_kernel__.Comparable_intf.Map_and_set_binable with type t := t with type comparator_witness := comparator_witness
include Comparator.S with type t := t
val comparator : (t, comparator_witness) Comparator.comparator
module Map : Map.S_binable with type Key.t = t with type Key.comparator_witness = comparator_witness
module Set : Set.S_binable with type Elt.t = t with type Elt.comparator_witness = comparator_witness
include Comparable.With_zero with type t := 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
, orPos
in a way consistent with the above functions.
include Quickcheckable.S with type t := t
val quickcheck_generator : t Base_quickcheck.Generator.t
val quickcheck_observer : t Base_quickcheck.Observer.t
val quickcheck_shrinker : t Base_quickcheck.Shrinker.t
module Option : Immediate_option.S_without_immediate with type t = private Core_kernel__.Import.float and type value := t
The value
nan
cannot be represented as anOption.t
val (*) : t -> t -> t
val (+) : t -> t -> t
val (-) : t -> t -> t
val zero : 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 percentt
byx
, returning a float.
val scale : t -> Core_kernel__.Import.float -> t
scale t x
scales the percentt
byx
, returning a newt
.
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 round_significant : t -> significant_digits:Core_kernel__.Import.int -> t
0.0123456% ~significant_digits:4 is 1.235bp
val round_decimal_mult : t -> decimal_digits:Core_kernel__.Import.int -> t
0.0123456% ~decimal_digits:4 is 0.0001 = 1bp
val round_decimal_percentage : t -> decimal_digits:Core_kernel__.Import.int -> t
0.0123456% ~decimal_digits:4 is 0.0123% = 1.23bp
val round_decimal_bp : t -> decimal_digits:Core_kernel__.Import.int -> t
0.0123456% ~decimal_digits:4 is 1.2346bp
val t_of_sexp_allow_nan_and_inf : Sexp.t -> t
val of_string_allow_nan_and_inf : Core_kernel__.Import.string -> t
module Format : sig ... end
A
Format.t
tellsPercent.format
how to render a floating-point value as a string, like aprintf
conversion specification.
val format : t -> Format.t -> Core_kernel__.Import.string
val validate : t -> Core_kernel__.Import.Validate.t
val sign : t -> Sign.t
val sign_exn : t -> Sign.t
The sign of a
Percent.t
. Both-0.
and0.
map toZero
. Raises on nan. All other values map toNeg
orPos
.
module Stable : sig ... end