package core_kernel

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

A scale factor, not bounded between 0% and 100%, represented as a float.

type t
include sig ... end
val hash_fold_t : Ppx_hash_lib.Std.Hash.state -> t -> Ppx_hash_lib.Std.Hash.state
val hash : t -> Ppx_hash_lib.Std.Hash.hash_value

of_string and t_of_sexp disallow nan, inf, etc.

val of_string : string -> t
val to_string : t -> string

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

include Interfaces.Sexpable with type t := t
include Interfaces.Binable 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
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 Interfaces.Comparable with type t := t
include Base.Comparable.S 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
val min : t -> t -> t
val max : t -> t -> t
val ascending : t -> t -> int
val descending : t -> t -> int
val between : t -> low:t -> high:t -> bool
val clamp_exn : t -> min:t -> max:t -> t
val clamp : t -> min:t -> max:t -> t Base__.Or_error.t
type comparator_witness
val comparator : (t, comparator_witness) Base__.Comparator.comparator
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 = Percent.Replace_polymorphic_compare
module Map : sig ... end
module Set : sig ... end
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
include Robustly_comparable.S 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 robustly_compare : t -> t -> int
val t_of_sexp : Base__.Ppx_sexp_conv_lib.Sexp.t -> t
val sexp_of_t : t -> Base__.Ppx_sexp_conv_lib.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 -> Base.Bool.t
val is_nan : t -> Base.Bool.t
val is_inf : t -> Base.Bool.t
val apply : t -> Base.Float.t -> Base.Float.t

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

val scale : t -> Base.Float.t -> t

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

val of_mult : Base.Float.t -> t

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

val to_mult : t -> Base.Float.t
val of_percentage : Base.Float.t -> t

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

val to_percentage : t -> Base.Float.t
val of_bp : Base.Float.t -> t

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

val to_bp : t -> Base.Float.t
val of_bp_int : Base.Int.t -> t
val to_bp_int : t -> Base.Int.t

rounds down

val t_of_sexp_allow_nan_and_inf : Sexp.t -> t
val of_string_allow_nan_and_inf : Base.String.t -> t
module Format : sig ... end

A Format.t tells Percent.format how to render a floating-point value as a string, like a printf conversion specification.

val format : t -> Format.t -> Base.String.t
val validate : t -> Core_kernel__.Import.Validate.t
val sign : t -> Sign.t
  • deprecated [since 2016-01] Replace [sign] with [sign_exn]
val sign_exn : t -> Sign.t

The sign of a Percent.t. Both -0. and 0. map to Zero. Raises on nan. All other values map to Neg or Pos.

module Stable : sig ... end
OCaml

Innovation. Community. Security.