Class: Benchmark::Tms

Inherits:
Object
  • Object
show all
Defined in:
lib/benchmark.rb

Overview

A data object, representing the times associated with a benchmark measurement.

Constant Summary collapse

CAPTION =

Default caption, see also Benchmark::CAPTION

"      user     system      total        real\n"
FORMAT =

Default format string, see also Benchmark::FORMAT

"%10.6u %10.6y %10.6t %10.6r\n"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(utime = 0.0, stime = 0.0, cutime = 0.0, cstime = 0.0, real = 0.0, label = nil) ⇒ Tms

Returns an initialized Tms object which has utime as the user CPU time, stime as the system CPU time, cutime as the children's user CPU time, cstime as the children's system CPU time, real as the elapsed real time and label as the label.


427
428
429
430
# File 'lib/benchmark.rb', line 427

def initialize(utime = 0.0, stime = 0.0, cutime = 0.0, cstime = 0.0, real = 0.0, label = nil)
  @utime, @stime, @cutime, @cstime, @real, @label = utime, stime, cutime, cstime, real, label.to_s
  @total = @utime + @stime + @cutime + @cstime
end

Instance Attribute Details

#cstimeObject (readonly)

System CPU time of children


410
411
412
# File 'lib/benchmark.rb', line 410

def cstime
  @cstime
end

#cutimeObject (readonly)

User CPU time of children


407
408
409
# File 'lib/benchmark.rb', line 407

def cutime
  @cutime
end

#labelObject (readonly)

Label


419
420
421
# File 'lib/benchmark.rb', line 419

def label
  @label
end

#realObject (readonly)

Elapsed real time


413
414
415
# File 'lib/benchmark.rb', line 413

def real
  @real
end

#stimeObject (readonly)

System CPU time


404
405
406
# File 'lib/benchmark.rb', line 404

def stime
  @stime
end

#totalObject (readonly)

Total time, that is utime + stime + cutime + cstime


416
417
418
# File 'lib/benchmark.rb', line 416

def total
  @total
end

#utimeObject (readonly)

User CPU time


401
402
403
# File 'lib/benchmark.rb', line 401

def utime
  @utime
end

Instance Method Details

#*(x) ⇒ Object

Returns a new Tms object obtained by memberwise multiplication of the individual times for this Tms object by x.


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

def *(x); memberwise(:*, x) end

#+(other) ⇒ Object

Returns a new Tms object obtained by memberwise summation of the individual times for this Tms object with those of the other Tms object. This method and #/() are useful for taking statistics.


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

def +(other); memberwise(:+, other) end

#-(other) ⇒ Object

Returns a new Tms object obtained by memberwise subtraction of the individual times for the other Tms object from those of this Tms object.


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

def -(other); memberwise(:-, other) end

#/(x) ⇒ Object

Returns a new Tms object obtained by memberwise division of the individual times for this Tms object by x. This method and #+() are useful for taking statistics.


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

def /(x); memberwise(:/, x) end

#add(&blk) ⇒ Object

Returns a new Tms object whose times are the sum of the times for this Tms object, plus the time required to execute the code block (blk).


436
437
438
# File 'lib/benchmark.rb', line 436

def add(&blk) # :yield:
  self + Benchmark.measure(&blk)
end

#add!(&blk) ⇒ Object

An in-place version of #add. Changes the times of this Tms object by making it the sum of the times for this Tms object, plus the time required to execute the code block (blk).


446
447
448
449
450
451
452
453
454
# File 'lib/benchmark.rb', line 446

def add!(&blk)
  t = Benchmark.measure(&blk)
  @utime  = utime + t.utime
  @stime  = stime + t.stime
  @cutime = cutime + t.cutime
  @cstime = cstime + t.cstime
  @real   = real + t.real
  self
end

#format(format = nil, *args) ⇒ Object

Returns the contents of this Tms object as a formatted string, according to a format string like that passed to Kernel.format. In addition, #format accepts the following extensions:

%u

Replaced by the user CPU time, as reported by Tms#utime.

%y

Replaced by the system CPU time, as reported by #stime (Mnemonic: y of “s*y*stem”)

%U

Replaced by the children's user CPU time, as reported by Tms#cutime

%Y

Replaced by the children's system CPU time, as reported by Tms#cstime

%t

Replaced by the total CPU time, as reported by Tms#total

%r

Replaced by the elapsed real time, as reported by Tms#real

%n

Replaced by the label string, as reported by Tms#label (Mnemonic: n of “*n*ame”)

If format is not given, FORMAT is used as default value, detailing the user, system and real elapsed time.


501
502
503
504
505
506
507
508
509
510
511
# File 'lib/benchmark.rb', line 501

def format(format = nil, *args)
  str = (format || FORMAT).dup
  str.gsub!(/(%[-+.\d]*)n/) { "#{$1}s" % label }
  str.gsub!(/(%[-+.\d]*)u/) { "#{$1}f" % utime }
  str.gsub!(/(%[-+.\d]*)y/) { "#{$1}f" % stime }
  str.gsub!(/(%[-+.\d]*)U/) { "#{$1}f" % cutime }
  str.gsub!(/(%[-+.\d]*)Y/) { "#{$1}f" % cstime }
  str.gsub!(/(%[-+.\d]*)t/) { "#{$1}f" % total }
  str.gsub!(/(%[-+.\d]*)r/) { "(#{$1}f)" % real }
  format ? str % args : str
end

#to_aObject

Returns a new 6-element array, consisting of the label, user CPU time, system CPU time, children's user CPU time, children's system CPU time and elapsed real time.


526
527
528
# File 'lib/benchmark.rb', line 526

def to_a
  [@label, @utime, @stime, @cutime, @cstime, @real]
end

#to_sObject

Same as #format.


516
517
518
# File 'lib/benchmark.rb', line 516

def to_s
  format
end