-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update readme and gitignore files. README has better usage examples a…
…nd links to acks.
- Loading branch information
Showing
2 changed files
with
42 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,46 @@ | ||
# benchmark-plot | ||
|
||
A Ruby benchmark extension to allow comparative plotting of benchmarks. | ||
|
||
# Usage | ||
|
||
This gem is mainly useful for benchmarking code over a number of inputs. This input should be supplied in the form of an object capable of calling `#each`. | ||
|
||
Sample benchmarking script: | ||
|
||
``` ruby | ||
require 'benchmark/plot' | ||
|
||
class TestArray | ||
attr_reader :arr | ||
|
||
def initialize arr | ||
@arr = arr | ||
end | ||
|
||
def to_s | ||
@arr.size.to_s | ||
end | ||
end | ||
|
||
test_data = [5, 25, 50, 75, 100, 125, 150, 175, 200,250,300] | ||
test_data.map! {|e| TestArray.new(Array.new(e) {|i| i}) } | ||
|
||
Benchmark.plot(test_data) do |x| | ||
x.report("map.flatten") do |data| | ||
data.arr.map { [nil] }.flatten | ||
end | ||
|
||
x.report("flat_map") do |data| | ||
data.arr.flat_map { [nil] } | ||
end | ||
end | ||
``` | ||
|
||
Output: | ||
|
||
![Benchmarks](examples/mapflat_vs_flat_map/benchmark_plot_graph.png) | ||
|
||
# Acknowledgements | ||
|
||
@tgxworld for providing the co-working space during the Open Source Breakfast Hack during Red Dot Ruby Conf 2016 where this gem was built. | ||
[@tgxworld](https://github.com/tgxworld) for providing the co-working space during the Open Source Breakfast Hack during Red Dot Ruby Conference 2016 where this gem was built. |