Ruby 1.8.7 リファレンスマニュアル > ライブラリ一覧 > benchmarkライブラリ > Benchmarkモジュール > benchmark

module function Benchmark.#benchmark

benchmark(caption = "", label_width = nil, fmtstr = nil, *labels) {|rep| ...} -> bool[permalink][rdoc]

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

基本的には以下のように使います。 ブロックが Benchmark::Tms オブジェクトの配列を返した場合は、 それらの数値も追加の行に表示されます。

[PARAM] caption:

レポートの一行目に表示する文字列を指定します。

[PARAM] label_width:

ラベルの幅を指定します。

[PARAM] fmtstr:

フォーマット文字列を指定します。 この引数を省略すると Benchmark::FMTSTR が使用されます。

[PARAM] labels:

ブロックが Benchmark::Tms オブジェクトの配列を返す場合に指定します。

[RETURN]

STDIN.sync の値を返すだけなので返り値に意味はありません。

フォーマット文字列

フォーマット文字列として以下が使用できます。

%u

user CPU time で置き換えられます。Benchmark::Tms#utime

%y

system CPU time で置き換えられます(Mnemonic: y of "s*y*stem")。Benchmark::Tms#stime

%U

子プロセスの user CPU time で置き換えられます。Benchmark::Tms#cutime

%Y

子プロセスの system CPU time で置き換えられます。Benchmark::Tms#cstime

%t

total CPU time で置き換えられます。Benchmark::Tms#total

%r

実経過時間で置き換えられます。Benchmark::Tms#real

%n

ラベルで置き換えられます(Mnemonic: n of "*n*ame")。Benchmark::Tms#label

例

require 'benchmark'

n = 50000

# これは
#    Benchmark.bm(7, ">total:", ">avg:") do |x| ... end
# と同じ
Benchmark.benchmark(" "*7 + Benchmark::CAPTION,
                    7,
                    Benchmark::FMTSTR,
                    ">total:",
                    ">avg:") do |x|

  tf = x.report("for:")   { for i in 1..n; a = "1"; end }
  tt = x.report("times:") { n.times do   ; a = "1"; end }
  tu = x.report("upto:")  { 1.upto(n) do ; a = "1"; end }

  [tf+tt+tu, (tf+tt+tu)/3]
end

#=>

             user     system      total        real
for:     1.016667   0.016667   1.033333 (  0.485749)
times:   1.450000   0.016667   1.466667 (  0.681367)
upto:    1.533333   0.000000   1.533333 (  0.722166)
>total:  4.000000   0.033333   4.033333 (  1.889282)
>avg:    1.333333   0.011111   1.344444 (  0.629761)