d_heap 0.6.1 → 0.7.0

data/benchmarks/push_pop.yml

@@ -1,32 +0,0 @@
----
-prelude: |
-  system("#{RbConfig.ruby} bin/rake compile", err: :out, exception: true)
-  require "d_heap/benchmarks"
-  include DHeap::Benchmarks
-  fill_random_vals
-
-  n = ENV.fetch("BENCH_N", 1000).to_i
-
-benchmark:
-  - script: &script |
-       q << random_val
-       q.pop
-    name:    "push + pop (findmin)"
-    prelude: "q = FindMin.new(n) { random_val }"
-    loop_count:   250000
-  - script: *script
-    name:    "push + pop (bsearch)"
-    prelude: "q = BSearch.new(n) { random_val }"
-    loop_count:  5000000
-  - script: *script
-    name:    "push + pop (rb_heap)"
-    prelude: "q = RbHeap.new(n) { random_val }"
-    loop_count:  2000000
-  - script: *script
-    name:    "push + pop (c++ stl)"
-    prelude: "q = initq CppSTL, n"
-    loop_count: 13000000
-  - script: *script
-    name:    "push + pop (c_dheap)"
-    prelude: "q = initq DHeap, n"
-    loop_count: 20000000

data/benchmarks/stackprof.rb

@@ -1,31 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "stackprof"
-
-system("#{RbConfig.ruby} bin/rake compile", err: :out, exception: true)
-require "d_heap/benchmarks"
-include DHeap::Benchmarks # rubocop:disable Style/MixinUsage
-fill_random_vals
-
-n = ENV.fetch("BENCH_N", 5_000_000).to_i
-interval = ENV.fetch("PROF_INTERVAL", 100).to_i # measured in μs
-
-i = 0
-
-q = initq RbHeap
-n.times { q << n }
-q.clear
-
-StackProf.run(mode: :cpu, out: "stackprof-cpu-push.dump", interval: interval) do
-  while i < n
-    q << random_val
-    i += 1
-  end
-end
-StackProf.run(mode: :cpu, out: "stackprof-cpu-pop.dump", interval: interval) do
-  while 0 < i # rubocop:disable Style/NumericPredicate
-    q.pop
-    i -= 1
-  end
-end

data/bin/bench_charts

@@ -1,13 +0,0 @@
-#!/bin/bash
-set -eu
-SCRIPT_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" > /dev/null; pwd -P)
-PROJECT_DIR=$(cd "$SCRIPT_DIR" > /dev/null; cd .. > /dev/null; pwd -P)
-cd "$PROJECT_DIR"
-
-opts=( --bundle -e 'N 100000;N 10000;N 1000;N 100;N 10' -o gruff )
-
-for bm in push_n push_n_pop_n push_pop; do
-  bin/benchmark-driver "${opts[@]}" "benchmarks/${bm}.yml"
-  mv graph.png "images/${bm}.png"
-done
-

data/bin/bench_n

@@ -1,7 +0,0 @@
-#!/bin/sh
-set -eu
-
-export BENCH_N="$1"
-shift
-
-exec ruby "$@"

data/bin/benchmark-driver

@@ -1,29 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-#
-# This file was generated by Bundler.
-#
-# The application 'benchmark-driver' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
-
-bundle_binstub = File.expand_path("../bundle", __FILE__)
-
-if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
-    load(bundle_binstub)
-  else
-    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
-Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
-  end
-end
-
-require "rubygems"
-require "bundler/setup"
-
-load Gem.bin_path("benchmark_driver", "benchmark-driver")

data/bin/benchmarks

@@ -1,10 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
-require "rubygems"
-require "bundler/setup"
-
-require "d_heap/benchmarks/benchmarker"
-DHeap::Benchmarks::Benchmarker.new.call

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "d_heap"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/profile

@@ -1,10 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
-require "rubygems"
-require "bundler/setup"
-
-require "d_heap/benchmarks/profiler"
-DHeap::Benchmarks::Profiler.new.call

data/bin/rake

@@ -1,29 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-#
-# This file was generated by Bundler.
-#
-# The application 'rake' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
-
-bundle_binstub = File.expand_path("../bundle", __FILE__)
-
-if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
-    load(bundle_binstub)
-  else
-    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
-Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
-  end
-end
-
-require "rubygems"
-require "bundler/setup"
-
-load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -1,29 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-#
-# This file was generated by Bundler.
-#
-# The application 'rspec' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
-
-bundle_binstub = File.expand_path("../bundle", __FILE__)
-
-if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
-    load(bundle_binstub)
-  else
-    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
-Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
-  end
-end
-
-require "rubygems"
-require "bundler/setup"
-
-load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -1,29 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-#
-# This file was generated by Bundler.
-#
-# The application 'rubocop' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
-
-bundle_binstub = File.expand_path("../bundle", __FILE__)
-
-if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
-    load(bundle_binstub)
-  else
-    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
-Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
-  end
-end
-
-require "rubygems"
-require "bundler/setup"
-
-load Gem.bin_path("rubocop", "rubocop")

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/lib/benchmark_driver/runner/ips_zero_fail.rb

@@ -1,158 +0,0 @@
-# frozen_string_literal: true
-
-require "English" # $CHILD_STATUS
-require "timeout" # Timeout::Error
-
-require "benchmark_driver"
-
-# monkey-patch to convert miniscule values to 0.0
-class BenchmarkDriver::Output::Compare
-
-  # monkey-patch to convert miniscule values to 0.0
-  module MinisculeToZero
-
-    def humanize(value, width = 10)
-      value <= 0.0.next_float.next_float ? 0.0 : super(value, width)
-    end
-
-  end
-
-  prepend MinisculeToZero
-
-end
-
-# A simple patch to let slow specs error out without
-class BenchmarkDriver::Runner::IpsZeroFail < BenchmarkDriver::Runner::Ips
-  METRIC = BenchmarkDriver::Runner::Ips::METRIC
-
-  # always run at least once
-  class Job < BenchmarkDriver::DefaultJob
-    attr_accessor :warmup_value, :warmup_duration, :warmup_loop_count
-
-    def add_warmup_attrs(value, duration, loop_count)
-      self.warmup_value = value
-      self.warmup_duration = duration
-      self.warmup_loop_count = loop_count
-    end
-
-  end
-
-  # BenchmarkDriver::Runner looks for this class
-  JobParser = BenchmarkDriver::DefaultJobParser.for(klass: Job, metrics: [METRIC])
-
-  # This method is dynamically called by `BenchmarkDriver::JobRunner.run`
-  # @param [Array<BenchmarkDriver::Default::Job>] jobs
-  def run(jobs)
-    jobs = run_all_jobs_warmup(jobs)
-    run_all_jobs_benchmarks(jobs)
-  end
-
-  def run_all_jobs_warmup(jobs)
-    return jobs if jobs.all?(&:loop_count)
-    @output.with_warmup do
-      jobs.map! {|job|
-        # skip warmup if loop_count is set
-        job.loop_count ? job : output_warmup_and_config_job(job)
-      }
-    end
-  end
-
-  def run_all_jobs_benchmarks(jobs)
-    @output.with_benchmark do
-      jobs.each do |job|
-        @output.with_job(name: job.name) do
-          job.runnable_contexts(@contexts).each do |context|
-            run_and_report_job(job, context)
-          end
-        end
-      end
-    end
-  end
-
-  def output_warmup_and_config_job(job)
-    @output.with_job(name: job.name) do
-      context = job.runnable_contexts(@contexts).first
-      value, duration, warmup_loop_count = run_and_report_warmup_job(job, context)
-      loop_count = (warmup_loop_count.to_f * @config.run_duration / duration).floor
-      Job.new(**job.to_h.merge(loop_count: loop_count))
-        .tap {|j| j.add_warmup_attrs(value, duration, warmup_loop_count) }
-    end
-  end
-
-  def run_and_report_warmup_job(job, context)
-    duration, loop_count = run_warmup(job, context: context)
-    value, duration = value_duration(duration: duration, loop_count: loop_count)
-    output_with_context(context) do
-      @output.report(
-        values: {metric => value}, duration: duration, loop_count: loop_count
-      )
-    end
-    [value, duration, loop_count]
-  end
-
-  def run_and_report_job(job, context)
-    result, loop_count = run_job_with_repeater(job, context)
-    value, duration = result.value
-    output_with_context(context) do
-      @output.report(
-        values: { metric => value },
-        all_values: { metric => result.all_values },
-        duration: duration,
-        loop_count: loop_count,
-      )
-    end
-  end
-
-  def output_with_context(context, &block)
-    @output.with_context(
-      name: context.name,
-      executable: context.executable,
-      gems: context.gems,
-      prelude: context.prelude,
-      &block
-    )
-  end
-
-  def run_job_with_repeater(job, context)
-    repeat_params = { config: @config, larger_better: true, rest_on_average: :average }
-    if job.loop_count&.positive?
-      run_job_with_own_loop_count(job, context, repeat_params)
-    else
-      run_job_with_warmup_loop_count(job, context, repeat_params)
-    end
-  end
-
-  def run_job_with_own_loop_count(job, context, repeat_params)
-    loop_count = job.loop_count
-    result = BenchmarkDriver::Repeater.with_repeat(**repeat_params) {
-      run_benchmark(job, context: context)
-    }
-    [result, loop_count]
-  end
-
-  def run_job_with_warmup_loop_count(job, context, repeat_params)
-    loop_count = job.warmup_loop_count
-    repeater_value = [job.warmup_value, job.warmup_duration]
-    result = BenchmarkDriver::Repeater::RepeatResult.new(
-      value: repeater_value, all_values: [repeater_value]
-    )
-    [result, loop_count]
-  end
-
-  def run_warmup(job, context:)
-    start = Time.now
-    super(job, context: context)
-  rescue Timeout::Error
-    [Time.now - start, 0.0.next_float]
-  end
-
-  def execute(*args, exception: true)
-    super
-  rescue RuntimeError => ex
-    if args.include?("timeout") && $CHILD_STATUS&.exitstatus == 124
-      raise Timeout::Error, ex.message
-    end
-    raise ex
-  end
-
-end

data/lib/d_heap/benchmarks.rb

@@ -1,112 +0,0 @@
-# frozen_string_literal: true
-
-require "d_heap"
-require "ostruct"
-
-# Different benchmark scenarios and implementations to benchmark
-module DHeap::Benchmarks
-
-  def self.puts_version_info(type = "Benchmark", io = $stdout)
-    io.puts "#{type} run at %s" % [Time.now]
-    io.puts "ruby v%s, DHeap v%s" % [RUBY_VERSION, DHeap::VERSION]
-    io.puts
-  end
-
-  # rubocop:disable Style/NumericPredicate
-
-  # moves "rand" outside the benchmarked code, to avoid measuring that too.
-  module Randomness
-
-    def default_randomness_size; 1_000_000 end
-
-    def fill_random_vals(target_size = default_randomness_size, io: $stdout)
-      @dheap_bm_random_vals ||= []
-      count = target_size - @dheap_bm_random_vals.length
-      return 0 if count <= 0
-      millions = (count / 1_000_000.0).round(3)
-      io&.puts "~~~~~~ filling @dheap_bm_random_vals with #{millions}M ~~~~~~"
-      io&.flush
-      count.times do @dheap_bm_random_vals << rand(0..10_000) end
-      @dheap_bm_random_len = @dheap_bm_random_vals.length
-      @dheap_bm_random_idx = (((@dheap_bm_random_idx || -1) + 1) % @dheap_bm_random_len)
-      nil
-    end
-
-    def random_val
-      @dheap_bm_random_vals.fetch(
-        @dheap_bm_random_idx = ((@dheap_bm_random_idx + 1) % @dheap_bm_random_len)
-      )
-    end
-
-  end
-
-  # different scenarios to be benchmarked or profiled
-  module Scenarios
-
-    def push_n_multiple_queues(count, *queues)
-      while 0 < count
-        value = @dheap_bm_random_vals.fetch(
-          @dheap_bm_random_idx = ((@dheap_bm_random_idx + 1) % @dheap_bm_random_len)
-        )
-        queues.each do |queue|
-          queue << value
-        end
-        count -= 1
-      end
-    end
-
-    def push_n(queue, count)
-      while 0 < count
-        queue << @dheap_bm_random_vals.fetch(
-          @dheap_bm_random_idx = ((@dheap_bm_random_idx + 1) % @dheap_bm_random_len)
-        )
-        count -= 1
-      end
-    end
-
-    def push_n_then_pop_n(queue, count) # rubocop:disable Metrics/MethodLength
-      i = 0
-      while i < count
-        queue << @dheap_bm_random_vals.fetch(
-          @dheap_bm_random_idx = ((@dheap_bm_random_idx + 1) % @dheap_bm_random_len)
-        )
-        i += 1
-      end
-      while 0 < i
-        queue.pop
-        i -= 1
-      end
-    end
-
-    def repeated_push_pop(queue, count)
-      while 0 < count
-        queue << @dheap_bm_random_vals.fetch(
-          @dheap_bm_random_idx = ((@dheap_bm_random_idx + 1) % @dheap_bm_random_len)
-        )
-        queue.pop
-        count -= 1
-      end
-    end
-
-  end
-
-  include Randomness
-  include Scenarios
-
-  def initq(klass, count = 0, clear: false)
-    queue = klass.new
-    while 0 < count
-      queue << @dheap_bm_random_vals.fetch(
-        @dheap_bm_random_idx = ((@dheap_bm_random_idx + 1) % @dheap_bm_random_len)
-      )
-      count -= 1
-    end
-    queue.clear if clear
-    queue
-  end
-
-  # rubocop:enable Style/NumericPredicate
-
-  require "d_heap/benchmarks/implementations"
-
-end