Class

Benchmark::Tms

Inheritance
< Object

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

Constants

Name   Description
CAPTION = " user system total real\n"
FMTSTR = "%10.6u %10.6y %10.6t %10.6r\n"

Attributes

Name Visibility R/W Description
cstime public R System CPU time of children
cutime public R User CPU time of children
label public R Label
real public R Elapsed real time
stime public R System CPU time
total public R Total time, that is utime + stime + cutime + cstime
utime public R User CPU time

Methods

Class

Visibility Signature
public new (u = 0.0, s = 0.0, cu = 0.0, cs = 0.0, real = 0.0, l = nil)

Instance

Visibility Signature
public * (x)
public + (other)
public - (other)
public / (x)
public add () {|| ...}
public add! ()
public format (arg0 = nil, *args)
public to_a ()
public to_s ()
protected memberwise (op, x)

Class Method Detail

new(u = 0.0, s = 0.0, cu = 0.0, cs = 0.0, real = 0.0, l = nil)

Returns an initialized Tms object which has u as the user CPU time, s as the system CPU time, cu as the children‘s user CPU time, cs as the children‘s system CPU time, real as the elapsed real time and l as the label.

Instance Method Detail

*(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. This method and #/() are useful for taking statistics.

-(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. This method and #+() are useful for taking statistics.

add() {|| ...}

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!()

An in-place version of add.

format(arg0 = 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 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 fmtstr is not given, FMTSTR is used as default value, detailing the user, system and real elapsed time.

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)