検索結果

ObjectSpace.#each_object {|object| ...} -> Integer (27604.0)

• 3.0

• モジュール関数

指定された klass と Object#kind_of? の関係にある全ての オブジェクトに対して繰り返します。引数が省略された時には全てのオブ ジェクトに対して繰り返します。 繰り返した数を返します。

指定された klass と Object#kind_of? の関係にある全ての
オブジェクトに対して繰り返します。引数が省略された時には全てのオブ
ジェクトに対して繰り返します。
繰り返した数を返します。

ブロックが与えられなかった場合は、
Enumerator オブジェクトを返します。

次のクラスのオブジェクトについては繰り返しません

* Fixnum
* Symbol
* TrueClass
* FalseClass
* NilClass

とくに、klass に Fixnum や Symbol などのクラスを指定した場合は、
何も繰り返さないことになります。
なお、Sy...

• Enumerator
• FalseClass
• Fixnum
• NilClass
• ObjectSpace
• Symbol
• TrueClass

ObjectSpace.#each_object(klass) {|object| ...} -> Integer (27604.0)

• 3.0

• モジュール関数

指定された klass と Object#kind_of? の関係にある全ての オブジェクトに対して繰り返します。引数が省略された時には全てのオブ ジェクトに対して繰り返します。 繰り返した数を返します。

指定された klass と Object#kind_of? の関係にある全ての
オブジェクトに対して繰り返します。引数が省略された時には全てのオブ
ジェクトに対して繰り返します。
繰り返した数を返します。

ブロックが与えられなかった場合は、
Enumerator オブジェクトを返します。

次のクラスのオブジェクトについては繰り返しません

* Fixnum
* Symbol
* TrueClass
* FalseClass
* NilClass

とくに、klass に Fixnum や Symbol などのクラスを指定した場合は、
何も繰り返さないことになります。
なお、Sy...

• Enumerator
• FalseClass
• Fixnum
• NilClass
• ObjectSpace
• Symbol
• TrueClass

Jacobian.#jacobian(f, fx, x) -> [Numeric] (27304.0)

• 3.0

• モジュール関数

ヤコビ行列を計算します。

ヤコビ行列を計算します。

@param f ヤコビ行列を求めたい関数を表すオブジェクトを指定します。詳細は
bigdecimal/jacobian をご覧ください。

@param fx f.values(x) の結果を表すベクトルを数値の配列で指定します。

@param x ヤコビ行列を求める点 x にあたるベクトルを数値の配列で指定します。

@return ヤコビ行列を返します。(各要素を Row-major order で 1 次元の配列
にしたオブジェクトを指定します)

@raise RuntimeError 計算結果が特異ヤコビ行列になった...

• Jacobian

ObjectSpace.#count_objects(result_hash = {}) -> Hash (27304.0)

• 3.0

• モジュール関数

オブジェクトを種類ごとにカウントした結果を Hash として返します。

オブジェクトを種類ごとにカウントした結果を Hash として返します。

このメソッドは C Ruby 以外の Ruby では動かないでしょう。

@param result_hash ハッシュを指定します。与えられたハッシュは上書きして返されます。
これを利用すると測定による影響を避けることができます。

@raise TypeError 引数に Hash 以外を与えた場合、発生します。

//emlist[例][ruby]{
ObjectSpace.count_objects # => {:TOTAL=>10000, :FREE=>3011, :T_...

• Hash
• ObjectSpace

ObjectSpace.#count_objects_size(result_hash = nil) -> Hash (27304.0)

• 3.0

• モジュール関数

型ごとのオブジェクトサイズをバイト単位で格納したハッシュを返します。

型ごとのオブジェクトサイズをバイト単位で格納したハッシュを返します。

@param result_hash 戻り値のためのハッシュを指定します。省略した場合は新
しくハッシュを作成します。result_hash の内容は上書き
されます。プローブ効果を避けるために使用します。

戻り値の内容は完全ではない事に注意してください。この内容はあくまでもヒ
ントとして扱う必要があります。特に T_DATA の合計値は正しくないでしょう。

//emlist[例][ruby]{
ObjectSpace.count_objec...

• ObjectSpace

絞り込み条件を変える

ObjectSpace.#count_tdata_objects(result_hash = nil) -> Hash (27304.0)

• 3.0

• モジュール関数

T_DATA の種類ごとにオブジェクトの数を格納したハッシュを返します。

T_DATA の種類ごとにオブジェクトの数を格納したハッシュを返します。

@param result_hash 戻り値のためのハッシュを指定します。省略した場合は新
しくハッシュを作成します。result_hash の内容は上書き
されます。プローブ効果を避けるために使用します。

@raise TypeError result_hash にハッシュ以外を指定した時に発生します。

本メソッドは普通の Ruby プログラマ向けのメソッドではありません。パフォー
マンスに興味のある C Ruby の開発者向けのもので...

• ObjectSpace

ObjectSpace.#each_object -> Enumerator (27304.0)

• 3.0

• モジュール関数

指定された klass と Object#kind_of? の関係にある全ての オブジェクトに対して繰り返します。引数が省略された時には全てのオブ ジェクトに対して繰り返します。 繰り返した数を返します。

指定された klass と Object#kind_of? の関係にある全ての
オブジェクトに対して繰り返します。引数が省略された時には全てのオブ
ジェクトに対して繰り返します。
繰り返した数を返します。

ブロックが与えられなかった場合は、
Enumerator オブジェクトを返します。

次のクラスのオブジェクトについては繰り返しません

* Fixnum
* Symbol
* TrueClass
* FalseClass
* NilClass

とくに、klass に Fixnum や Symbol などのクラスを指定した場合は、
何も繰り返さないことになります。
なお、Sy...

• Enumerator
• FalseClass
• Fixnum
• NilClass
• ObjectSpace
• Symbol
• TrueClass

ObjectSpace.#each_object(klass) -> Enumerator (27304.0)

• 3.0

• モジュール関数

指定された klass と Object#kind_of? の関係にある全ての オブジェクトに対して繰り返します。引数が省略された時には全てのオブ ジェクトに対して繰り返します。 繰り返した数を返します。

指定された klass と Object#kind_of? の関係にある全ての
オブジェクトに対して繰り返します。引数が省略された時には全てのオブ
ジェクトに対して繰り返します。
繰り返した数を返します。

ブロックが与えられなかった場合は、
Enumerator オブジェクトを返します。

次のクラスのオブジェクトについては繰り返しません

* Fixnum
* Symbol
* TrueClass
* FalseClass
* NilClass

とくに、klass に Fixnum や Symbol などのクラスを指定した場合は、
何も繰り返さないことになります。
なお、Sy...

• Enumerator
• FalseClass
• Fixnum
• NilClass
• ObjectSpace
• Symbol
• TrueClass

ObjectSpace.#reachable_objects_from(obj) -> Array | nil (27304.0)

• 3.0

• モジュール関数

obj から到達可能なすべてのオブジェクトを返します。マーク不能なオブジェ クトを指定した場合は nil を返します。本メソッドを使う事でメモリリークの 調査が行えます。

obj から到達可能なすべてのオブジェクトを返します。マーク不能なオブジェ
クトを指定した場合は nil を返します。本メソッドを使う事でメモリリークの
調査が行えます。

//emlist[例][ruby]{
# 配列クラス(Array)と 'a'、'b'、'c' に到達可能。
ObjectSpace.reachable_objects_from(['a', 'b', 'c'])
# => [Array, 'a', 'b', 'c']
//}

obj が 2 つ以上の同じオブジェクト x への参照を持つ場合、戻り値に含まれ
るオブジェクト x は 1 つだけです。

//emlist[例...

• Fixnum
• Float
• ObjectSpace
• Symbol

ObjectSpace.#trace_object_allocations { ... } (27304.0)

• 3.0

• モジュール関数

与えられたブロック内でオブジェクトのトレースを行います。　

与えられたブロック内でオブジェクトのトレースを行います。　

//emlist[例][ruby]{
require 'objspace'

class C
include ObjectSpace

def foo
trace_object_allocations do
obj = Object.new
p "#{allocation_sourcefile(obj)}:#{allocation_sourceline(obj)}"
end
end
end

C.new.foo #=> "objtrace.rb:8"
//}

• ObjectSpace

絞り込み条件を変える

ObjectSpace.#trace_object_allocations_start -> nil (27304.0)

• 3.0

• モジュール関数

オブジェクト割り当てのトレースを開始します。

オブジェクト割り当てのトレースを開始します。

@see ObjectSpace.#trace_object_allocations_stop

• ObjectSpace

ObjectSpace.#trace_object_allocations_stop -> nil (27304.0)

• 3.0

• モジュール関数

オブジェクト割り当てのトレースを終了します。

オブジェクト割り当てのトレースを終了します。

トレースを終了する為には、ObjectSpace.#trace_object_allocations_startを呼んだ回数分だけこのメソッドを呼ぶ必要があります。

@see ObjectSpace.#trace_object_allocations_start

• ObjectSpace

OpenSSL::ASN1.#ObjectId(value) -> OpenSSL::ASN1::ObjectId -> OpenSSL::ASN1::ObjectId (18904.0)

• 3.0

• モジュール関数

ASN.1 の ObjectId 型の値を表現する Ruby のオブジェクトを 生成します。

ASN.1 の ObjectId 型の値を表現する Ruby のオブジェクトを
生成します。

OpenSSL::ASN1::ObjectId.new と同じです。

@param value ASN.1 オブジェクト識別子を表す文字列
@param tag タグ番号
@param tagging タグ付けの方法(:IMPLICIT もしくは :EXPLICIT)
@param tag_class タグクラス(:UNIVERSAL, :CONTEXT_SPECIFIC, :APPLICATION, :PRIVATE のいずれか)

• OpenSSL::ASN1

OpenSSL::ASN1.#ObjectId(value, tag, tagging, tag_class) -> OpenSSL::ASN1::ObjectId (18604.0)

• 3.0

• モジュール関数

ASN.1 の ObjectId 型の値を表現する Ruby のオブジェクトを 生成します。

ASN.1 の ObjectId 型の値を表現する Ruby のオブジェクトを
生成します。

OpenSSL::ASN1::ObjectId.new と同じです。

@param value ASN.1 オブジェクト識別子を表す文字列
@param tag タグ番号
@param tagging タグ付けの方法(:IMPLICIT もしくは :EXPLICIT)
@param tag_class タグクラス(:UNIVERSAL, :CONTEXT_SPECIFIC, :APPLICATION, :PRIVATE のいずれか)

• OpenSSL::ASN1

Kconv.#isjis(str) -> bool (18304.0)

• 3.0

• モジュール関数

文字列 str が ISO-2022-JP なバイト列として正当であるかどうかを判定します。

文字列 str が ISO-2022-JP なバイト列として正当であるかどうかを判定します。

@param str 判定対象の文字列
@see String#isjis

//emlist[例][ruby]{
require 'kconv'

euc_str = "\
\xa5\xaa\xa5\xd6\xa5\xb8\xa5\xa7\xa5\xaf\xa5\xc8\xbb\xd8\xb8\xfe\
\xa5\xd7\xa5\xed\xa5\xb0\xa5\xe9\xa5\xdf\xa5\xf3\xa5\xb0\xb8\xc0\xb8\xec\
\x52\x75\x62\x79".force_...

• Kconv

絞り込み条件を変える

Kconv.#issjis(str) -> bool (18304.0)

• 3.0

• モジュール関数

文字列 str が Shift_JIS なバイト列として正当であるかどうかを判定します。

文字列 str が Shift_JIS なバイト列として正当であるかどうかを判定します。

@param str 判定対象の文字列
@see String#issjis

• Kconv

Kconv.#tojis(str) -> String (18304.0)

• 3.0

• モジュール関数

文字列 str のエンコーディングを iso-2022-jp に変換して返します。

文字列 str のエンコーディングを iso-2022-jp に変換して返します。

Kconv.kconv(str, Kconv::JIS) と同じです。

このメソッドは MIME エンコードされた文字列を展開し、
いわゆる半角カナを全角に変換します。
これらを変換したくない場合は、 NKF.#nkf('-jxm0', str)
を使ってください。

@param str 変換元の文字列

@see Kconv.#kconv, String#tojis

• Kconv

Kconv.#tosjis(str) -> String (18304.0)

• 3.0

• モジュール関数

文字列 str のエンコーディングを shift_jis に変換して返します。

文字列 str のエンコーディングを shift_jis に変換して返します。

このメソッドは MIME エンコードされた文字列を展開し、
いわゆる半角カナを全角に変換します。
これらを変換したくない場合は、 NKF.#nkf('-sxm0', str)
を使ってください。

Kconv.kconv(str, Kconv::SJIS)と同じです。

@param str 変換元の文字列

@see Kconv.#kconv, String#tosjis

• Kconv

Shellwords.#shelljoin(array) -> String (18304.0)

• 3.0

• モジュール関数

配列の各要素である文字列に対して、Bourne シェルのコマンドライン中で安全に 使えるためのエスケープを適用し、空白文字を介してそれらを連結したコマンド ライン文字列を生成します。

配列の各要素である文字列に対して、Bourne シェルのコマンドライン中で安全に
使えるためのエスケープを適用し、空白文字を介してそれらを連結したコマンド
ライン文字列を生成します。

個々の配列要素に対するエスケープには、Shellwords.#shellescape と
同じ規則が適用されます。

@param array エスケープ対象の文字列を要素とする配列を指定します。
@return エスケープ結果を連結した文字列を返します。

例:
require 'shellwords'

pattern = 'Jan 15'
file = 'file nam...

• Shellwords

JSON.#dump(object, io = nil, limit = nil) -> String | IO (9304.0)

• 3.0

• モジュール関数

与えられたオブジェクトを JSON 形式の文字列に変換してダンプします。

与えられたオブジェクトを JSON 形式の文字列に変換してダンプします。

与えられたオブジェクトを引数として JSON.#generate を呼び出します。


@param object ダンプするオブジェクトを指定します。

@param io IO のように write メソッドを実装しているオブジェクトを指定します。

@param limit 指定した場合、limit 段以上深くリンクしたオブジェクトをダンプできません。

@raise ArgumentError オブジェクトのネストの深さが limit を越えた場合に発生します。

//emlist[例][ruby]{
re...

• IO
• JSON
• Marshal

絞り込み条件を変える

JSON.#fast_generate(object) -> String (9304.0)

• 3.0

• モジュール関数

与えられたオブジェクトを一行の JSON 形式の文字列に変換して返します。

与えられたオブジェクトを一行の JSON 形式の文字列に変換して返します。

このメソッドは循環参照のチェックを無効にしています。また、
JSON::NaN, JSON::Infinity, JSON::MinusInfinity を生成することがあります。
このため容易に無限ループを発生させることができるので、気をつけてください。

fast_unparse は将来削除される予定です。

@param object JSON 形式の文字列に変換するオブジェクトを指定します。

//emlist[例][ruby]{
require "json"

JSON.fast_generate({ n...

• JSON

JSON.#fast_unparse(object) -> String (9304.0)

• 3.0

• モジュール関数

与えられたオブジェクトを一行の JSON 形式の文字列に変換して返します。

与えられたオブジェクトを一行の JSON 形式の文字列に変換して返します。

このメソッドは循環参照のチェックを無効にしています。また、
JSON::NaN, JSON::Infinity, JSON::MinusInfinity を生成することがあります。
このため容易に無限ループを発生させることができるので、気をつけてください。

fast_unparse は将来削除される予定です。

@param object JSON 形式の文字列に変換するオブジェクトを指定します。

//emlist[例][ruby]{
require "json"

JSON.fast_generate({ n...

• JSON

JSON.#generate(object, state = nil) -> String (9304.0)

• 3.0

• モジュール関数

与えられたオブジェクトを一行の JSON 形式の文字列に変換して返します。

与えられたオブジェクトを一行の JSON 形式の文字列に変換して返します。

デフォルトでは、サイズが最小となる JSON 形式の文字列を生成します。
また、循環参照のチェックを行います。JSON::NaN, JSON::Infinity,
JSON::MinusInfinity を生成することもありません。

unparse は将来削除される予定です。

@param object JSON 形式の文字列に変換するオブジェクトを指定します。

@param state JSON::State または、to_hash や to_h メソッドでハッシュに変換可能なオブジェクトを指定できます。
...

• JSON
• JSON::State

JSON.#load(source, proc = nil, options = {}) -> object (9304.0)

• 3.0

• モジュール関数

与えられた JSON 形式の文字列を Ruby オブジェクトとしてロードして返します。

与えられた JSON 形式の文字列を Ruby オブジェクトとしてロードして返します。

proc として手続きオブジェクトが与えられた場合は、読み込んだオブジェクトを
引数にその手続きを呼び出します。


require 'json'

str=<<JSON
[1,2,3]
JSON

JSON.load(str) # => [1,2,3]
JSON.load(str, proc{|v| p v }) # => [1,2,3]
# 以下が表示される
# 1
# 2
# 3
# [1,2,3]

str=<<JSON
{ "a"...

• JSON
• Proc

JSON.#load_file!(filespec, opts = {}) -> object (9304.0)

• 3.0

• モジュール関数

filespec で指定した JSON 形式のファイルを Ruby オブジェクトとしてロードして返します。

filespec で指定した JSON 形式のファイルを Ruby オブジェクトとしてロードして返します。

@param filespec ファイル名を指定します。

@param options オプションをハッシュで指定します。指定可能なオプションは JSON.#parse! と同様です。

@see JSON.#parse!

• JSON

絞り込み条件を変える

JSON.#load_file(filespec, opts = {}) -> object (9304.0)

• 3.0

• モジュール関数

filespec で指定した JSON 形式のファイルを Ruby オブジェクトとしてロードして返します。

filespec で指定した JSON 形式のファイルを Ruby オブジェクトとしてロードして返します。

@param filespec ファイル名を指定します。

@param options オプションをハッシュで指定します。指定可能なオプションは JSON.#parse と同様です。

@see JSON.#parse

• JSON

JSON.#parse!(source, options = {}) -> object (9304.0)

• 3.0

• モジュール関数

与えられた JSON 形式の文字列を Ruby オブジェクトに変換して返します。

与えられた JSON 形式の文字列を Ruby オブジェクトに変換して返します。

JSON.#parse よりも危険なデフォルト値が指定されているので
信頼できる文字列のみを入力として使用するようにしてください。

@param source JSON 形式の文字列を指定します。

@param options オプションをハッシュで指定します。
指定可能なオプションは以下の通りです。

: :max_nesting
入れ子になっているデータの最大の深さを指定します。
数値を指定すると深さのチェックを行います。偽を指定すると深さのチェックを行いません。
デフォルト...

• JSON

JSON.#parse(source, options = {}) -> object (9304.0)

• 3.0

• モジュール関数

与えられた JSON 形式の文字列を Ruby オブジェクトに変換して返します。

与えられた JSON 形式の文字列を Ruby オブジェクトに変換して返します。

@param source JSON 形式の文字列を指定します。

@param options オプションをハッシュで指定します。
指定可能なオプションは以下の通りです。

: :max_nesting
入れ子になっているデータの最大の深さを指定します。
偽を指定すると深さのチェックを行いません。デフォルトは 19 です。
: :allow_nan
真を指定すると 4627 を無視してパース時に JSON::NaN, JSON::Infinity,
JSON::MinusInf...

• JSON

JSON.#pretty_generate(object, options = nil) -> String (9304.0)

• 3.0

• モジュール関数

Ruby のオブジェクトを JSON 形式の文字列に変換して返します。

Ruby のオブジェクトを JSON 形式の文字列に変換して返します。

このメソッドは JSON.#generate よりも人間に読みやすい文字列を返します。

pretty_unparse は将来削除される予定です。

@param object JSON 形式の文字列に変換するオブジェクトを指定します。

@param options JSON::State または、to_hash や to_h メソッドでハッシュに変換可能なオブジェクトを指定できます。
ハッシュを使用する場合指定可能なオプションは JSON.#generate を参照してください。

//emlist[...

• JSON
• JSON::State

JSON.#pretty_unparse(object, options = nil) -> String (9304.0)

• 3.0

• モジュール関数

Ruby のオブジェクトを JSON 形式の文字列に変換して返します。

Ruby のオブジェクトを JSON 形式の文字列に変換して返します。

このメソッドは JSON.#generate よりも人間に読みやすい文字列を返します。

pretty_unparse は将来削除される予定です。

@param object JSON 形式の文字列に変換するオブジェクトを指定します。

@param options JSON::State または、to_hash や to_h メソッドでハッシュに変換可能なオブジェクトを指定できます。
ハッシュを使用する場合指定可能なオプションは JSON.#generate を参照してください。

//emlist[...

• JSON
• JSON::State

絞り込み条件を変える

JSON.#restore(source, proc = nil, options = {}) -> object (9304.0)

• 3.0

• モジュール関数

与えられた JSON 形式の文字列を Ruby オブジェクトとしてロードして返します。

与えられた JSON 形式の文字列を Ruby オブジェクトとしてロードして返します。

proc として手続きオブジェクトが与えられた場合は、読み込んだオブジェクトを
引数にその手続きを呼び出します。


require 'json'

str=<<JSON
[1,2,3]
JSON

JSON.load(str) # => [1,2,3]
JSON.load(str, proc{|v| p v }) # => [1,2,3]
# 以下が表示される
# 1
# 2
# 3
# [1,2,3]

str=<<JSON
{ "a"...

• JSON
• Proc

JSON.#unparse(object, state = nil) -> String (9304.0)

• 3.0

• モジュール関数

与えられたオブジェクトを一行の JSON 形式の文字列に変換して返します。

与えられたオブジェクトを一行の JSON 形式の文字列に変換して返します。

デフォルトでは、サイズが最小となる JSON 形式の文字列を生成します。
また、循環参照のチェックを行います。JSON::NaN, JSON::Infinity,
JSON::MinusInfinity を生成することもありません。

unparse は将来削除される予定です。

@param object JSON 形式の文字列に変換するオブジェクトを指定します。

@param state JSON::State または、to_hash や to_h メソッドでハッシュに変換可能なオブジェクトを指定できます。
...

• JSON
• JSON::State

ObjectSpace.#_id2ref(id) -> object (9304.0)

• 3.0

• モジュール関数

オブジェクト ID(BasicObject#__id__)からオブジェクトを得ます。

オブジェクト ID(BasicObject#__id__)からオブジェクトを得ます。

@param id 取得したいオブジェクトの ID を整数で指定します。

@raise RangeError 対応するオブジェクトが存在しなければ発生します。

//emlist[例][ruby]{
a = "hoge"
p ObjectSpace._id2ref(a.__id__) #=> "hoge"
//}

• ObjectSpace

ObjectSpace.#allocation_sourcefile(object) -> String (9304.0)

• 3.0

• モジュール関数

objectの元となったソースファイル名を返します。

objectの元となったソースファイル名を返します。

@param object 元となるソースファイル名を取得したいobjectを指定します。
@return objectの元となるソースファイル名を返します。存在しない場合はnilを返します。

//emlist[例:test.rbというファイルで下記のスクリプトを実行した場合][ruby]{
require 'objspace'

ObjectSpace::trace_object_allocations_start
obj = Object.new
puts "file:#{ObjectSpace::allocation_sourc...

• ObjectSpace

ObjectSpace.#allocation_sourceline(object) -> Integer (9304.0)

• 3.0

• モジュール関数

objectの元となったソースファイルの行番号を返します。

objectの元となったソースファイルの行番号を返します。

@param object 元となるソースファイルの行番号を取得したいobjectを指定します。
@return objectの元となるソースファイルの行番号を返します。存在しない場合はnilを返します。

//emlist[例][ruby]{
require 'objspace'

ObjectSpace::trace_object_allocations_start
obj = Object.new
puts "line:#{ObjectSpace::allocation_sourceline(obj)}" # => lin...

• ObjectSpace

絞り込み条件を変える

ObjectSpace.#define_finalizer(obj) {|id| ...} -> Array (9304.0)

• 3.0

• モジュール関数

obj が解放されるときに実行されるファイナライザ proc を 登録します。同じオブジェクトについて複数回呼ばれたときは置き換えで はなく追加登録されます。固定値 0 と proc を配列にして返します。

obj が解放されるときに実行されるファイナライザ proc を
登録します。同じオブジェクトについて複数回呼ばれたときは置き換えで
はなく追加登録されます。固定値 0 と proc を配列にして返します。

ブロックを指定した場合は、そのブロックがファイナライザになります。
obj の回収時にブロックは obj の ID (BasicObject#__id__)を引数とし
て実行されます。
しかし、後述の問題があるのでブロックでファイナライザを登録するのは難しいでしょう。

@param obj ファイナライザを登録したいオブジェクトを指定します。

@param proc ファイナライザ...

• ObjectSpace
• Proc
• spec/rubycmd
• tempfile

ObjectSpace.#define_finalizer(obj, proc) -> Array (9304.0)

• 3.0

• モジュール関数

obj が解放されるときに実行されるファイナライザ proc を 登録します。同じオブジェクトについて複数回呼ばれたときは置き換えで はなく追加登録されます。固定値 0 と proc を配列にして返します。

obj が解放されるときに実行されるファイナライザ proc を
登録します。同じオブジェクトについて複数回呼ばれたときは置き換えで
はなく追加登録されます。固定値 0 と proc を配列にして返します。

ブロックを指定した場合は、そのブロックがファイナライザになります。
obj の回収時にブロックは obj の ID (BasicObject#__id__)を引数とし
て実行されます。
しかし、後述の問題があるのでブロックでファイナライザを登録するのは難しいでしょう。

@param obj ファイナライザを登録したいオブジェクトを指定します。

@param proc ファイナライザ...

• ObjectSpace
• Proc
• spec/rubycmd
• tempfile

ObjectSpace.#memsize_of(obj) -> Integer (9304.0)

• 3.0

• モジュール関数

obj が消費するメモリ使用量をバイト単位で返します。

obj が消費するメモリ使用量をバイト単位で返します。

@param obj 任意のオブジェクトを指定します。

戻り値の内容は完全ではない事に注意してください。この内容はあくまでもヒ
ントとして扱う必要があります。特に T_DATA の値は正しくないでしょう。
2.2 以降では RVALUE のサイズを含んだ結果を返します。

本メソッドは C Ruby 以外では動作しません。

//emlist[例][ruby]{
require 'objspace'

ObjectSpace.memsize_of(10) # => 0
ObjectSpace.memsize_o...

• ObjectSpace

ObjectSpace.#undefine_finalizer(obj) -> object (9304.0)

• 3.0

• モジュール関数

obj に対するファイナライザをすべて解除します。 obj を返します。

obj に対するファイナライザをすべて解除します。
obj を返します。

@param obj ファイナライザを解除したいオブジェクトを指定します。

//emlist[例][ruby]{
class Sample
def Sample.callback
proc {
puts "finalize"
}
end

def initialize
ObjectSpace.define_finalizer(self, Sample.callback)
end

def undef
ObjectSpace.undefine_final...

• ObjectSpace

Jacobian.#dfdxi(f, fx, x, i) -> [Numeric] (9004.0)

• 3.0

• モジュール関数

関数 f の 微分係数を計算します。ライブラリ内部で使用します。

関数 f の 微分係数を計算します。ライブラリ内部で使用します。

• Jacobian

絞り込み条件を変える

Jacobian.#isEqual(a, b, zero = 0.0, e = 1.0e-8) -> bool (9004.0)

• 3.0

• モジュール関数

引数 a、b が等しいかどうかを返します。ライブラリ内部で使用します。

引数 a、b が等しいかどうかを返します。ライブラリ内部で使用します。

• Jacobian

ObjectSpace.#count_nodes(result_hash = nil) -> Hash (9004.0)

• 3.0

• モジュール関数

ノードの種類ごとの数を格納したハッシュを返します。

ノードの種類ごとの数を格納したハッシュを返します。

@param result_hash 戻り値のためのハッシュを指定します。省略した場合は新
しくハッシュを作成します。result_hash の内容は上書き
されます。プローブ効果を避けるために使用します。

@raise TypeError result_hash にハッシュ以外を指定した時に発生します。

本メソッドは普通の Ruby プログラマ向けのメソッドではありません。パフォー
マンスやメモリ管理に興味のある C Ruby の開発者向けのものです。

/...

• ObjectSpace

ObjectSpace.#garbage_collect(full_mark: true, immediate_sweep: true) -> nil (9004.0)

• 3.0

• モジュール関数

どこからも参照されなくなったオブジェクトを回収します。 GC.start と同じです。

どこからも参照されなくなったオブジェクトを回収します。
GC.start と同じです。

@param full_mark マイナー GC を動作させる場合は false を、そうでない場
合は true を指定します。

@param immediate_sweep sweep を遅らせる(Lazy Sweep を行う)場合は false
を、そうでない場合は true を指定します。

注意: これらのキーワード引数は Ruby の実装やバージョンによって異なりま
す。将来のバージョンとの互換性も保証されませ...

• ObjectSpace

ObjectSpace.#memsize_of_all(klass = nil) -> Integer (9004.0)

• 3.0

• モジュール関数

すべての生存しているオブジェクトが消費しているメモリ使用量をバイト単位 で返します。

すべての生存しているオブジェクトが消費しているメモリ使用量をバイト単位
で返します。

@param klass 指定したクラスのインスタンスのメモリ使用量を返します。省略
した場合はすべてのクラスのインスタンスのメモリ使用量を返し
ます。

本メソッドは以下のような Ruby のコードで定義できます。

//emlist[例][ruby]{
def memsize_of_all klass = false
total = 0
ObjectSpace.each_object{|e|
total += ObjectSpace....

• ObjectSpace

Kernel.#catch {|tag| .... } -> object (322.0)

• 3.0

• モジュール関数

Kernel.#throwとの組み合わせで大域脱出を行います。 catch はブロックを実行します。

Kernel.#throwとの組み合わせで大域脱出を行います。 catch はブロックを実行します。

ブロックの実行中に tag と同一のオブジェクトを引数とする Kernel.#throw が行われた
場合は、その throw の第二引数を戻り値として、ブロックの実行を終了します。

主にネストしたループから一気に脱出するのに使用します。

引数を省略した場合、タグとなるオブジェクトが内部で生成され、ブロックパラメータ tag に
渡されます。

@param tag タグとなる任意のオブジェクトです。
@return ブロックの返り値か、対応するthrowの第二引数を返り値として返しま...

• Kernel

絞り込み条件を変える

Kernel.#catch(tag) {|tag| .... } -> object (322.0)

• 3.0

• モジュール関数

Kernel.#throwとの組み合わせで大域脱出を行います。 catch はブロックを実行します。

Kernel.#throwとの組み合わせで大域脱出を行います。 catch はブロックを実行します。

ブロックの実行中に tag と同一のオブジェクトを引数とする Kernel.#throw が行われた
場合は、その throw の第二引数を戻り値として、ブロックの実行を終了します。

主にネストしたループから一気に脱出するのに使用します。

引数を省略した場合、タグとなるオブジェクトが内部で生成され、ブロックパラメータ tag に
渡されます。

@param tag タグとなる任意のオブジェクトです。
@return ブロックの返り値か、対応するthrowの第二引数を返り値として返しま...

• Kernel

Benchmark.#bmbm(width = 0) {|job| ... } -> [Benchmark::Tms] (304.0)

• 3.0

• モジュール関数

Benchmark::Job オブジェクトを生成して、それを引数として与えられたブロックを 実行します。

....sort }
end

#=>
#
# Rehearsal -----------------------------------------
# sort! 11.928000 0.010000 11.938000 ( 12.756000)
# sort 13.048000 0.020000 13.068000 ( 13.857000)
# ------------------------------- total: 25.006000sec
#
# user system total real
# sort!...

• Benchmark
• Benchmark::Job

DRb.#config -> { Symbol => Object } (304.0)

• 3.0

• モジュール関数

カレントサーバの設定を返します。

カレントサーバの設定を返します。

カレントサーバが存在しない場合は、デフォルトの設定を返します。

@see DRb.#current_server

• DRb

DRb.#front -> object (304.0)

• 3.0

• モジュール関数

カレントサーバのフロントオブジェクトを返します。

カレントサーバのフロントオブジェクトを返します。

@raise DRbServerNotFound カレントサーバが存在しない場合に発生します
@see DRb.#current_server

• DRb

Fiddle.#dlunwrap(addr) -> object (304.0)

• 3.0

• モジュール関数

指定されたアドレスの Ruby オブジェクトを返します。

指定されたアドレスの Ruby オブジェクトを返します。

@param addr Fiddle.#dlwrap が返した Ruby オブジェクトのアドレス(整数)を指定します。

例:

require 'fiddle'
s = 'abc'
p addr = Fiddle.dlwrap(s) #=> 136122440
p Fiddle.dlunwrap(addr) #=> "abc"

• Fiddle

絞り込み条件を変える

Fiddle.#dlwrap(obj) -> Integer (304.0)

• 3.0

• モジュール関数

指定されたオブジェクト obj のアドレスを表す整数を返します。

指定されたオブジェクト obj のアドレスを表す整数を返します。

@param obj Ruby のオブジェクトを指定します。

例:

require 'fiddle'
s = 'abc'
p addr = Fiddle.dlwrap(s) #=> 136122440
p Fiddle.dlunwrap(addr) #=> "abc"

• Fiddle

FileUtils.#cd(dir, options = {}) {|dir| .... } -> object (304.0)

• 3.0

• モジュール関数

プロセスのカレントディレクトリを dir に変更します。

プロセスのカレントディレクトリを dir に変更します。

ブロックとともに呼び出された時はブロック終了後に
元のディレクトリに戻ります。

@param dir ディレクトリを指定します。

@param options :verbose が指定できます。
c:FileUtils#options

//emlist[][ruby]{
require 'fileutils'
FileUtils.cd('/', verbose: true) # chdir and report it
//}

• FileUtils

FileUtils.#chdir(dir, options = {}) {|dir| .... } -> object (304.0)

• 3.0

• モジュール関数

プロセスのカレントディレクトリを dir に変更します。

プロセスのカレントディレクトリを dir に変更します。

ブロックとともに呼び出された時はブロック終了後に
元のディレクトリに戻ります。

@param dir ディレクトリを指定します。

@param options :verbose が指定できます。
c:FileUtils#options

//emlist[][ruby]{
require 'fileutils'
FileUtils.cd('/', verbose: true) # chdir and report it
//}

• FileUtils

Kernel.#URI(uri_str) -> object (304.0)

• 3.0

• モジュール関数

与えられた URI から該当する URI::Generic のサブクラスのインスタンスを生成して 返します。scheme が指定されていない場合は、URI::Generic オブジェクトを返します。

与えられた URI から該当する URI::Generic のサブクラスのインスタンスを生成して
返します。scheme が指定されていない場合は、URI::Generic オブジェクトを返します。

@param uri_str パースしたい URI を文字列として与えます。

@raise URI::InvalidURIError パースに失敗した場合に発生します。

@see URI.parse

• Kernel
• URI::Generic

Kernel.#callcc {|cont| .... } -> object (304.0)

• 3.0

• モジュール関数

継続を作成します。 Continuation を参照してください。

継続を作成します。 Continuation を参照してください。

• Continuation
• Kernel

絞り込み条件を変える

Kernel.#eval(expr) -> object (304.0)

• 3.0

• モジュール関数

文字列 expr を Ruby プログラムとして評価してその結果を返しま す。第2引数に Binding オブジェクトを与えた場合、 そのオブジェクトを生成したコンテキストで文字列を評価します。

文字列 expr を Ruby プログラムとして評価してその結果を返しま
す。第2引数に
Binding オブジェクトを与えた場合、
そのオブジェクトを生成したコンテキストで文字列を評価します。

expr の中のローカル変数の扱いはブロックの場合と同じです。すなわち、eval
実行前に補足されていた変数は eval 実行後にブロック外に持ち出せます。

fname と lineno が与えられた場合には、ファイル
fname の行番号 lineno から文字列 expr が書かれているかのように
コンパイルされます。スタックトレースの表示などを差し替えることが
できます。

bind によ...

• Binding
• Kernel

Kernel.#eval(expr, bind, fname = "(eval)", lineno = 1) -> object (304.0)

• 3.0

• モジュール関数

文字列 expr を Ruby プログラムとして評価してその結果を返しま す。第2引数に Binding オブジェクトを与えた場合、 そのオブジェクトを生成したコンテキストで文字列を評価します。

文字列 expr を Ruby プログラムとして評価してその結果を返しま
す。第2引数に
Binding オブジェクトを与えた場合、
そのオブジェクトを生成したコンテキストで文字列を評価します。

expr の中のローカル変数の扱いはブロックの場合と同じです。すなわち、eval
実行前に補足されていた変数は eval 実行後にブロック外に持ち出せます。

fname と lineno が与えられた場合には、ファイル
fname の行番号 lineno から文字列 expr が書かれているかのように
コンパイルされます。スタックトレースの表示などを差し替えることが
できます。

bind によ...

• Binding
• Kernel

Kernel.#loop { ... } -> object | nil (304.0)

• 3.0

• モジュール関数

(中断されない限り)永遠にブロックの評価を繰り返します。 ブロックが指定されなければ、代わりに Enumerator を返します。

(中断されない限り)永遠にブロックの評価を繰り返します。
ブロックが指定されなければ、代わりに Enumerator を返します。

//emlist[例][ruby]{
loop do
print "Input: "
line = gets
break if !line or line =~ /^qQ/
# ...
end
//}

与えられたブロック内で StopIteration を Kernel.#raise すると
ループを終了して Enumerator が最後に返した値を返します。
ループを終了させる場合、通常は break を使用してください。

//emlist...

• Enumerator
• Kernel
• StopIteration

Kernel.#open(file, mode_enc = "r", perm = 0666) {|io| ... } -> object (304.0)

• 3.0

• モジュール関数

file をオープンして、IO（Fileを含む）クラスのインスタンスを返します。

file をオープンして、IO（Fileを含む）クラスのインスタンスを返します。

ブロックが与えられた場合、指定されたファイルをオープンし、
生成した IO オブジェクトを引数としてブロックを実行します。
ブロックの終了時や例外によりブロックを脱出するとき、
ファイルをクローズします。ブロックを評価した結果を返します。

ファイル名 file が `|' で始まる時には続く文字列をコマンドとして起動し、
コマンドの標準入出力に対してパイプラインを生成します

ファイル名が "|-" である時、open は Ruby の子プロセス
を生成し、その子プロセスとの間のパイプ(IOオブジェクト)を...

• File
• File::Constants
• IO
• Kernel

Kernel.#open(name, mode = &#39;r&#39;, perm = nil, options = {}) {|ouri| ...} -> object (304.0)

• 3.0

• モジュール関数

name が http:// や ftp:// で始まっている文字列なら URI のリソースを 取得した上で StringIO オブジェクトまたは Tempfile オブジェクトとして返します。 返されるオブジェクトは OpenURI::Meta モジュールで extend されています。

name が http:// や ftp:// で始まっている文字列なら URI のリソースを
取得した上で StringIO オブジェクトまたは Tempfile オブジェクトとして返します。
返されるオブジェクトは OpenURI::Meta モジュールで extend されています。

name に open メソッドが定義されている場合は、*rest を引数として渡し
name.open(*rest, &block) のように name の open メソッドが呼ばれます。

これ以外の場合は、name はファイル名として扱われ、従来の
Kernel.#open(name, *res...

• Kernel
• OpenURI::Meta
• StringIO
• Tempfile

絞り込み条件を変える

Kernel.#p(*arg) -> object | Array (304.0)

• 3.0

• モジュール関数

引数を人間に読みやすい形に整形して改行と順番に標準出力 $stdout に出力します。主にデバッグに使用します。

引数を人間に読みやすい形に整形して改行と順番に標準出力 $stdout に出力します。主にデバッグに使用します。

引数の inspect メソッドの返り値と改行を順番に出力します。つまり以下のコードと同じです。

//emlist[例][ruby]{
print arg[0].inspect, "\n", arg[1].inspect, "\n" #, ...
//}

整形に用いられるObject#inspectは普通に文字列に変換すると
区別がつかなくなるようなクラス間の差異も表現できるように工夫されています。

p に引数を与えずに呼び出した場合は特に何もしません。

@param ...

• Kernel

Kernel.#pp(*obj) -> object (304.0)

• 3.0

• モジュール関数

指定されたオブジェクト obj を標準出力に見やすい形式(プリティプリント)で出力します。 obj それぞれを引数として PP.pp を呼ぶことと同等です。

指定されたオブジェクト obj を標準出力に見やすい形式(プリティプリント)で出力します。
obj それぞれを引数として PP.pp を呼ぶことと同等です。

初回呼び出し時に自動的に pp を require します。

@param obj 表示したいオブジェクトを指定します。

//emlist[例][ruby]{
require 'pp'

b = [1, 2, 3] * 4
a = [b, b]
a << a
pp a

#=> [[1, 2, 3, 1, 2, 3, 1, 2, 3, 1, 2, 3],
# [1, 2, 3, 1, 2, 3, 1, 2, 3, 1, 2,...

• Kernel
• pp

Kernel.#putc(ch) -> object (304.0)

• 3.0

• モジュール関数

文字 ch を 標準出力 $stdout に出力します。

文字 ch を 標準出力 $stdout に出力します。

ch が数値なら 0 〜 255 の範囲の対応する文字を出力します。
ch が文字列なら、その先頭1文字を出力します。
どちらでもない場合は、ch.to_int で整数に変換を試みます。

@param ch 出力する文字です。数または文字列で指定します。
@return ch を返します
@raise RangeError Bignum を引数にした場合に発生します。
@raise IOError 標準出力が書き込み用にオープンされていなければ発生します。
@raise Errno::EXXX 出力に失敗した場合に発生します。
@...

• Bignum
• Integer
• Kernel

Marshal.#dump(obj, limit = -1) -> String (304.0)

• 3.0

• モジュール関数

obj を指定された出力先に再帰的に出力します。

obj を指定された出力先に再帰的に出力します。

ファイルに書き出せないオブジェクトをファイルに書き出そうとすると
例外 TypeError が発生します。
ファイルに書き出せないオブジェクトは以下の通りです。

* 名前のついてない Class/Module オブジェクト。(この場
合は、例外 ArgumentError が発生します。無名クラスについて
は、Module.new を参照。)
* システムがオブジェクトの状態を保持するもの。具体的には以下のイン
スタンス。Dir, File::Stat, IO とそのサブクラス
File, Socket など。...

• ArgumentError
• Class
• Continuation
• Data
• Dir
• File
• File::Stat
• Hash
• IO
• Marshal
• MatchData
• Method
• Module
• Proc
• Socket
• String
• Thread
• ThreadGroup
• TypeError
• UnboundMethod

Marshal.#dump(obj, port, limit = -1) -> IO (304.0)

• 3.0

• モジュール関数

obj を指定された出力先に再帰的に出力します。

obj を指定された出力先に再帰的に出力します。

ファイルに書き出せないオブジェクトをファイルに書き出そうとすると
例外 TypeError が発生します。
ファイルに書き出せないオブジェクトは以下の通りです。

* 名前のついてない Class/Module オブジェクト。(この場
合は、例外 ArgumentError が発生します。無名クラスについて
は、Module.new を参照。)
* システムがオブジェクトの状態を保持するもの。具体的には以下のイン
スタンス。Dir, File::Stat, IO とそのサブクラス
File, Socket など。...

• ArgumentError
• Class
• Continuation
• Data
• Dir
• File
• File::Stat
• Hash
• IO
• Marshal
• MatchData
• Method
• Module
• Proc
• Socket
• String
• Thread
• ThreadGroup
• TypeError
• UnboundMethod

絞り込み条件を変える

Marshal.#load(port, proc = nil) -> object (304.0)

• 3.0

• モジュール関数

port からマーシャルデータを読み込んで、元のオブジェクトと同 じ状態をもつオブジェクトを生成します。

port からマーシャルデータを読み込んで、元のオブジェクトと同
じ状態をもつオブジェクトを生成します。

proc として手続きオブジェクトが与えられた場合には読み込んだ
オブジェクトを引数にその手続きを呼び出します。

//emlist[例][ruby]{
str = Marshal.dump(["a", 1, 10 ** 10, 1.0, :foo])
p Marshal.load(str, proc {|obj| p obj})

# => "a"
# 1
# 10000000000
# 1.0
# :foo
# ["a", 1, 10000000000...

• IO
• Marshal
• Proc
• String

Marshal.#restore(port, proc = nil) -> object (304.0)

• 3.0

• モジュール関数

port からマーシャルデータを読み込んで、元のオブジェクトと同 じ状態をもつオブジェクトを生成します。

port からマーシャルデータを読み込んで、元のオブジェクトと同
じ状態をもつオブジェクトを生成します。

proc として手続きオブジェクトが与えられた場合には読み込んだ
オブジェクトを引数にその手続きを呼び出します。

//emlist[例][ruby]{
str = Marshal.dump(["a", 1, 10 ** 10, 1.0, :foo])
p Marshal.load(str, proc {|obj| p obj})

# => "a"
# 1
# 10000000000
# 1.0
# :foo
# ["a", 1, 10000000000...

• IO
• Marshal
• Proc
• String

Process::GID.#switch {...} -> object (304.0)

• 3.0

• モジュール関数

実効グループ ID を一時的に変更するために使います。

実効グループ ID を一時的に変更するために使います。

実効グループ ID を実グループ ID に変更します。実効グループ ID と実グループ ID が
等しい場合には、実効グループ ID を保存グループ ID に変更します。
変更前の実効グループ ID を返します。

ブロックが指定された場合、実効グループ ID を実グループ ID へ
変更しブロックを実行します。ブロック終了時に実効グループ ID を元の
値に戻します。ブロックの実行結果を返します。

なお、保存グループ ID を持たない環境でこのメソッドを実行すると
実グループ ID が変化します。

@raise Errno::E...

• Process::GID

Process::UID.#switch { .... } -> object (304.0)

• 3.0

• モジュール関数

実効ユーザ ID を一時的に変更するために使います。

実効ユーザ ID を一時的に変更するために使います。

実効ユーザ ID を実ユーザ ID に変更します。実効ユーザ ID と実ユーザ ID が
等しい場合には、実効ユーザ ID を保存ユーザ ID に変更します。
変更前の実効ユーザ ID を返します。

ブロックが指定された場合、実効ユーザ ID を実ユーザ ID へ
変更しブロックを実行します。ブロック終了時に実効ユーザ ID を元の
値に戻します。ブロックの実行結果を返します。

なお、保存ユーザ ID を持たない環境でこのメソッドを実行すると
実ユーザ ID が変化します。

@raise Errno::EPERM 各ユーザ ID ...

• Process::UID

Timeout.#timeout(sec, exception_class = nil) {|i| ... } -> object (304.0)

• 3.0

• モジュール関数

ブロックを sec 秒の期限付きで実行します。 ブロックの実行時間が制限を過ぎたときは例外 Timeout::Error が発生します。

ブロックを sec 秒の期限付きで実行します。
ブロックの実行時間が制限を過ぎたときは例外
Timeout::Error が発生します。

exception_class を指定した場合には Timeout::Error の代わりに
その例外が発生します。
ブロックパラメータ i は sec がはいります。

また sec が 0 もしくは nil のときは制限時間なしで
ブロックを実行します。

@param sec タイムアウトする時間を秒数で指定します.
@param exception_class タイムアウトした時、発生させる例外を指定します.
@param message エラー...

• Timeout
• Timeout::Error
• resolv-replace

絞り込み条件を変える

Timeout.#timeout(sec, exception_class, message) {|i| ... } -> object (304.0)

• 3.0

• モジュール関数

ブロックを sec 秒の期限付きで実行します。 ブロックの実行時間が制限を過ぎたときは例外 Timeout::Error が発生します。

ブロックを sec 秒の期限付きで実行します。
ブロックの実行時間が制限を過ぎたときは例外
Timeout::Error が発生します。

exception_class を指定した場合には Timeout::Error の代わりに
その例外が発生します。
ブロックパラメータ i は sec がはいります。

また sec が 0 もしくは nil のときは制限時間なしで
ブロックを実行します。

@param sec タイムアウトする時間を秒数で指定します.
@param exception_class タイムアウトした時、発生させる例外を指定します.
@param message エラー...

• Timeout
• Timeout::Error
• resolv-replace

Kernel.#Complex(r, i = 0, exception: true) -> Complex | nil (22.0)

• 3.0

• モジュール関数

実部が r、虚部が i である Complex クラスのオブジェクトを生成します。

実部が r、虚部が i である Complex クラスのオブジェクトを生成します。

@param r 生成する複素数の実部。

@param i 生成する複素数の虚部。省略した場合は 0 です。

@param s 生成する複素数を表す文字列。

@param exception false を指定すると、変換できなかった場合、
例外を発生する代わりに nil を返します。

@raise ArgumentError 変換できないオブジェクトを指定した場合に発生します。

//emlist[例][ruby]{
Complex(1) # => (...

• Complex
• Kernel

Kernel.#Complex(s, exception: true) -> Complex | nil (22.0)

• 3.0

• モジュール関数

実部が r、虚部が i である Complex クラスのオブジェクトを生成します。

実部が r、虚部が i である Complex クラスのオブジェクトを生成します。

@param r 生成する複素数の実部。

@param i 生成する複素数の虚部。省略した場合は 0 です。

@param s 生成する複素数を表す文字列。

@param exception false を指定すると、変換できなかった場合、
例外を発生する代わりに nil を返します。

@raise ArgumentError 変換できないオブジェクトを指定した場合に発生します。

//emlist[例][ruby]{
Complex(1) # => (...

• Complex
• Kernel

NKF.#guess(str) -> Encoding (22.0)

• 3.0

• モジュール関数

文字列 str の漢字コードを推測して返します。

文字列 str の漢字コードを推測して返します。

返される値は、NKF モジュールのモジュール定数です。

返される値(すなわち、推測可能なエンコーディング)は以下のいずれかです。
* NKF::JIS
* NKF::EUC
* NKF::SJIS
* NKF::UNKNOWN
* NKF::UTF8
* NKF::UTF16
* Encoding::EUCJP_MS
* Encoding::CP51932
* Encoding::WINDOWS_31J

@param str 推測対象の文字列です。

• NKF