Previous Contents Next
Chapter 18 The core library

この章ではObjective Caml core library module:Pervasives moduleにより与えられる関数について記述する。 このモジュールは2つの意味で特別である。
Conventions

Pervasives moduleのシグニチャの定義はコメントとともにこのレポートの最後に列挙する。

18.1 Module Pervasives: the initially opened module


このモジュールはbuilt-inの型(数、真偽値、文字列、例外、参照、リスト、配列、入出力など)とこれらを操作する関数を提供する。

このモジュールはコンパイルのはじめに自動的に開かれる。よってこのモジュールのコンポネントはPervasivesを付けずに参照できる。
Predefined types
type int
正数型。
type char
文字型。
type string
文字列型。
type float
浮動小数点型。
type bool
真偽値型。
type unit = ()
ユニット型。
type exn
例外型。
type 'a array
'a型の配列型。
type 'a list = [] | :: of 'a * 'a list
'a型のリスト型。
type 'a option = None | Some of 'a
オプショナル型。
type ('a, 'b, 'c) format
ストリングのフォーマット。 'aはこのフォーマットの型引数。 , 'cprintf-スタイルの関数の返り値の型。 , 'b %aに与えられた最初の引数の型。 %tはプリント関数。 ( Printfモジュール参照。).
Exceptions
val raise : exn -> 'a
与えられた例外の値をraiseする。
exception Match_failure of (string * int * int)
パターンマッチングに失敗したときにraiseされる。引数はパターンマッチングの場所を記し、ファイル名、始まりの位置、終りの位置である。
exception Assert_failure of (string * int * int)
assertionが失敗したときに例外がraiseされる。引数はパターンマッチングの場所である。Match_failureを参照。
exception Invalid_argument of string
引数が意味をなさない場合にシグナルとして例外が投げられる。
exception Failure of string
与えられた引数が定義されていないときにシグナルとして例外が投げられる。
exception Not_found
要求されたオブジェクトがサーチ関数により見つからなかった場合に投げられる。
exception Out_of_memory
計算するのにメモリが足りない場合にガーベジコレクターにより投げられる。
exception Stack_overflow
深すぎる再帰を行った際にスタック領域が足りなくなった場合にバイトコードインタプリタにより投げられる。
exception Sys_error of string
input/output関数によりOSのエラーの際に投げられる。
exception End_of_file
input関数がファイルの終りに達したときにシグナルとして投げる。
exception Division_by_zero
第2引数が0で割り算が呼ばれたときに投げられる。
exception Exit
この例外はライブラリにより投げられるのではなくプログラム中で提供される。
exception Sys_blocked_io
Sys_error どのI/Oも non-blocking I/O channel上に成り立たないという特別な場合に投げられる。
val invalid_arg: string -> 'a
例外Invalid_argument を文字列とともに投げる。
val failwith: string -> 'a
例外 Failureを文字列とともに投げる。
Comparisons
val (=) : 'a -> 'a -> bool
e1 = e2 e1e2の構造等価を確かめる。 参照や配列などの可変の構造の現在の値が構造的に同じである場合のみに限り等価であるとする。2つの可変オブジェクトが物理的に同じでなくともよい。 関数が引数にとられるとInvalid_argumentを投げる。 cyclic data構造の透過性は止まらない可能性がある。
val (<>) : 'a -> 'a -> bool
(=)の否定.
val (<) : 'a -> 'a -> bool
val (>) : 'a -> 'a -> bool
val (<=) : 'a -> 'a -> bool
val (>=) : 'a -> 'a -> bool
構造的順序付け関数。 これらは整数、文字、文字列、浮動小数点数、などの順序付きのデータに用いられる。これを拡張して全ての型の順序付けが可能である。 順序付けは (=)と互換性がある。 (=)で見たときのように,可変のデータの場合は中身で比べられる。 関数型を比べると Invalid_argumentが投げられる。 Cyclicなデータを比較すると止まらない。
val compare: 'a -> 'a -> int
compare x yx=yならば 0を, x<y ならば負の整数を,x>yならば正の整数を返す。 =を適用するときと同様の制限がある compare は比較関数としてSetMapモジュールで使われる。
val min: 'a -> 'a -> 'a
2引数のうちの小さい方を返す。
val max: 'a -> 'a -> 'a
2引数のうちの大きい方を返す。
val (==) : 'a -> 'a -> bool
e1 == e2 e1e2の物理的等価性をチェックする。 正数型、文字型の場合は構造等価と同じ。可変構造の場合は e1 == e2e1も変更が e2にも影響を与えるような物理的に同じである場合にのみtrueとなる。 可変構造でない場合は, (==)の働きは実装依存となる。それ以外では e1 == e2 e1 = e2を意味する。
val (!=) : 'a -> 'a -> bool
(==)の否定。
Boolean operations
val not : bool -> bool
真偽値の否定。
val (&&) : bool -> bool -> bool
val (&) : bool -> bool -> bool
真偽の``and''。評価は左から右へと行われる。 e1 && e2ではe1 が先に評価されこれがfalseを返す場合はe2は評価されない。
val (||) : bool -> bool -> bool
val (or) : bool -> bool -> bool
真偽の``or''。評価は左から右へと行われる。 e1 && e2ではe1が先に評価されこれがtrueを返す場合は e2は評価されない。
整数演算
整数のビット幅は31ビットである(64ビットプロセッサの場合は63ビット). すべての計算は 231のmodulo(または 2 63)で行なわれる. オーバーフローに関して失敗はしない。.
val (~-) : int -> int
Unary negation. You can also write -e instead of ~-e .
val succ : int -> int
succ xx+1と同義.
val pred : int -> int
pred xx-1と同義.
val (+) : int -> int -> int
整数の和.
val (-) : int -> int -> int
整数の差.
val (*) : int -> int -> int
整数の積.
val (/) : int -> int -> int
整数の商. 第2引数が0の場合はDivision_by_zeroがraiseされる。
val (mod) : int -> int -> int
整数の余りの計算. もし x >= 0 and y > 0であるならば, x mod y 0 <= x mod y < y and x = (x / y) * y + x mod yを満たす. もし y = 0ならば, x mod yDivision_by_zeroを raiseする。 . x < 0 または y < 0の場合の x mod yの計算結果は指定されておらず、プラットホーム依存である.
val abs : int -> 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 mn を左に m ビットシフトした値を返す. m < 0 の場合や (m >= ビットサイズ)の場合の結果は規定されていない, ここでいうビットサイズ とは32ビットプラットホームの場合は 32 で 64ビットプラットホームの場合は64 である.
val (lsr) : int -> int -> int
n lsr mn を右に m ビットシフトした値を返す. これは論理シフトである: nの符合によらず 0が挿入される. m < 0または m >= ビットサイズの場合の結果は規定されていない.
val (asr) : int -> int -> int
n lsr mn を右に m ビットシフトした値を返す. これは算術シフトである: nの符合ビットが複製される. m >= ビットサイズの場合の結果は規定されていない.
浮動小数演算
Camlは IEEE754の標準に準拠した 倍数精度(64ビット)の浮動小数を用いる. 浮動小数演算は オーバーフロー、アンダーフロー、0除算などの例外はraiseされない。 その代わりに それぞれの場合に適切な特別なIEEE数が返される。 たとえば 1.0 /. 0.0にはinfinity , -1.0 /. 0.0にはneg_infinity , 0.0 /. 0.0には nan (``not a number'')がそれぞれ返される . これらの特別な数値は 浮動小数点演算に自然に適用される。例を挙げると1.0 /. infinity0.0になり, nanを引数にとる計算はすべてnanを返す.
val (~-.) : float -> float
Unary negation. You can also write -.e instead of ~-.e .
val (+.) : float -> float -> float
Floating-point addition
val (-.) : float -> float -> float
Floating-point subtraction
val (*.) : float -> float -> float
Floating-point multiplication
val (/.) : float -> float -> float
Floating-point division.
val (**) : float -> float -> float
Exponentiation
val sqrt : float -> float
Square root
val exp : float -> float
val log : float -> float
val log10 : float -> float
Exponential, natural logarithm, base 10 logarithm.
val cos : float -> float
val sin : float -> float
val tan : float -> float
val acos : float -> float
val asin : float -> float
val atan : float -> float
val atan2 : float -> float -> float
The usual trigonometric functions
val cosh : float -> float
val sinh : float -> float
val tanh : float -> float
The usual hyperbolic trigonometric functions
val ceil : float -> float
val floor : float -> float
Round the given float to an integer value. floor f returns the greatest integer value less than or equal to f. ceil f returns the least integer value greater than or equal to f .
val abs_float : float -> float
Return the absolute value of the argument.
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
val float_of_int : int -> float
Convert an integer to floating-point.
val truncate : float -> int
val int_of_float : float -> int
Truncate the given floating-point number to an integer. The result is unspecified if it falls outside the range of representable integers.
val infinity: float
Positive infinity.
val neg_infinity: float
Negative infinity.
val nan: float
A special floating-point value denoting the result of an undefined operation such as 0.0 /. 0.0. Stands for ``not a number''.
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 *)
The five classes of floating-point numbers, as determined by the classify_float function.
val classify_float: float -> fpclass
Return the class of the given floating-point number: normal, subnormal, zero, infinite, or not a number.
String operations
More string operations are provided in module String.
val (^) : string -> string -> string
文字列の結合。
Character operations
More character operations are provided in module Char.
val int_of_char : char -> int
文字のアスキーコードを返す。
val char_of_int : int -> char
Return the character with the given ASCII code. Raise Invalid_argument "char_of_int" if the argument is outside the range 0--255.
Unit operations
val ignore : 'a -> unit
Discard the value of its argument and return (). 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.
String conversion functions
val string_of_bool : bool -> string
真偽値を表す文字列を返す。
val bool_of_string : string -> bool
Convert the given string to a boolean. Raise Invalid_argument "bool_of_string" if the string is not "true" or "false".
val string_of_int : int -> string
Return the string representation of an integer, in decimal.
val int_of_string : string -> int
Convert the given string to an 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. Raise Failure "int_of_string" if the given string is not a valid representation of an integer.
val string_of_float : float -> string
Return the string representation of a floating-point number.
val float_of_string : string -> float
Convert the given string to a float. The result is unspecified if the given string is not a valid representation of a float.
Pair operations
val fst : 'a * 'b -> 'a
Return the first component of a pair.
val snd : 'a * 'b -> 'b
Return the second component of a pair.
List operations
More list operations are provided in module List.
val (@) : 'a list -> 'a list -> 'a list
List concatenation.
Input/output
type in_channel
type out_channel
インプットチャンネルとアウトプットチャンネルの型。
val stdin : in_channel
val stdout : out_channel
val stderr : out_channel
そのプロセスの標準入力、標準出力、標準エラー出力。
Output functions on standard output
val print_char : char -> unit
標準出力に文字をプリント。
val print_string : string -> unit
標準出力に文字列を吐く。
val print_int : int -> unit
標準出力に10進数で整数を表示。
val print_float : float -> unit
標準出力に10進数で浮動小数点を表示。
val print_endline : string -> unit
ストリングを改行文字付きで標準出力に表示。
val print_newline : unit -> unit
標準出力に改行文字を書き、標準出力をフラッシュする。 これは標準出力をラインバッファとしてシミュレートすることを可能とする。
標準エラー出力への出力関数。
val prerr_char : char -> unit
標準エラー出力に文字を出力。
val prerr_string : string -> unit
Print a string on standard error.
val prerr_int : int -> unit
Print an integer, in decimal, on standard error.
val prerr_float : float -> unit
Print a floating-point number, in decimal, on standard error.
val prerr_endline : string -> unit
Print a string, followed by a newline character on standard error and flush standard error.
val prerr_newline : unit -> unit
Print a newline character on standard error, and flush standard error.
標準入力からの入力。
val read_line : unit -> string
Flush standard output, then read characters from standard input until a newline character is encountered. Return the string of all characters read, without the newline character at the end.
val read_int : unit -> int
Flush standard output, then read one line from standard input and convert it to an integer. Raise Failure "int_of_string" if the line read is not a valid representation of an integer.
val read_float : unit -> float
Flush standard output, then read one line from standard input and convert it to a floating-point number. The result is unspecified if the line read is not a valid representation of a floating-point number.
一般的な出力関数
type open_flag =
Open_rdonly | Open_wronly | Open_append
| Open_creat | Open_trunc | Open_excl
| Open_binary | Open_text | Open_nonblock
open_out_genopen_in_genのためのファイルのオープンモード。
Open_rdonly: 読み込み用。
Open_wronly: 書き込み用。
Open_append: 追記用。
Open_creat: ファイルが無かった場合の作成用。
Open_trunc: empty the file if it already exists.
Open_excl: fail if 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

指定された名前のファイルを出力用に開く。ポジションはファイルの始めの部分となる。もしファイルが既に存在していたらこのファイルの長さは0にされる。もしファイルが存在していなかったら新しく作られる。ファイルが開けない場合はSys_errorがレイズされる。
val open_out_bin : string -> out_channel
Same as 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 : mode:open_flag list -> perm:int -> string -> out_channel
Open the named file for writing, as 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 output_char : out_channel -> char -> unit
Write the character on the given output channel.
val output_string : out_channel -> string -> unit
Writeアウトプットチャンネルに文字列を書き込む。
val output : out_channel -> buf:string -> pos:int -> len:int -> unit
Write len characters from string buf, starting at offset pos, to the given output channel. Raise Invalid_argument "output" if pos and len do not designate a valid substring of buf.
val output_byte : out_channel -> int -> unit
Write one 8-bit integer (as the single character with that code) on the given output channel. The given integer is taken modulo 256.
val output_binary_int : out_channel -> int -> unit
Write one integer in binary format on the given output channel. The only reliable way to read it back is through the input_binary_int function. The format is compatible across all machines for a given version of Objective Caml.
val output_value : out_channel -> 'a -> unit
Write the representation of a structured value of any type to a channel. Circularities and sharing inside the value are detected and preserved. The object can be read back, by the function 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
Return the current writing position for the given channel.
val out_channel_length : out_channel -> int
Return the total length (number of characters) of the given channel. This works only for regular files. On files of other kinds, the result is meaningless.
val close_out : out_channel -> unit
Close the given channel, flushing all buffered write operations. A Sys_error exception is raised if any of the functions above is called on a closed channel.
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
文字列により示されたファイルを読み込み用に開き、その入力チャンネルを返す。ポジションはファイルの最初にされている。ファイルを開けない場合はSys_errorがレイズされる。
val open_in_bin : string -> in_channel
Same as 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 : mode:open_flag list -> perm:int -> string -> in_channel
Open the named file for reading, as 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
Read one character from the given input channel. Raise End_of_file if there are no more characters to read.
val input_line : in_channel -> string
Read characters from the given input channel, until a newline character is encountered. Return the string of all characters read, without the newline character at the end. Raise End_of_file if the end of the file is reached at the beginning of line.
val input : in_channel -> buf:string -> pos:int -> len:int -> int
Read up to len characters from the given channel, 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 Pervasives.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 -> buf:string -> pos:int -> len:int -> unit
Read len characters from the given channel, 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
Same as 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
Read an integer encoded in binary format from the given input channel. See output_binary_int. Raise End_of_file if an end of file was reached while reading the integer.
val input_value : in_channel -> 'a
Read the representation of a structured value, as produced by 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
Return the current reading position for the given channel.
val in_channel_length : in_channel -> int
Return the total length (number of characters) of the given channel. This works only for regular files. On files of other kinds, the result is meaningless.
val close_in : in_channel -> unit
Close the given channel. A Sys_error exception is raised if any of the functions above is called on a closed channel.
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.
References
type 'a ref = { mutable contents: 'a }
The type of references (mutable indirection cells) containing a value of type 'a.
val ref : 'a -> 'a ref
Return a fresh reference containing the given value.
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
Increment the integer contained in the given reference. Equivalent to fun r -> r := succ !r.
val decr : int ref -> unit
Decrement the integer contained in the given reference. Equivalent to fun r -> r := pred !r.
Program termination
val exit : int -> 'a
Flush all pending writes on stdout and stderr, and terminate the process, returning the given status code to the operating system (usually 0 to indicate no errors, and a small positive integer to indicate failure.) An implicit exit 0 is performed each time a program terminates normally (but not if it terminates because of an uncaught exception).
val at_exit: (unit -> unit) -> unit
Register the given function to be called at program termination time. The functions registered with at_exit will be called when the program executes exit. They will not be called if the program terminates 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.

Previous Contents Next
Caution!
この文章は永田が自分メモのためにOcamlのUser's manualを勝手に日本語に訳したものです。著作件等の問題があれば撤去します。訳しかたに問題があったら僕にメールを送っていただいても良いですが、多分改善されません。