Module Bonsai_extra_id_gen.Id_gen

Id_gen builds a component which generates unique identifiers by starting at 0 and incrementing by one every time that the effect is called.

The functor is parameteraized on the size of integer (int vs int63 vs int64), and it's also a generative functor, so invoking the functor multiple times times will mint new types.

I explicitly disassociate the input T from the output T because otherwise the benefits of the generative functor would be gone.

The reset parameter (default: `Reset) can be used to configure the behavior of the component when inside of a with_model_resetter:

Parameters

Signature

include Core.Int_intf.S
include Base.Int.S
type t
include Sexplib0.Sexpable.S__stack with type t := t
include Sexplib0.Sexpable.Of_sexp with type t := t
include Sexplib0.Sexpable.Sexp_of__stack with type t := t
val t_sexp_grammar : t Sexplib0.Sexp_grammar.t @@ portable
include Base.Floatable.S_local_input with type t := t
val of_float : float @ local -> t
val to_float : t @ local -> float
include Base.Intable.S with type t := t
val of_int_exn : int -> t
val to_int_exn : t @ local -> int
include Base.Identifiable.S__local__portable with type t := t
include Ppx_hash_lib.Hashable.S_any with type t := t
include Sexplib0.Sexpable.S with type t := t
include Sexplib0.Sexpable.Of_sexp with type t := t
include Sexplib0.Sexpable.Sexp_of with type t := t
include Base.Stringable.S with type t := t
include Base.Comparable.S__local__portable with type t := t
include Base.Comparisons.S__local with type t := t
include Base.Comparisons.Infix with type t := t
include Base.Comparator.S__portable with type t := t
type comparator_witness
include Base.Pretty_printer.S with type t := t
include Base.Stringable.S_local_input with type t := t
include Base.Comparable.With_zero with type t := t
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 Base.Invariant.S with type t := t
val invariant : t -> unit
val of_string_opt : string @ local -> t option
val to_string_hum : ?delimiter:char -> t @ local -> string

delimiter is an underscore by default.

Infix operators and constants

val zero : t
val one : t
val minus_one : t
val (+) : t @ local -> (t @ local -> t) @ local
val (-) : t @ local -> (t @ local -> t) @ local
val (*) : t @ local -> (t @ local -> t) @ local
val (**) : t @ local -> (t @ local -> t) @ local

Integer exponentiation

Negation

val neg : t @ local -> t
val (~-) : t @ local -> t

There are two pairs of integer division and remainder functions, /% and %, and / and rem. They both satisfy the same equation relating the quotient and the remainder:

  x = (x /% y * y) + (x % y);
  x = (x / y * y) + rem x y

The functions return the same values if x and y are positive. They all raise if y = 0.

The functions differ if x < 0 or y < 0.

If y < 0, then % and /% raise, whereas / and rem do not.

x % y always returns a value between 0 and y - 1, even when x < 0. On the other hand, rem x y returns a negative value if and only if x < 0; that value satisfies abs (rem x y) <= abs y - 1.

val (/%) : t @ local -> (t @ local -> t) @ local
val (%) : t @ local -> (t @ local -> t) @ local
val (/) : t @ local -> (t @ local -> t) @ local
val rem : t @ local -> (t @ local -> t) @ local
val (//) : t @ local -> (t @ local -> float) @ local

Float division of integers.

val (land) : t @ local -> (t @ local -> t) @ local

Same as bit_and.

val (lor) : t @ local -> (t @ local -> t) @ local

Same as bit_or.

val (lxor) : t @ local -> (t @ local -> t) @ local

Same as bit_xor.

val lnot : t @ local -> t

Same as bit_not.

val (lsl) : t @ local -> (int -> t) @ local

Same as shift_left.

val (asr) : t @ local -> (int -> t) @ local

Same as shift_right.

Other common functions

round rounds an int to a multiple of a given to_multiple_of argument, according to a direction dir, with default dir being `Nearest. round will raise if to_multiple_of <= 0. If the result overflows (too far positive or too far negative), round returns an incorrect result.

| `Down    | rounds toward Int.neg_infinity                          |
| `Up      | rounds toward Int.infinity                              |
| `Nearest | rounds to the nearest multiple, or `Up in case of a tie |
| `Zero    | rounds toward zero                                      |

Here are some examples for round ~to_multiple_of:10 for each direction:

| `Down    | {10 .. 19} --> 10 | { 0 ... 9} --> 0 | {-10 ... -1} --> -10 |
| `Up      | { 1 .. 10} --> 10 | {-9 ... 0} --> 0 | {-19 .. -10} --> -10 |
| `Zero    | {10 .. 19} --> 10 | {-9 ... 9} --> 0 | {-19 .. -10} --> -10 |
| `Nearest | { 5 .. 14} --> 10 | {-5 ... 4} --> 0 | {-15 ... -6} --> -10 |

For convenience and performance, there are variants of round with dir hard-coded. If you are writing performance-critical code you should use these.

val round : ?dir:[ `Zero | `Nearest | `Up | `Down ] @ local -> (t @ local -> (to_multiple_of:t @ local -> t) @ local) @ local
val round_towards_zero : t @ local -> (to_multiple_of:t @ local -> t) @ local
val round_down : t @ local -> (to_multiple_of:t @ local -> t) @ local
val round_up : t @ local -> (to_multiple_of:t @ local -> t) @ local
val round_nearest : t @ local -> (to_multiple_of:t @ local -> t) @ local
val abs : t -> t

Returns the absolute value of the argument. May be negative if the input is min_value.

val abs_local : t @ local -> t @ local

Like abs, but for locally-allocated values. If the argument is already positive, then this is the identity (as is abs itself).

Successor and predecessor functions

val succ : t @ local -> t
val pred : t @ local -> t

Exponentiation

val pow : t @ local -> (t @ local -> t) @ local

pow base exponent returns base raised to the power of exponent. It is OK if base <= 0. pow raises if exponent < 0, or an integer overflow would occur.

Bit-wise logical operations

val bit_and : t @ local -> (t @ local -> t) @ local

These are identical to land, lor, etc. except they're not infix and have different names.

val bit_or : t @ local -> (t @ local -> t) @ local
val bit_xor : t @ local -> (t @ local -> t) @ local
val bit_not : t @ local -> t
val popcount : t @ local -> t

Returns the number of 1 bits in the binary representation of the input.

Bit-shifting operations

The results are unspecified for negative shifts and shifts >= num_bits.

val shift_left : t @ local -> (int -> t) @ local

Shifts left, filling in with zeroes.

val shift_right : t @ local -> (int -> t) @ local

Shifts right, preserving the sign of the input.

Increment and decrement functions for integer references

val decr : t ref @ local -> unit
val incr : t ref @ local -> unit
val of_int32_exn : int32 -> t
val to_int32_exn : t -> int32
val of_int64_exn : int64 -> t
val to_int64 : t -> int64
val of_nativeint_exn : nativeint -> t
val to_nativeint_exn : t -> nativeint
val of_local_int32_exn : int32 @ local -> t @ local
val to_local_int32_exn : t @ local -> int32 @ local
val of_local_int64_exn : int64 @ local -> t @ local
val to_local_int64 : t @ local -> int64 @ local
val of_local_nativeint_exn : nativeint @ local -> t @ local
val to_local_nativeint_exn : t @ local -> nativeint @ local
val of_float_unchecked : float @ local -> t

of_float_unchecked truncates the given floating point number to an integer, rounding towards zero. The result is unspecified if the argument is nan or falls outside the range of representable integers.

module Summable : sig ... end
val num_bits : t

The number of bits available in this integer type. Note that the integer representations are signed.

val max_value : t

The largest representable integer.

val min_value : t

The smallest representable integer.

val (lsr) : t @ local -> (int -> t) @ local

Same as shift_right_logical.

val shift_right_logical : t @ local -> (int -> t) @ local

Shifts right, filling in with zeroes, which will not preserve the sign of the input.

val ceil_pow2 : t @ local -> t

ceil_pow2 x returns the smallest power of 2 that is greater than or equal to x. The implementation may only be called for x > 0. Example: ceil_pow2 17 = 32

val floor_pow2 : t @ local -> t

floor_pow2 x returns the largest power of 2 that is less than or equal to x. The implementation may only be called for x > 0. Example: floor_pow2 17 = 16

val ceil_log2 : t @ local -> t

ceil_log2 x returns the ceiling of log-base-2 of x, and raises if x <= 0.

val floor_log2 : t @ local -> t

floor_log2 x returns the floor of log-base-2 of x, and raises if x <= 0.

val is_pow2 : t @ local -> bool

is_pow2 x returns true iff x is a power of 2. is_pow2 raises if x <= 0.

val clz : t @ local -> t

Returns the number of leading zeros in the binary representation of the input, as an integer between 0 and one less than num_bits.

The results are unspecified for t = 0.

val ctz : t @ local -> t

Returns the number of trailing zeros in the binary representation of the input, as an integer between 0 and one less than num_bits.

The results are unspecified for t = 0.

module O : sig ... end

A sub-module designed to be opened to make working with ints more convenient.

include Core.Int_intf.Extension with type t := t with type comparator_witness := comparator_witness
include Bin_prot.Binable.S__local with type t := t
include Bin_prot.Binable.S_only_functions__local with type t := t
include sig ... end
include Typerep_lib.Typerepable.S with type t := t
val typerep_of_t : t Typerep_lib.Std_internal.Typerep.t @@ portable
val typename_of_t : t Typerep_lib.Typename.t @@ portable
include Core.Int_intf.Binaryable with type t := t
module Binary : sig ... end
include Base.Int.Binaryable with type t := t and module Binary := Binary
include Core.Int_intf.Hexable with type t := t
module Hex : sig ... end
include Base.Int.Hexable with type t := t and module Hex := Hex
include Core.Identifiable.S__local__portable with type t := t with type comparator_witness := comparator_witness
include Bin_prot.Binable.S__local with type t := t
include Bin_prot.Binable.S_only_functions__local with type t := t
include sig ... end
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__ : t Bin_prot.Read.vtag_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 Ppx_hash_lib.Hashable.S_any with type t := t
include Sexplib0.Sexpable.S with type t := t
include Sexplib0.Sexpable.Of_sexp with type t := t
val t_of_sexp : Sexplib0.Sexp.t -> t
include Sexplib0.Sexpable.Sexp_of with type t := t
include Ppx_compare_lib.Comparable.S with type t := t
include Ppx_compare_lib.Comparable.S__local with type t := t
include Ppx_hash_lib.Hashable.S_any with type t := t
val sexp_of_t : t -> Sexplib0.Sexp.t
include Base.Stringable.S with type t := t
include Base.Pretty_printer.S with type t := t
val pp : Base.Formatter.t -> t -> unit
include Base.Comparable.S__local__portable with type t := t with type comparator_witness := comparator_witness
include Base.Comparisons.S__local with type t := t
include Base.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 @@ portable

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 @@ portable
val between : t -> low:t -> high:t -> bool @@ portable

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

val clamp_exn : t -> min:t -> max:t -> t @@ portable

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 @@ portable
include Base.Comparator.S__portable with type t := t with type comparator_witness := comparator_witness
include Core.Comparator.S__portable with type t := t with type comparator_witness := comparator_witness
include Core.Hashable.S_binable with type t := t
include Ppx_hash_lib.Hashable.S_any with type t := t
val hash_fold_t : t Ppx_hash_lib.hash_fold
val hashable : t Base.Hashable.t
module Table : Core.Hashtbl.S_binable with type key = t
module Hash_set : Core.Hash_set.S_binable with type elt = t
module Hash_queue : Core.Hash_queue.S with type key = t
include Base.Stringable.S_local_input with type t := t
val of_string : string @ local -> t
val to_string : t @ local -> string
include Core.Comparable.Validate_with_zero with type t := t
val validate_lbound : min:t Core.Maybe_bound.t -> t Validate.check
val validate_ubound : max:t Core.Maybe_bound.t -> t Validate.check
val validate_bound : min:t Core.Maybe_bound.t -> max:t Core.Maybe_bound.t -> t Validate.check
val validate_positive : t Validate.check
val validate_non_negative : t Validate.check
val validate_negative : t Validate.check
val validate_non_positive : t Validate.check
include Core.Quickcheckable.S_int__portable with type t := t
include Core.Quickcheck_intf.Definitions.S_range__portable with type t := t
include Core.Quickcheck_intf.Definitions.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
val gen_incl : t -> t -> t Base_quickcheck.Generator.t @ portable @@ portable
val gen_uniform_incl : t -> t -> t Base_quickcheck.Generator.t @ portable @@ portable
val gen_log_uniform_incl : t -> t -> t Base_quickcheck.Generator.t @ portable @@ portable
val gen_log_incl : t -> t -> t Base_quickcheck.Generator.t @ portable @@ portable
val component : ?reset:[ `Reset | `Do_nothing ] -> Bonsai.graph @ local -> t Bonsai.Effect.t Bonsai.t
val component' : ?reset:[ `Reset | `Do_nothing | `Bump ] -> Bonsai.graph @ local -> t Bonsai.Effect.t Bonsai.t * t Bonsai.t

component' also gives you access to the most recently generated id