package batteries
Install
Dune Dependency
Authors
Maintainers
Sources
md5=ea26b5c72e6731e59d856626049cca4d
sha512=55975b62c26f6db77433a3ac31f97af609fc6789bb62ac38b267249c78fd44ff37fe81901f1cf560857b9493a6046dd37b0d1c0234c66bd59e52843aac3ce6cb
doc/batteries.unthreaded/BatNativeint/index.html
Module BatNativeintSource
Processor-native integers.
This module provides operations on the type nativeint of signed 32-bit integers (on 32-bit platforms) or signed 64-bit integers (on 64-bit platforms). This integer type has exactly the same width as that of a long integer type in the C compiler. All arithmetic operations over nativeint are taken modulo 232 or 264 depending on the word size of the architecture.
Performance notice: values of type nativeint occupy more memory space than values of type int, and arithmetic operations on nativeint are generally slower than those on int. Use nativeint only when the application requires the extra bit of precision over the int type.
Any integer literal followed by n is taken to be a nativeint. For instance, 1n is Native_int.one.
This module extends Stdlib's Nativeint module, go there for documentation on the rest of the functions and types.
An alias for the type of native integers.
The native integer 0.
The native integer 1.
The native integer -1.
Unary negation.
Addition.
Subtraction.
Multiplication.
Integer division.
This division rounds the real quotient of its arguments towards zero, as specified for Pervasives.(/).
Same as div, except that arguments and result are interpreted as unsigned native integers.
Integer remainder. If y is not zero, the result of Nativeint.rem x y satisfies the following properties: Nativeint.zero <= Nativeint.rem x y < Nativeint.abs y and x = Nativeint.add (Nativeint.mul (Nativeint.div x y) y) (Nativeint.rem x y). If y = 0, Nativeint.rem x y raises Division_by_zero.
Same as rem, except that arguments and result are interpreted as unsigned native integers.
Successor. Nativeint.succ x is Nativeint.add x Nativeint.one.
Predecessor. Nativeint.pred x is Nativeint.sub x Nativeint.one.
Return the absolute value of its argument.
The size in bits of a native integer. This is equal to 32 on a 32-bit platform and to 64 on a 64-bit platform.
The greatest representable native integer, either 231 - 1 on a 32-bit platform, or 263 - 1 on a 64-bit platform.
The greatest representable native integer, either -231 on a 32-bit platform, or -263 on a 64-bit platform.
Bitwise logical and.
Bitwise logical or.
Bitwise logical exclusive or.
Bitwise logical negation
Nativeint.shift_left x y shifts x to the left by y bits. The result is unspecified if y < 0 or y >= bitsize, where bitsize is 32 on a 32-bit platform and 64 on a 64-bit platform.
Nativeint.shift_right x 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 >= bitsize.
Nativeint.shift_right_logical x 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 >= bitsize.
Enumerate an interval.
5n -- 10n is the enumeration 5n,6n,7n,8n,9n,10n. 10n -- 5n is the empty enumeration
Enumerate an interval.
5n -- 10n is the enumeration 5n,6n,7n,8n,9n,10n. 10n -- 5n is the enumeration 10n,9n,8n,7n,6n,5n.
Convert the given integer (type int) to a native integer (type nativeint).
Convert the given native integer (type nativeint) to an integer (type int). The high-order bit is lost during the conversion.
Same as to_int, but interprets the argument as an unsigned integer. Returns None if the unsigned value of the argument cannot fit into an int.
Convert the given floating-point number to a native integer, discarding the fractional part (truncate towards 0). The result of the conversion is undefined if, after truncation, the number is outside the range [Nativeint.min_int, Nativeint.max_int].
Convert the given native integer to a floating-point number.
Convert the given 32-bit integer (type int32) to a native integer.
Convert the given native integer to a 32-bit integer (type int32). On 64-bit platforms, the 64-bit native integer is taken modulo 232, i.e. the top 32 bits are lost. On 32-bit platforms, the conversion is exact.
Convert the given 64-bit integer (type int64) to a native integer. On 32-bit platforms, the top 32 bits are lost.
Convert the given native integer to a 64-bit integer (type int64).
Convert the given string to a native integer. The string is read in decimal (by default) or in hexadecimal, octal or binary if the string begins with 0x, 0o or 0b respectively.
Same as of_string, but return None instead of raising.
Return the string representation of its argument, in decimal.
Same as compare, except that arguments are interpreted as unsigned native integers.