Class: Benchmark::Tms
- Inherits:
-
Object
- Object
- Benchmark::Tms
- 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
-
#cstime ⇒ Object
readonly
System CPU time of children.
-
#cutime ⇒ Object
readonly
User CPU time of children.
-
#label ⇒ Object
readonly
Label.
-
#real ⇒ Object
readonly
Elapsed real time.
-
#stime ⇒ Object
readonly
System CPU time.
-
#total ⇒ Object
readonly
Total time, that is
utime
+stime
+cutime
+cstime
. -
#utime ⇒ Object
readonly
User CPU time.
Instance Method Summary collapse
-
#*(x) ⇒ Object
Returns a new Tms object obtained by memberwise multiplication of the individual times for this Tms object by x.
-
#+(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.
-
#-(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.
-
#/(x) ⇒ Object
Returns a new Tms object obtained by memberwise division of the individual times for this Tms object by x.
-
#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
). -
#add!(&blk) ⇒ Object
An in-place version of #add.
-
#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.
-
#initialize(utime = 0.0, stime = 0.0, cutime = 0.0, cstime = 0.0, real = 0.0, label = nil) ⇒ Tms
constructor
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 andlabel
as the label. -
#to_a ⇒ Object
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.
-
#to_s ⇒ Object
Same as #format.
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.
413 414 415 416 |
# File 'lib/benchmark.rb', line 413 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
#cstime ⇒ Object (readonly)
System CPU time of children
396 397 398 |
# File 'lib/benchmark.rb', line 396 def cstime @cstime end |
#cutime ⇒ Object (readonly)
User CPU time of children
393 394 395 |
# File 'lib/benchmark.rb', line 393 def cutime @cutime end |
#label ⇒ Object (readonly)
Label
405 406 407 |
# File 'lib/benchmark.rb', line 405 def label @label end |
#real ⇒ Object (readonly)
Elapsed real time
399 400 401 |
# File 'lib/benchmark.rb', line 399 def real @real end |
#stime ⇒ Object (readonly)
System CPU time
390 391 392 |
# File 'lib/benchmark.rb', line 390 def stime @stime end |
#total ⇒ Object (readonly)
Total time, that is utime
+ stime
+ cutime
+ cstime
402 403 404 |
# File 'lib/benchmark.rb', line 402 def total @total end |
#utime ⇒ Object (readonly)
User CPU time
387 388 389 |
# File 'lib/benchmark.rb', line 387 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.
458 |
# File 'lib/benchmark.rb', line 458 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.
445 |
# File 'lib/benchmark.rb', line 445 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.
452 |
# File 'lib/benchmark.rb', line 452 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.
465 |
# File 'lib/benchmark.rb', line 465 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
).
422 423 424 |
# File 'lib/benchmark.rb', line 422 def add(&blk) # :yield: self + Benchmark.measure(&blk) end |
#add!(&blk) ⇒ Object
An in-place version of #add.
429 430 431 432 433 434 435 436 437 |
# File 'lib/benchmark.rb', line 429 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.
484 485 486 487 488 489 490 491 492 493 494 |
# File 'lib/benchmark.rb', line 484 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_a ⇒ Object
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.
509 510 511 |
# File 'lib/benchmark.rb', line 509 def to_a [@label, @utime, @stime, @cutime, @cstime, @real] end |
#to_s ⇒ Object
Same as #format.
499 500 501 |
# File 'lib/benchmark.rb', line 499 def to_s format end |