Class: Benchmark::Tms

Relationships & Source Files
Inherits:	Object
Defined in:	lib/benchmark.rb

Overview

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

Constant Summary

CAPTION =

Default caption, see also CAPTION

# File 'lib/benchmark.rb', line 395
```
"      user     system      total        real\n"
```
FORMAT =

Default format string, see also FORMAT

# File 'lib/benchmark.rb', line 398
```
"%10.6u %10.6y %10.6t %10.6r\n"
```

Class Method Summary

.new(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 and #label as the label.

Instance Attribute Summary

#cstime readonly

System CPU time of children.
#cutime readonly

User CPU time of children.
#label readonly

Label.
#real readonly

Elapsed real time.
#stime readonly

System CPU time.
#total readonly

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

User CPU time.

Instance Method Summary

#*(x)

Returns a new Tms object obtained by memberwise multiplication of the individual times for this Tms object by x.
#+(other)

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)

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)

Returns a new Tms object obtained by memberwise division of the individual times for this Tms object by x.
#add(&blk)

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)

An in-place version of #add.
#format(format = nil, *args)

Returns the contents of this Tms object as a formatted string, according to a format string like that passed to Kernel.format.
#to_a

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

Same as #format.
#memberwise(op, x) protected

Returns a new Tms object obtained by memberwise operation op of the individual times for this Tms object with those of the other Tms object.

Constructor Details

.new(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.

[ GitHub ]

# 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

#cstime (readonly)

System CPU time of children

[ GitHub ]

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


attr_reader :cstime

#cutime (readonly)

User CPU time of children

[ GitHub ]

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


attr_reader :cutime

#label (readonly)

Label

[ GitHub ]

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


attr_reader :label

#real (readonly)

Elapsed real time

[ GitHub ]

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


attr_reader :real

#stime (readonly)

System CPU time

[ GitHub ]

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


attr_reader :stime

#total (readonly)

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

[ GitHub ]

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


attr_reader :total

#utime (readonly)

User CPU time

[ GitHub ]

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


attr_reader :utime

Instance Method Details

#*(x)

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

[ GitHub ]

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


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

#+(other)

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.

[ GitHub ]

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


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

#-(other)

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

[ GitHub ]

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


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

#/(x)

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.

[ GitHub ]

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


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

#add(&blk)

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).

[ GitHub ]

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


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

#add!(&blk)

An in-place version of #add.

[ GitHub ]

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


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)

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 #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 #cutime
%Y: Replaced by the children's system CPU time, as reported by #cstime
%t: Replaced by the total CPU time, as reported by #total
%r: Replaced by the elapsed real time, as reported by #real
%n: Replaced by the label string, as reported by #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.

[ GitHub ]

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


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

#memberwise(op, x) (protected)

Returns a new Tms object obtained by memberwise operation op of the individual times for this Tms object with those of the other Tms object.

op can be a mathematical operation such as #+, #-, #*, #/

[ GitHub ]

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


def memberwise(op, x)
  case x
  when Benchmark::Tms
    Benchmark::Tms.new(utime.__send__(op, x.utime),
                       stime.__send__(op, x.stime),
                       cutime.__send__(op, x.cutime),
                       cstime.__send__(op, x.cstime),
                       real.__send__(op, x.real)
                       )
  else
    Benchmark::Tms.new(utime.__send__(op, x),
                       stime.__send__(op, x),
                       cutime.__send__(op, x),
                       cstime.__send__(op, x),
                       real.__send__(op, x)
                       )
  end
end

#to_a

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.

[ GitHub ]

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


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

#to_s

Same as #format.

[ GitHub ]

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


def to_s
  format
end

Class: Benchmark::Tms

Overview

Constant Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(utime = 0.0, stime = 0.0, cutime = 0.0, cstime = 0.0, real = 0.0, label = nil) ⇒ Tms

Instance Attribute Details

#cstime (readonly)

#cutime (readonly)

#label (readonly)

#real (readonly)

#stime (readonly)

#total (readonly)

#utime (readonly)

Instance Method Details

#*(x)

#+(other)

#-(other)

#/(x)

#add(&blk)

#add!(&blk)

#format(format = nil, *args)

#memberwise(op, x) (protected)

#to_a

#to_s

.new(utime = 0.0, stime = 0.0, cutime = 0.0, cstime = 0.0, real = 0.0, label = nil) ⇒ `Tms`