module Pervasives:sig
..end
This module provides the basic operations over the built-in types (numbers, booleans, strings, exceptions, references, lists, arrays, input-output channels, ...).
This module is automatically opened at the beginning of each compilation.
All components of this module can therefore be referred by their short
name, without prefixing them by Pervasives
.
val raise : exn -> 'a
val invalid_arg : string -> 'a
Invalid_argument
with the given string.val failwith : string -> 'a
Failure
with the given string.exception Exit
Exit
exception is not raised by any library function. It is
provided for use in your programs.val (=) : 'a -> 'a -> bool
e1 = e2
tests for structural equality of e1
and e2
.
Mutable structures (e.g. references and arrays) are equal
if and only if their current contents are structurally equal,
even if the two mutable objects are not the same physical object.
Equality between functional values raises Invalid_argument
.
Equality between cyclic data structures may not terminate.val (<>) : 'a -> 'a -> bool
(=)
.val (<) : 'a -> 'a -> bool
(>=)
.val (>) : 'a -> 'a -> bool
(>=)
.val (<=) : 'a -> 'a -> bool
(>=)
.val (>=) : 'a -> 'a -> bool
( = )
. As in the case
of ( = )
, mutable structures are compared by contents.
Comparison between functional values raises Invalid_argument
.
Comparison between cyclic structures may not terminate.val compare : 'a -> 'a -> int
compare x y
returns 0
if x
is equal to y
,
a negative integer if x
is less than y
, and a positive integer
if x
is greater than y
. The ordering implemented by compare
is compatible with the comparison predicates =
, <
and >
defined above, with one difference on the treatment of the float value
nan
. Namely, the comparison predicates treat nan
as different from any other float value, including itself;
while compare
treats nan
as equal to itself and less than any
other float value. This treatment of nan
ensures that compare
defines a total ordering relation.
compare
applied to functional values may raise Invalid_argument
.
compare
applied to cyclic structures may not terminate.
The compare
function can be used as the comparison function
required by the Set.Make
and Map.Make
functors, as well as
the List.sort
and Array.sort
functions.
val min : 'a -> 'a -> 'a
nan
.val max : 'a -> 'a -> 'a
nan
.val (==) : 'a -> 'a -> bool
e1 == e2
tests for physical equality of e1
and e2
.
On mutable types such as references, arrays, strings, records with
mutable fields and objects with mutable instance variables,
e1 == e2
is true if and only if physical modification of e1
also affects e2
.
On non-mutable types, the behavior of ( == )
is
implementation-dependent; however, it is guaranteed that
e1 == e2
implies compare e1 e2 = 0
.val (!=) : 'a -> 'a -> bool
(==)
.val not : bool -> bool
val (&&) : bool -> bool -> bool
e1 && e2
, e1
is evaluated first, and if it returns false
,
e2
is not evaluated at all.val (&) : bool -> bool -> bool
val (||) : bool -> bool -> bool
e1 || e2
, e1
is evaluated first, and if it returns true
,
e2
is not evaluated at all.val (or) : bool -> bool -> bool
val (|>) : 'a -> ('a -> 'b) -> 'b
x |> f |> g
is exactly equivalent
to g (f (x))
.val (@@) : ('a -> 'b) -> 'a -> 'b
g @@ f @@ x
is exactly equivalent to
g (f (x))
.val (~-) : int -> int
- e
instead of ~- e
.val (~+) : int -> int
+ e
instead of ~+ e
.val succ : int -> int
succ x
is x + 1
.val pred : int -> int
pred x
is x - 1
.val (+) : int -> int -> int
val (-) : int -> int -> int
val ( * ) : int -> int -> int
val (/) : int -> int -> int
Division_by_zero
if the second argument is 0.
Integer division rounds the real quotient of its arguments towards zero.
More precisely, if x >= 0
and y > 0
, x / y
is the greatest integer
less than or equal to the real quotient of x
by y
. Moreover,
(- x) / y = x / (- y) = - (x / y)
.val (mod) : int -> int -> int
y
is not zero, the result
of x mod y
satisfies the following properties:
x = (x / y) * y + x mod y
and
abs(x mod y) <= abs(y) - 1
.
If y = 0
, x mod y
raises Division_by_zero
.
Note that x mod y
is negative only if x < 0
.
Raise Division_by_zero
if y
is zero.val abs : int -> int
min_int
.val max_int : int
val min_int : int
val (land) : int -> int -> int
val (lor) : int -> int -> int
val (lxor) : int -> int -> int
val lnot : int -> int
val (lsl) : int -> int -> int
n lsl m
shifts n
to the left by m
bits.
The result is unspecified if m < 0
or m >= bitsize
,
where bitsize
is 32
on a 32-bit platform and
64
on a 64-bit platform.val (lsr) : int -> int -> int
n lsr m
shifts n
to the right by m
bits.
This is a logical shift: zeroes are inserted regardless of
the sign of n
.
The result is unspecified if m < 0
or m >= bitsize
.val (asr) : int -> int -> int
n asr m
shifts n
to the right by m
bits.
This is an arithmetic shift: the sign bit of n
is replicated.
The result is unspecified if m < 0
or m >= bitsize
.
OCaml's floating-point numbers follow the
IEEE 754 standard, using double precision (64 bits) numbers.
Floating-point operations never raise an exception on overflow,
underflow, division by zero, etc. Instead, special IEEE numbers
are returned as appropriate, such as infinity
for 1.0 /. 0.0
,
neg_infinity
for -1.0 /. 0.0
, and nan
('not a number')
for 0.0 /. 0.0
. These special numbers then propagate through
floating-point computations as expected: for instance,
1.0 /. infinity
is 0.0
, and any arithmetic operation with nan
as argument returns nan
as result.
val (~-.) : float -> float
-. e
instead of ~-. e
.val (~+.) : float -> float
+. e
instead of ~+. e
.val (+.) : float -> float -> float
val (-.) : float -> float -> float
val ( *. ) : float -> float -> float
val (/.) : float -> float -> float
val ( ** ) : float -> float -> float
val sqrt : float -> float
val exp : float -> float
val log : float -> float
val log10 : float -> float
val expm1 : float -> float
expm1 x
computes exp x -. 1.0
, giving numerically-accurate results
even if x
is close to 0.0
.val log1p : float -> float
log1p x
computes log(1.0 +. x)
(natural logarithm),
giving numerically-accurate results even if x
is close to 0.0
.val cos : float -> float
val sin : float -> float
val tan : float -> float
val acos : float -> float
[-1.0, 1.0]
.
Result is in radians and is between 0.0
and pi
.val asin : float -> float
[-1.0, 1.0]
.
Result is in radians and is between -pi/2
and pi/2
.val atan : float -> float
-pi/2
and pi/2
.val atan2 : float -> float -> float
atan2 y x
returns the arc tangent of y /. x
. The signs of x
and y
are used to determine the quadrant of the result.
Result is in radians and is between -pi
and pi
.val hypot : float -> float -> float
hypot x y
returns sqrt(x *. x + y *. y)
, that is, the length
of the hypotenuse of a right-angled triangle with sides of length
x
and y
, or, equivalently, the distance of the point (x,y)
to origin.val cosh : float -> float
val sinh : float -> float
val tanh : float -> float
val ceil : float -> float
ceil f
returns the least integer value greater than or equal to f
.
The result is returned as a float.val floor : float -> float
floor f
returns the greatest integer value less than or
equal to f
.
The result is returned as a float.val abs_float : float -> float
abs_float f
returns the absolute value of f
.val copysign : float -> float -> float
copysign x y
returns a float whose absolute value is that of x
and whose sign is that of y
. If x
is nan
, returns nan
.
If y
is nan
, returns either x
or -. x
, but it is not
specified which.val mod_float : float -> float -> float
mod_float a b
returns the remainder of a
with respect to
b
. The returned value is a -. n *. b
, where n
is the quotient a /. b
rounded towards zero to an integer.val frexp : float -> float * int
frexp f
returns the pair of the significant
and the exponent of f
. When f
is zero, the
significant x
and the exponent n
of f
are equal to
zero. When f
is non-zero, they are defined by
f = x *. 2 ** n
and 0.5 <= x < 1.0
.val ldexp : float -> int -> float
ldexp x n
returns x *. 2 ** n
.val modf : float -> float * float
modf f
returns the pair of the fractional and integral
part of f
.val float : int -> float
float_of_int
.val float_of_int : int -> float
val truncate : float -> int
int_of_float
.val int_of_float : float -> int
nan
or falls outside the
range of representable integers.val infinity : float
val neg_infinity : float
val nan : float
0.0 /. 0.0
. Stands for
'not a number'. Any floating-point operation with nan
as
argument returns nan
as result. As for floating-point comparisons,
=
, <
, <=
, >
and >=
return false
and <>
returns true
if one or both of their arguments is nan
.val max_float : float
float
.val min_float : float
float
.val epsilon_float : float
1.0
and the smallest exactly representable
floating-point number greater than 1.0
.type
fpclass =
| |
FP_normal |
(* | Normal number, none of the below | *) |
| |
FP_subnormal |
(* | Number very close to 0.0, has reduced precision | *) |
| |
FP_zero |
(* | Number is 0.0 or -0.0 | *) |
| |
FP_infinite |
(* | Number is positive or negative infinity | *) |
| |
FP_nan |
(* | Not a number: result of an undefined operation | *) |
classify_float
function.val classify_float : float -> fpclass
More string operations are provided in module String
.
val (^) : string -> string -> string
More character operations are provided in module Char
.
val int_of_char : char -> int
val char_of_int : int -> char
Invalid_argument "char_of_int"
if the argument is
outside the range 0--255.val ignore : 'a -> unit
()
.
For instance, ignore(f x)
discards the result of
the side-effecting function f
. It is equivalent to
f x; ()
, except that the latter may generate a
compiler warning; writing ignore(f x)
instead
avoids the warning.val string_of_bool : bool -> string
val bool_of_string : string -> bool
Invalid_argument "bool_of_string"
if the string is not
"true"
or "false"
.val string_of_int : int -> string
val int_of_string : string -> int
0x
or 0X
), octal (if it begins with 0o
or 0O
),
or binary (if it begins with 0b
or 0B
).
Raise Failure "int_of_string"
if the given string is not
a valid representation of an integer, or if the integer represented
exceeds the range of integers representable in type int
.val string_of_float : float -> string
val float_of_string : string -> float
Failure "float_of_string"
if the given string is not a valid representation of a float.val fst : 'a * 'b -> 'a
val snd : 'a * 'b -> 'b
More list operations are provided in module List
.
val (@) : 'a list -> 'a list -> 'a list
Sys_error
when the system
calls they invoke fail.type
in_channel
type
out_channel
val stdin : in_channel
val stdout : out_channel
val stderr : out_channel
val print_char : char -> unit
val print_string : string -> unit
val print_int : int -> unit
val print_float : float -> unit
val print_endline : string -> unit
val print_newline : unit -> unit
val prerr_char : char -> unit
val prerr_string : string -> unit
val prerr_int : int -> unit
val prerr_float : float -> unit
val prerr_endline : string -> unit
val prerr_newline : unit -> unit
val read_line : unit -> string
val read_int : unit -> int
Failure "int_of_string"
if the line read is not a valid representation of an integer.val read_float : unit -> float
type
open_flag =
| |
Open_rdonly |
(* | open for reading. | *) |
| |
Open_wronly |
(* | open for writing. | *) |
| |
Open_append |
(* | open for appending: always write at end of file. | *) |
| |
Open_creat |
(* | create the file if it does not exist. | *) |
| |
Open_trunc |
(* | empty the file if it already exists. | *) |
| |
Open_excl |
(* | fail if Open_creat and the file already exists. | *) |
| |
Open_binary |
(* | open in binary mode (no conversion). | *) |
| |
Open_text |
(* | open in text mode (may perform conversions). | *) |
| |
Open_nonblock |
(* | open in non-blocking mode. | *) |
val open_out : string -> out_channel
val open_out_bin : string -> out_channel
open_out
, but the file is opened in binary mode,
so that no translation takes place during writes. On operating
systems that do not distinguish between text mode and binary
mode, this function behaves like open_out
.val open_out_gen : open_flag list -> int -> string -> out_channel
open_out_gen mode perm filename
opens the named file for writing,
as described above. The extra argument mode
specify the opening mode. The extra argument perm
specifies
the file permissions, in case the file must be created.
open_out
and open_out_bin
are special
cases of this function.val flush : out_channel -> unit
val flush_all : unit -> unit
val output_char : out_channel -> char -> unit
val output_string : out_channel -> string -> unit
val output : out_channel -> string -> int -> int -> unit
output oc buf pos len
writes len
characters from string buf
,
starting at offset pos
, to the given output channel oc
.
Raise Invalid_argument "output"
if pos
and len
do not
designate a valid substring of buf
.val output_byte : out_channel -> int -> unit
val output_binary_int : out_channel -> int -> unit
input_binary_int
function. The format is compatible across
all machines for a given version of OCaml.val output_value : out_channel -> 'a -> unit
input_value
. See the description of module
Marshal
for more information. output_value
is equivalent
to Marshal.to_channel
with an empty list of flags.val seek_out : out_channel -> int -> unit
seek_out chan pos
sets the current writing position to pos
for channel chan
. This works only for regular files. On
files of other kinds (such as terminals, pipes and sockets),
the behavior is unspecified.val pos_out : out_channel -> int
Open_append
flag (returns
unspecified results).val out_channel_length : out_channel -> int
val close_out : out_channel -> unit
Sys_error
exception when they are
applied to a closed output channel, except close_out
and flush
,
which do nothing when applied to an already closed channel.
Note that close_out
may raise Sys_error
if the operating
system signals an error when flushing or closing.val close_out_noerr : out_channel -> unit
close_out
, but ignore all errors.val set_binary_mode_out : out_channel -> bool -> unit
set_binary_mode_out oc true
sets the channel oc
to binary
mode: no translations take place during output.
set_binary_mode_out oc false
sets the channel oc
to text
mode: depending on the operating system, some translations
may take place during output. For instance, under Windows,
end-of-lines will be translated from \n
to \r\n
.
This function has no effect under operating systems that
do not distinguish between text mode and binary mode.val open_in : string -> in_channel
val open_in_bin : string -> in_channel
open_in
, but the file is opened in binary mode,
so that no translation takes place during reads. On operating
systems that do not distinguish between text mode and binary
mode, this function behaves like open_in
.val open_in_gen : open_flag list -> int -> string -> in_channel
open_in_gen mode perm filename
opens the named file for reading,
as described above. The extra arguments
mode
and perm
specify the opening mode and file permissions.
open_in
and open_in_bin
are special
cases of this function.val input_char : in_channel -> char
End_of_file
if there are no more characters to read.val input_line : in_channel -> string
End_of_file
if the end of the file is reached
at the beginning of line.val input : in_channel -> string -> int -> int -> int
input ic buf pos len
reads up to len
characters from
the given channel ic
, storing them in string buf
, starting at
character number pos
.
It returns the actual number of characters read, between 0 and
len
(inclusive).
A return value of 0 means that the end of file was reached.
A return value between 0 and len
exclusive means that
not all requested len
characters were read, either because
no more characters were available at that time, or because
the implementation found it convenient to do a partial read;
input
must be called again to read the remaining characters,
if desired. (See also really_input
for reading
exactly len
characters.)
Exception Invalid_argument "input"
is raised if pos
and len
do not designate a valid substring of buf
.val really_input : in_channel -> string -> int -> int -> unit
really_input ic buf pos len
reads len
characters from channel ic
,
storing them in string buf
, starting at character number pos
.
Raise End_of_file
if the end of file is reached before len
characters have been read.
Raise Invalid_argument "really_input"
if
pos
and len
do not designate a valid substring of buf
.val input_byte : in_channel -> int
input_char
, but return the 8-bit integer representing
the character.
Raise End_of_file
if an end of file was reached.val input_binary_int : in_channel -> int
output_binary_int
.
Raise End_of_file
if an end of file was reached while reading the
integer.val input_value : in_channel -> 'a
output_value
, and return the corresponding value.
This function is identical to Marshal.from_channel
;
see the description of module Marshal
for more information,
in particular concerning the lack of type safety.val seek_in : in_channel -> int -> unit
seek_in chan pos
sets the current reading position to pos
for channel chan
. This works only for regular files. On
files of other kinds, the behavior is unspecified.val pos_in : in_channel -> int
val in_channel_length : in_channel -> int
val close_in : in_channel -> unit
Sys_error
exception when they are applied to a closed input channel,
except close_in
, which does nothing when applied to an already
closed channel.val close_in_noerr : in_channel -> unit
close_in
, but ignore all errors.val set_binary_mode_in : in_channel -> bool -> unit
set_binary_mode_in ic true
sets the channel ic
to binary
mode: no translations take place during input.
set_binary_mode_out ic false
sets the channel ic
to text
mode: depending on the operating system, some translations
may take place during input. For instance, under Windows,
end-of-lines will be translated from \r\n
to \n
.
This function has no effect under operating systems that
do not distinguish between text mode and binary mode.module LargeFile:sig
..end
type 'a
ref = {
|
mutable contents : |
'a
.val ref : 'a -> 'a ref
val (!) : 'a ref -> 'a
!r
returns the current contents of reference r
.
Equivalent to fun r -> r.contents
.val (:=) : 'a ref -> 'a -> unit
r := a
stores the value of a
in reference r
.
Equivalent to fun r v -> r.contents <- v
.val incr : int ref -> unit
fun r -> r := succ !r
.val decr : int ref -> unit
fun r -> r := pred !r
.Scanf
and to print data with formatted output functions from modules
Printf
and Format
.
Format strings are made of three kinds of entities:
'%'
followed by one or more characters specifying what kind of argument to
read or print,'@'
followed by one or more characters specifying how to read or print the
argument,'%'
and '@'
in format strings: if a special character follows a '%'
character, it is treated as a plain character. In other words, "%%"
is
considered as a plain '%'
and "%@"
as a plain '@'
.
For more information about conversion specifications and formatting
indications available, read the documentation of modules Scanf
,
Printf
and Format
.
type('a, 'b, 'c, 'd)
format4 =('a, 'b, 'c, 'c, 'c, 'd) format6
('a, 'b, 'c, 'd, 'e, 'f) format6
. Type format6
is built in.
The two simplified types, format
and format4
below are
included for backward compatibility with earlier releases of
OCaml.
'a
is the type of the parameters of the format for formatted output
functions (printf
-style functions);
'a
is the type of the values read by the format for formatted input
functions (scanf
-style functions).'b
is the type of input source for formatted input functions and the
type of output target for formatted output functions.
For printf
-style functions from module Printf
, 'b
is typically
out_channel
;
for printf
-style functions from module Format
, 'b
is typically
Format.formatter
;
for scanf
-style functions from module Scanf
, 'b
is typically
Scanf.Scanning.in_channel
.'b
is also the type of the first argument given to
user's defined printing functions for %a
and %t
conversions,
and user's defined reading functions for %r
conversion.
'c
is the type of the result of the %a
and %t
printing
functions, and also the type of the argument transmitted to the
first argument of kprintf
-style functions or to the
kscanf
-style functions.'d
is the type of parameters for the scanf
-style functions.'e
is the type of the receiver function for the scanf
-style functions.'f
is the final result type of a formatted input/output function
invocation: for the printf
-style functions, it is typically unit
;
for the scanf
-style functions, it is typically the result type of the
receiver function.type('a, 'b, 'c)
format =('a, 'b, 'c, 'c) format4
val string_of_format : ('a, 'b, 'c, 'd, 'e, 'f) format6 -> string
val format_of_string : ('a, 'b, 'c, 'd, 'e, 'f) format6 -> ('a, 'b, 'c, 'd, 'e, 'f) format6
format_of_string s
returns a format string read from the string
literal s
.
Note: format_of_string
can not convert a string argument that is not a
literal. If you need this functionality, use the more general
Scanf.format_from_string
function.val (^^) : ('a, 'b, 'c, 'd, 'e, 'f) format6 ->
('f, 'b, 'c, 'e, 'g, 'h) format6 -> ('a, 'b, 'c, 'd, 'g, 'h) format6
f1 ^^ f2
catenates format strings f1
and f2
. The result is a
format string that behaves as the concatenation of format strings f1
and
f2
: in case of formatted output, it accepts arguments from f1
, then
arguments from f2
; in case of formatted input, it returns results from
f1
, then results from f2
.val exit : int -> 'a
flush_all
.
An implicit exit 0
is performed each time a program
terminates normally. An implicit exit 2
is performed if the program
terminates early because of an uncaught exception.val at_exit : (unit -> unit) -> unit
at_exit
will be called when the program executes exit
,
or terminates, either normally or because of an uncaught exception.
The functions are called in 'last in, first out' order:
the function most recently added with at_exit
is called first.