mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 11:15:31 -05:00
chore(ccint64): clean CCInt64.mli
Remove duplicate functions from Infix and Int64
This commit is contained in:
Fardale
parent
efc162125a
commit
1fec2f0f96
1 changed files with 54 additions and 92 deletions
|
|
@ -17,34 +17,6 @@
|
|||
|
||||
include module type of struct include Int64 end
|
||||
|
||||
val ( + ) : t -> t -> t
|
||||
(** [x + y] is the sum of [x] and [y].
|
||||
Addition. *)
|
||||
|
||||
val ( - ) : t -> t -> t
|
||||
(** [x - y] is the difference of [x] and [y].
|
||||
Subtraction. *)
|
||||
|
||||
val ( ~- ) : t -> t
|
||||
(** [~- x] is the negation of [x].
|
||||
Unary negation. *)
|
||||
|
||||
val ( * ) : t -> t -> t
|
||||
(** [ x * y] is the product of [x] and [y].
|
||||
Multiplication. *)
|
||||
|
||||
val ( / ) : t -> t -> t
|
||||
(** [x / y] is the integer quotient of [x] and [y].
|
||||
Integer division. Raise [Division_by_zero] if the second
|
||||
argument [y] is zero. This division rounds the real quotient of
|
||||
its arguments towards zero, as specified for {!Stdlib.(/)}. *)
|
||||
|
||||
val ( mod ) : t -> t -> t
|
||||
(** [x mod y] is the integer remainder of [x / y].
|
||||
If [y <> zero], the result of [x mod y] satisfies the following property:
|
||||
[x = ((x / y) * y) + (x mod y)].
|
||||
If [y = 0], [x mod y] raises [Division_by_zero]. *)
|
||||
|
||||
val min : t -> t -> t
|
||||
(** [min x y] returns the minimum of the two integers [x] and [y].
|
||||
@since NEXT_RELEASE *)
|
||||
|
|
@ -53,34 +25,6 @@ val max : t -> t -> t
|
|||
(** [max x y] returns the maximum of the two integers [x] and [y].
|
||||
@since NEXT_RELEASE *)
|
||||
|
||||
val ( land ) : t -> t -> t
|
||||
(** [x land y] is the bitwise logical and of [x] and [y]. *)
|
||||
|
||||
val ( lor ) : t -> t -> t
|
||||
(** [x lor y] is the bitwise logical or of [x] and [y]. *)
|
||||
|
||||
val ( lxor ) : t -> t -> t
|
||||
(** [x lxor y] is the bitwise logical exclusive or of [x] and [y]. *)
|
||||
|
||||
val lnot : t -> t
|
||||
(** [lnot x] is the bitwise logical negation of [x] (the bits of [x] are inverted). *)
|
||||
|
||||
val ( lsl ) : t -> int -> t
|
||||
(** [ x lsl y] shifts [x] to the left by [y] bits, filling in with zeroes.
|
||||
The result is unspecified if [y < 0] or [y >= 64]. *)
|
||||
|
||||
val ( lsr ) : t -> int -> t
|
||||
(** [x lsr y] shifts [x] to the right by [y] bits.
|
||||
This is a logical shift: zeroes are inserted in the vacated bits
|
||||
regardless of the sign of [x].
|
||||
The result is unspecified if [y < 0] or [y >= 64]. *)
|
||||
|
||||
val ( asr ) : t -> int -> t
|
||||
(** [x asr y] shifts [x] to the right by [y] bits.
|
||||
This is an arithmetic shift: the sign bit of [x] is replicated
|
||||
and inserted in the vacated bits.
|
||||
The result is unspecified if [y < 0] or [y >= 64]. *)
|
||||
|
||||
val hash : t -> int
|
||||
(** [hash x] computes the hash of [x].
|
||||
Like {!Stdlib.abs (to_int x)}. *)
|
||||
|
|
@ -130,31 +74,6 @@ val random_range : t -> t -> t random_gen
|
|||
|
||||
(** {2 Conversion} *)
|
||||
|
||||
val to_int : t -> int
|
||||
(** [to_int x] converts the given 64-bit integer [x] (type [int64]) into an
|
||||
integer (type [int]). On 64-bit platforms, the 64-bit integer
|
||||
is taken modulo 2{^31}, i.e. the high-order bit is lost
|
||||
during the conversion. On 64-bit platforms, the conversion is exact. *)
|
||||
|
||||
val of_int : int -> t
|
||||
(** [of_int x] converts the given integer [x] (type [int]) into an
|
||||
64-bit integer (type [int64]).
|
||||
Alias to {!Int64.of_int}. *)
|
||||
|
||||
val to_float : t -> float
|
||||
(** [to_float x] converts the given 64-bit integer [x]
|
||||
into a floating-point number (type [float]). *)
|
||||
|
||||
val of_float : float -> t
|
||||
(** [of_float x] converts the given floating-point number [x] into a 64-bit integer,
|
||||
discarding the fractional part (truncate towards 0).
|
||||
The result of the conversion is undefined if, after truncation, the number
|
||||
is outside the range \[{!CCInt64.min_int}, {!CCInt64.max_int}\].
|
||||
Alias to {!Int64.of_float}. *)
|
||||
|
||||
val to_string : t -> string
|
||||
(** [to_string x] returns the string representation of its argument [x], in signed decimal. *)
|
||||
|
||||
val of_string : string -> t option
|
||||
(** [of_string s] is the safe version of {!of_string_exn}.
|
||||
Like {!of_string_exn}, but return [None] instead of raising. *)
|
||||
|
|
@ -203,11 +122,34 @@ val pp_binary : t printer
|
|||
@since 2.1 *)
|
||||
|
||||
module Infix : sig
|
||||
val (+) : t -> t -> t
|
||||
val (-) : t -> t -> t
|
||||
val (~-) : t -> t
|
||||
val ( + ) : t -> t -> t
|
||||
(** [x + y] is the sum of [x] and [y].
|
||||
Addition. *)
|
||||
|
||||
val ( - ) : t -> t -> t
|
||||
(** [x - y] is the difference of [x] and [y].
|
||||
Subtraction. *)
|
||||
|
||||
val ( ~- ) : t -> t
|
||||
(** [~- x] is the negation of [x].
|
||||
Unary negation. *)
|
||||
|
||||
val ( * ) : t -> t -> t
|
||||
val (/) : t -> t -> t
|
||||
(** [ x * y] is the product of [x] and [y].
|
||||
Multiplication. *)
|
||||
|
||||
val ( / ) : t -> t -> t
|
||||
(** [x / y] is the integer quotient of [x] and [y].
|
||||
Integer division. Raise [Division_by_zero] if the second
|
||||
argument [y] is zero. This division rounds the real quotient of
|
||||
its arguments towards zero, as specified for {!Stdlib.(/)}. *)
|
||||
|
||||
val ( mod ) : t -> t -> t
|
||||
(** [x mod y] is the integer remainder of [x / y].
|
||||
If [y <> zero], the result of [x mod y] satisfies the following property:
|
||||
[x = ((x / y) * y) + (x mod y)].
|
||||
If [y = 0], [x mod y] raises [Division_by_zero]. *)
|
||||
|
||||
val ( ** ) : t -> t -> t
|
||||
(** Alias to {!pow}
|
||||
@since NEXT_RELEASE *)
|
||||
|
|
@ -220,14 +162,34 @@ module Infix : sig
|
|||
(** Alias to {!range'}.
|
||||
@since NEXT_RELEASE *)
|
||||
|
||||
val (mod) : t -> t -> t
|
||||
val (land) : t -> t -> t
|
||||
val (lor) : t -> t -> t
|
||||
val (lxor) : t -> t -> t
|
||||
val ( land ) : t -> t -> t
|
||||
(** [x land y] is the bitwise logical and of [x] and [y]. *)
|
||||
|
||||
val ( lor ) : t -> t -> t
|
||||
(** [x lor y] is the bitwise logical or of [x] and [y]. *)
|
||||
|
||||
val ( lxor ) : t -> t -> t
|
||||
(** [x lxor y] is the bitwise logical exclusive or of [x] and [y]. *)
|
||||
|
||||
val lnot : t -> t
|
||||
val (lsl) : t -> int -> t
|
||||
val (lsr) : t -> int -> t
|
||||
val (asr) : t -> int -> t
|
||||
(** [lnot x] is the bitwise logical negation of [x] (the bits of [x] are inverted). *)
|
||||
|
||||
val ( lsl ) : t -> int -> t
|
||||
(** [ x lsl y] shifts [x] to the left by [y] bits, filling in with zeroes.
|
||||
The result is unspecified if [y < 0] or [y >= 64]. *)
|
||||
|
||||
val ( lsr ) : t -> int -> t
|
||||
(** [x lsr y] shifts [x] to the right by [y] bits.
|
||||
This is a logical shift: zeroes are inserted in the vacated bits
|
||||
regardless of the sign of [x].
|
||||
The result is unspecified if [y < 0] or [y >= 64]. *)
|
||||
|
||||
val ( asr ) : t -> int -> t
|
||||
(** [x asr y] shifts [x] to the right by [y] bits.
|
||||
This is an arithmetic shift: the sign bit of [x] is replicated
|
||||
and inserted in the vacated bits.
|
||||
The result is unspecified if [y < 0] or [y >= 64]. *)
|
||||
|
||||
val (=) : t -> t -> bool
|
||||
val (<>) : t -> t -> bool
|
||||
val (>) : t -> t -> bool
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue