scala.testing

Benchmark

trait Benchmark extends AnyRef

Benchmark can be used to quickly turn an existing class into a benchmark. Here is a short example: 

 object sort1 extends Sorter with Benchmark {
   def run = sort(List.range(1, 1000))
 }

The run method has to be defined by the user, who will perform the timed operation there. Run the benchmark as follows: 

 > scala sort1 5 times.log

This will run the benchmark 5 times and log the execution times in a file called times.log

Inherits

  1. AnyRef
  2. Any

Value Members

  1. def equals(arg0: Any): Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an equivalence relation:

    • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
    • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
    • It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef ⇐ Any

  2. def hashCode(): Int

    Returns a hash code value for the object

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    definition classes: AnyRef ⇐ Any

  3. def main(args: Array[String]): Unit

    The entry point

    The entry point. It takes two arguments (n), and an optional argument multiplier (mult). (n) is the number of consecutive runs, if (mult) is present, the n runs are repeated (mult) times.

  4. var multiplier: Int

  5. def prefix: String

    a string that is written at the beginning of the output line that contains the timings

    a string that is written at the beginning of the output line that contains the timings. By default, this is the class name.

  6. def run(): Unit

    this method should be implemented by the concrete benchmark

    this method should be implemented by the concrete benchmark

    attributes: abstract

  7. def runBenchmark(noTimes: Int): List[Long]

    Run the benchmark the specified number of times and return a list with the execution times in milliseconds in reverse order of the execution

    Run the benchmark the specified number of times and return a list with the execution times in milliseconds in reverse order of the execution

    noTimes

    ...

    returns

    ...

  8. def toString(): String

    Returns a string representation of the object

    Returns a string representation of the object.

    The default representation is platform dependent.

    definition classes: AnyRef ⇐ Any