Class: Benchmark::Report

Inherits:

Object

• Object
• Benchmark::Report

Defined in:

lib/benchmark.rb

Overview

This class is used by the Benchmark.benchmark and Benchmark.bm methods. It is of little direct interest to the user.

Instance Attribute Summary

• #list ⇒ Object readonly

  An array of Benchmark::Tms objects representing each item.

Instance Method Summary

• #initialize(width = 0, format = nil) ⇒ Report constructor

  Returns an initialized Report instance.

• #item(label = "", *format, &blk) ⇒ Object (also: #report)

  Prints the label and measured time for the block, formatted by format.

Constructor Details

#initialize(width = 0, format = nil) ⇒ Report

Returns an initialized Report instance. Usually, one doesn’t call this method directly, as new Report objects are created by the #benchmark and #bm methods. width and format are the label offset and format string used by Tms#format.

# File 'lib/benchmark.rb', line 352

def initialize(width = 0, format = nil)
  @width, @format, @list = width, format, []
end

Instance Attribute Details

#list ⇒ Object (readonly)

An array of Benchmark::Tms objects representing each item.

# File 'lib/benchmark.rb', line 371

def list
  @list
end

Instance Method Details

#item(label = "", *format, &blk) ⇒ Object Also known as: report

Prints the label and measured time for the block, formatted by format. See Tms#format for the formatting rules.

# File 'lib/benchmark.rb', line 361

def item(label = "", *format, &blk) # :yield:
  print label.to_s.ljust(@width)
  @list << res = Benchmark.measure(label, &blk)
  print res.format(@format, *format)
  res
end