kotovalexarian-likes-github/ruby--ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
Code Releases Activity

* lib/benchmark.rb: Updated formatting of Benchmark documentation for

Browse source 
consistency.  [ruby-trunk - Bug #6533]


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@35974 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
drbrain 2012-06-08 22:56:17 +00:00
parent 1d7798dc75
commit b2b93d4be1
2 changed files with 31 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
ChangeLog
View file

@ -1,3 +1,8 @@
Sat Jun 9 07:56:03 2012 Eric Hodel <drbrain@segment7.net>
* lib/benchmark.rb: Updated formatting of Benchmark documentation for
consistency. [ruby-trunk - Bug #6533]
Sat Jun 9 07:46:26 2012 Eric Hodel <drbrain@segment7.net> Sat Jun 9 07:46:26 2012 Eric Hodel <drbrain@segment7.net>
* lib/delegate.rb: Added documentation for Delegator#!. Patch by * lib/delegate.rb: Added documentation for Delegator#!. Patch by

49
lib/benchmark.rb
View file

@ -19,7 +19,7 @@
# used to execute Ruby code. # used to execute Ruby code.
# #
# * Measure the time to construct the string given by the expression # * Measure the time to construct the string given by the expression
# <tt>"a"*1_000_000</tt>: # <code>"a"*1_000_000</code>:
# #
# require 'benchmark' # require 'benchmark'
# #
@ -122,18 +122,18 @@
module Benchmark module Benchmark
BENCHMARK_VERSION = "2002-04-25" #:nodoc" BENCHMARK_VERSION = "2002-04-25" # :nodoc:
# Invokes the block with a <tt>Benchmark::Report</tt> object, which # Invokes the block with a Benchmark::Report object, which
# may be used to collect and report on the results of individual # may be used to collect and report on the results of individual
# benchmark tests. Reserves <i>label_width</i> leading spaces for # benchmark tests. Reserves +label_width+ leading spaces for
# labels on each line. Prints _caption_ at the top of the # labels on each line. Prints +caption+ at the top of the
# report, and uses _format_ to format each line. # report, and uses +format+ to format each line.
# Returns an array of Benchmark::Tms objects. # Returns an array of Benchmark::Tms objects.
# #
# If the block returns an array of # If the block returns an array of
# <tt>Benchmark::Tms</tt> objects, these will be used to format # Benchmark::Tms objects, these will be used to format
# additional lines of output. If _label_ parameters are # additional lines of output. If +label+ parameters are
# given, these are used to label these extra lines. # given, these are used to label these extra lines.
# #
# _Note_: Other methods provide a simpler interface to this one, and are # _Note_: Other methods provide a simpler interface to this one, and are
@ -153,7 +153,7 @@ module Benchmark
# [tf+tt+tu, (tf+tt+tu)/3] # [tf+tt+tu, (tf+tt+tu)/3]
# end # end
# #
# <i>Generates:</i> # Generates:
# #
# user system total real # user system total real
# for: 1.016667 0.016667 1.033333 ( 0.485749) # for: 1.016667 0.016667 1.033333 ( 0.485749)
@ -181,8 +181,9 @@ module Benchmark
end end
# A simple interface to the #benchmark method, #bm is generates sequential reports # A simple interface to the #benchmark method, #bm is generates sequential
# with labels. The parameters have the same meaning as for #benchmark. # reports with labels. The parameters have the same meaning as for
# #benchmark.
# #
# require 'benchmark' # require 'benchmark'
# #
@ -193,7 +194,7 @@ module Benchmark
# x.report("upto:") { 1.upto(n) do ; a = "1"; end } # x.report("upto:") { 1.upto(n) do ; a = "1"; end }
# end # end
# #
# <i>Generates:</i> # Generates:
# #
# user system total real # user system total real
# for: 1.050000 0.000000 1.050000 ( 0.503462) # for: 1.050000 0.000000 1.050000 ( 0.503462)
@ -211,7 +212,7 @@ module Benchmark
# that run later. #bmbm attempts to minimize this effect by running # that run later. #bmbm attempts to minimize this effect by running
# the tests twice, the first time as a rehearsal in order to get the # the tests twice, the first time as a rehearsal in order to get the
# runtime environment stable, the second time for # runtime environment stable, the second time for
# real. <tt>GC.start</tt> is executed before the start of each of # real. GC.start is executed before the start of each of
# the real timings; the cost of this is not included in the # the real timings; the cost of this is not included in the
# timings. In reality, though, there's only so much that #bmbm can # timings. In reality, though, there's only so much that #bmbm can
# do, and the results are not guaranteed to be isolated from garbage # do, and the results are not guaranteed to be isolated from garbage
@ -229,7 +230,7 @@ module Benchmark
# x.report("sort") { array.dup.sort } # x.report("sort") { array.dup.sort }
# end # end
# #
# <i>Generates:</i> # Generates:
# #
# Rehearsal ----------------------------------------- # Rehearsal -----------------------------------------
# sort! 11.928000 0.010000 11.938000 ( 12.756000) # sort! 11.928000 0.010000 11.938000 ( 12.756000)
@ -307,8 +308,8 @@ module Benchmark
# Returns an initialized Job instance. # Returns an initialized Job instance.
# Usually, one doesn't call this method directly, as new # Usually, one doesn't call this method directly, as new
# Job objects are created by the #bmbm method. # Job objects are created by the #bmbm method.
# _width_ is a initial value for the label offset used in formatting; # +width+ is a initial value for the label offset used in formatting;
# the #bmbm method passes its _width_ argument to this constructor. # the #bmbm method passes its +width+ argument to this constructor.
# #
def initialize(width) def initialize(width)
@width = width @width = width
@ -345,7 +346,7 @@ module Benchmark
# Returns an initialized Report instance. # Returns an initialized Report instance.
# Usually, one doesn't call this method directly, as new # Usually, one doesn't call this method directly, as new
# Report objects are created by the #benchmark and #bm methods. # Report objects are created by the #benchmark and #bm methods.
# _width_ and _format_ are the label offset and # +width+ and +format+ are the label offset and
# format string used by Tms#format. # format string used by Tms#format.
# #
def initialize(width = 0, format = nil) def initialize(width = 0, format = nil)
@ -353,8 +354,8 @@ module Benchmark
end end
# #
# Prints the _label_ and measured time for the block, # Prints the +label+ and measured time for the block,
# formatted by _format_. See Tms#format for the # formatted by +format+. See Tms#format for the
# formatting rules. # formatting rules.
# #
def item(label = "", *format, &blk) # :yield: def item(label = "", *format, &blk) # :yield:
@ -399,7 +400,7 @@ module Benchmark
# Elapsed real time # Elapsed real time
attr_reader :real attr_reader :real
# Total time, that is _utime_ + _stime_ + _cutime_ + _cstime_ # Total time, that is +utime+ + +stime+ + +cutime+ + +cstime+
attr_reader :total attr_reader :total
# Label # Label
@ -407,9 +408,9 @@ module Benchmark
# #
# Returns an initialized Tms object which has # Returns an initialized Tms object which has
# _utime_ as the user CPU time, _stime_ as the system CPU time, # +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 # +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. # system CPU time, +real+ as the elapsed real time and +label+ as the label.
# #
def initialize(utime = 0.0, stime = 0.0, cutime = 0.0, cstime = 0.0, real = 0.0, label = nil) 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 @utime, @stime, @cutime, @cstime, @real, @label = utime, stime, cutime, cstime, real, label.to_s
@ -418,7 +419,7 @@ module Benchmark
# #
# Returns a new Tms object whose times are the sum of the times for this # 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_). # Tms object, plus the time required to execute the code block (+blk+).
# #
def add(&blk) # :yield: def add(&blk) # :yield:
self + Benchmark.measure(&blk) self + Benchmark.measure(&blk)