mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2026-03-09 07:03:35 -04:00
169 lines
3.9 KiB
OCaml
169 lines
3.9 KiB
OCaml
(* This file is free software, part of containers. See file "license" for more details. *)
|
|
|
|
(** Basic Int functions *)
|
|
|
|
include module type of Int
|
|
(** @inline *)
|
|
|
|
val hash : t -> int
|
|
(** [hash x] computes the hash of [x]. *)
|
|
|
|
val sign : t -> int
|
|
(** [sign x] return [0] if [x = 0], [-1] if [x < 0] and [1] if [x > 0].
|
|
Same as [compare x 0].*)
|
|
|
|
val pow : t -> t -> t
|
|
(** [pow base exponent] returns [base] raised to the power of [exponent].
|
|
[pow x y = x^y] for positive integers [x] and [y].
|
|
Raises [Invalid_argument] if [x = y = 0] or [y] < 0.
|
|
@since 0.11 *)
|
|
|
|
val floor_div : t -> t -> t
|
|
(** [floor_div x n] is integer division rounding towards negative infinity.
|
|
It satisfies [x = m * floor_div x n + rem x n].
|
|
@since 1.2 *)
|
|
|
|
val rem : t -> t -> t
|
|
(** [rem x n] is the remainder of dividing [x] by [n], with the same
|
|
sign as [n].
|
|
@since 1.2 *)
|
|
|
|
type 'a printer = Format.formatter -> 'a -> unit
|
|
type 'a random_gen = Random.State.t -> 'a
|
|
type 'a iter = ('a -> unit) -> unit
|
|
|
|
val random : int -> t random_gen
|
|
val random_small : t random_gen
|
|
val random_range : int -> int -> t random_gen
|
|
|
|
val pp : t printer
|
|
(** [pp ppf x] prints the integer [x] on [ppf]. *)
|
|
|
|
val of_string : string -> t option
|
|
(** [of_string s] converts the given string [s] into an integer.
|
|
Safe version of {!of_string_exn}.
|
|
@since 0.13 *)
|
|
|
|
val of_string_exn : string -> t
|
|
(** [of_string_exn s] converts the given string [s] to an integer.
|
|
Alias to {!int_of_string}.
|
|
@raise Failure in case of failure.
|
|
@since 3.0 *)
|
|
|
|
val pp_binary : t printer
|
|
(** [pp_binary ppf x] prints [x] on [ppf].
|
|
Print as "0b00101010".
|
|
@since 0.20 *)
|
|
|
|
val to_string_binary : t -> string
|
|
(** [to_string_binary x] returns the string representation of the integer [x], in binary.
|
|
@since 0.20 *)
|
|
|
|
[@@@iflt 4.13]
|
|
|
|
val min : t -> t -> t
|
|
(** [min x y] returns the minimum of the two integers [x] and [y].
|
|
@since 0.17 *)
|
|
|
|
val max : t -> t -> t
|
|
(** [max x y] returns the maximum of the two integers [x] and [y].
|
|
@since 0.17 *)
|
|
|
|
[@@@endif]
|
|
|
|
val range_by : step:t -> t -> t -> t iter
|
|
(** [range_by ~step i j] iterates on integers from [i] to [j] included,
|
|
where the difference between successive elements is [step].
|
|
Use a negative [step] for a decreasing list.
|
|
@raise Invalid_argument if [step=0].
|
|
@since 1.2 *)
|
|
|
|
val range : t -> t -> t iter
|
|
(** [range i j] iterates on integers from [i] to [j] included . It works
|
|
both for decreasing and increasing ranges.
|
|
@since 1.2 *)
|
|
|
|
val range' : t -> t -> t iter
|
|
(** [range' i j] is like {!range} but the second bound [j] is excluded.
|
|
For instance [range' 0 5 = Iter.of_list [0;1;2;3;4]].
|
|
@since 1.2 *)
|
|
|
|
val popcount : t -> int
|
|
(** Number of bits set to 1
|
|
@since 3.0 *)
|
|
|
|
(** {2 Infix Operators}
|
|
|
|
@since 0.17 *)
|
|
|
|
module Infix : sig
|
|
val ( = ) : t -> t -> bool
|
|
(** @since 0.17 *)
|
|
|
|
val ( <> ) : t -> t -> bool
|
|
(** @since 0.17 *)
|
|
|
|
val ( < ) : t -> t -> bool
|
|
(** @since 0.17 *)
|
|
|
|
val ( > ) : t -> t -> bool
|
|
(** @since 0.17 *)
|
|
|
|
val ( <= ) : t -> t -> bool
|
|
(** @since 0.17 *)
|
|
|
|
val ( >= ) : t -> t -> bool
|
|
(** @since 0.17 *)
|
|
|
|
val ( -- ) : t -> t -> t iter
|
|
(** Alias to {!range}.
|
|
@since 1.2 *)
|
|
|
|
val ( --^ ) : t -> t -> t iter
|
|
(** Alias to {!range'}.
|
|
@since 1.2 *)
|
|
|
|
val ( + ) : t -> t -> t
|
|
(** @since 2.1 *)
|
|
|
|
val ( - ) : t -> t -> t
|
|
(** @since 2.1 *)
|
|
|
|
val ( ~- ) : t -> t
|
|
(** @since 2.1 *)
|
|
|
|
val ( * ) : t -> t -> t
|
|
(** @since 2.1 *)
|
|
|
|
val ( / ) : t -> t -> t
|
|
(** @since 2.1 *)
|
|
|
|
val ( ** ) : t -> t -> t
|
|
(** @since 2.4 *)
|
|
|
|
val ( mod ) : t -> t -> t
|
|
(** @since 2.1 *)
|
|
|
|
val ( land ) : t -> t -> t
|
|
(** @since 2.1 *)
|
|
|
|
val ( lor ) : t -> t -> t
|
|
(** @since 2.1 *)
|
|
|
|
val ( lxor ) : t -> t -> t
|
|
(** @since 2.1 *)
|
|
|
|
val lnot : t -> t
|
|
(** @since 2.1 *)
|
|
|
|
val ( lsl ) : t -> int -> t
|
|
(** @since 2.1 *)
|
|
|
|
val ( lsr ) : t -> int -> t
|
|
(** @since 2.1 *)
|
|
|
|
val ( asr ) : t -> int -> t
|
|
(** @since 2.1 *)
|
|
end
|
|
|
|
include module type of Infix
|