class Minitest::BenchSpec - minitest: Ruby Standard Library Documentation

# class Minitest::BenchSpec

The spec version of `Minitest::Benchmark`.

### Public Class Methods

bench(name, &block) click to toggle source

This is used to define a new benchmark method. You usually don’t use this directly and is intended for those needing to write new performance curve fits (eg: you need a specific polynomial fit).

See `::bench_performance_linear` for an example of how to use this.

    # File minitest-5.25.4/lib/minitest/benchmark.rb, line 355
    def self.bench name, &block
      define_method "bench_#{name.gsub(/\W+/, "_")}", &block
    end

bench_performance_constant(name, threshold = 0.99, &work) click to toggle source

Create a benchmark that verifies that the performance is constant.

    describe "my class Bench" do
      bench_performance_constant "zoom_algorithm!" do |n|
        @obj.zoom_algorithm!(n)
      end
    end

    # File minitest-5.25.4/lib/minitest/benchmark.rb, line 399
    def self.bench_performance_constant name, threshold = 0.99, &work
      bench name do
        assert_performance_constant threshold, &work
      end
    end

bench_performance_exponential(name, threshold = 0.99, &work) click to toggle source

Create a benchmark that verifies that the performance is exponential.

    describe "my class Bench" do
      bench_performance_exponential "algorithm" do |n|
        @obj.algorithm(n)
      end
    end

    # File minitest-5.25.4/lib/minitest/benchmark.rb, line 414
    def self.bench_performance_exponential name, threshold = 0.99, &work
      bench name do
        assert_performance_exponential threshold, &work
      end
    end

bench_performance_linear(name, threshold = 0.99, &work) click to toggle source

Create a benchmark that verifies that the performance is linear.

    describe "my class Bench" do
      bench_performance_linear "fast_algorithm", 0.9999 do |n|
        @obj.fast_algorithm(n)
      end
    end

    # File minitest-5.25.4/lib/minitest/benchmark.rb, line 384
    def self.bench_performance_linear name, threshold = 0.99, &work
      bench name do
        assert_performance_linear threshold, &work
      end
    end

bench_performance_logarithmic(name, threshold = 0.99, &work) click to toggle source

Create a benchmark that verifies that the performance is logarithmic.

    describe "my class Bench" do
      bench_performance_logarithmic "algorithm" do |n|
        @obj.algorithm(n)
      end
    end

    # File minitest-5.25.4/lib/minitest/benchmark.rb, line 429
    def self.bench_performance_logarithmic name, threshold = 0.99, &work
      bench name do
        assert_performance_logarithmic threshold, &work
      end
    end

bench_performance_power(name, threshold = 0.99, &work) click to toggle source

Create a benchmark that verifies that the performance is power.

    describe "my class Bench" do
      bench_performance_power "algorithm" do |n|
        @obj.algorithm(n)
      end
    end

    # File minitest-5.25.4/lib/minitest/benchmark.rb, line 444
    def self.bench_performance_power name, threshold = 0.99, &work
      bench name do
        assert_performance_power threshold, &work
      end
    end

bench_range(&block) click to toggle source

Specifies the ranges used for benchmarking for that class.

    bench_range do
      bench_exp(2, 16, 2)
    end

See Minitest::Benchmark#bench_range for more details.

Calls superclass method `Minitest::Benchmark::bench_range`

    # File minitest-5.25.4/lib/minitest/benchmark.rb, line 368
    def self.bench_range &block
      return super unless block

      meta = (class << self; self; end)
      meta.send :define_method, "bench_range", &block
    end