bench 0.1.2

A benchmark utility library.

example/bench_example.dart

library bench_example;

import 'dart:async';
import 'package:bench/bench.dart';
import 'package:logging/logging.dart';

void main() {
  
  // Bench logs to a Logger named 'bench'; you may use the logging API to
  // change the log level and add handlers to that logger or the root logger.
  Logger.root.onRecord.listen((record) => print('${record.message}'));
  
  // Create and run() a Benchmarker object; this will detect all of the
  // top-level functions in the current isolate which meet the criteria:
  //    - the function must return a Benchmark
  //    - the function must have no arguments
  // You may optionally pass a number of global iterations to run for all
  // benchmark functions in the isolate.  You may also optionally parse the
  // result by passing a handler function or receiving the value of the
  // returned Future.  The default handler logs the result to bench's logger.
  // You may also optionally pass a library filter if you want to limit the
  // discovery of benchmark functions to a subset of the isolate's libraries.
  new Benchmarker().run();
}

/// This is an example of a synchronous Benchmark with setup
/// see http://en.wikipedia.org/wiki/Pollard's_rho_algorithm
Benchmark pollardRho() {
  
  // Perform your setup code in this scope; it will be executed only one time.
  
  int gcd(int a, int b) {
    while(b > 0) {
      int t = a;
      a = b;
      b = t % b;
    }
    return a;
  }
  
  int rho(int n) {
    int a = 2;
    int b = 2;
    int d = 1;
    while(d == 1) {
      a = (a*a + 1) % n;
      b = (b*b + 1) % n;
      b = (b*b + 1) % n;
      d = gcd((a-b).abs(),n);
    }
    return d;
  }
  
  int n = 329569479697;
  
  // Return a Benchmark object that encapsulates the information bench will
  // need in order to perform your benchmark.
  return new Benchmark(
      () => rho(n), // The function that will be called for each iteration
      warmup:4, // The number of warmup iterations that you want   
      measure:1, // The number of measured iterations that you want
      description:"Pollard's rho algorithm for n: ${n}"); // A description
}

/// This is an example of an asynchronous Benchmark without any setup
/// Notice that we are using the [Benchmark.async] constructor.
Benchmark timer() => new Benchmark.async(
    // The function for asynchronous benchmarks must return a Future
    () {
      
  var completer = new Completer();
  
  // The timer callback will complete the Future and that will trigger bench to 
  // advance to the next iteration of the benchmark or finish.
  new Timer(const Duration(milliseconds: 1500), () => completer.complete());
  
  return completer.future;
}, warmup:6, measure:4, description:"Asynchronous 1.5 second timer");