p

org

scalameter

package scalameter

Linear Supertypes
MeasureBuilder[Unit, Double], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. scalameter
  2. MeasureBuilder
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Package Members

  1. package execution
  2. package japi
  3. package persistence
  4. package reporting
  5. package utils

Type Members

  1. sealed trait AbstractPerformanceTest extends AnyRef

    Abstract required for the org.scalameter.ScalaMeterFramework to find all performance tests.

  2. abstract class BasePerformanceTest[U] extends AbstractPerformanceTest
  3. abstract class Bench[U] extends DSL[U] with Serializable

    Base class for ScalaMeter benchmarks.

  4. case class CurveData[T](measurements: Seq[Measurement[T]], info: Map[Key[_], Any], context: Context) extends Product with Serializable
  5. abstract class DSL[U] extends BasePerformanceTest[U]
  6. class Errors[T] extends AnyRef
  7. trait Executor[V] extends AnyRef

    Executor is a class that executes benchmarks.

    Executor is a class that executes benchmarks.

    It uses a warmer to get the VM to a state where benchmarks can be executed. It then uses a measurer to do the actual measurements.

  8. abstract class Gen[T] extends Serializable

    Base class for ScalaMeter generators.

    Base class for ScalaMeter generators.

    Generators create warmup and benchmark datasets for running benchmarks. They support neat combinator-style syntax for composing more complex generators out of simpler ones.

  9. trait GroupedPerformanceTest extends BasePerformanceTest[Nothing]
  10. case class History[V](results: Seq[Entry[V]], infomap: Map[Key[_], Any] = Map.empty) extends Product with Serializable
    Annotations
    @SerialVersionUID()
  11. type KeyValue = (Key[T], T) forSome {type T}
  12. sealed trait LowPriorityImplicits extends AnyRef
  13. case class Measurement[T](value: T, params: Parameters, data: MeasurementData[T], units: String)(implicit evidence$1: Pickler[T]) extends Product with Serializable
    Annotations
    @SerialVersionUID()
  14. case class Parameter[T](fullName: String)(implicit evidence$1: Pickler[T]) extends PicklerBasedKey[T] with Product with Serializable
  15. case class Parameters(axisData: Map[Parameter[_], Any]) extends Product with Serializable
    Annotations
    @SerialVersionUID()
  16. trait Persistor extends AnyRef

    Persistors are used to store historical data about benchmark runs.

  17. trait PrettyPrinter[T] extends Serializable

    Pretty prints values.

    Pretty prints values.

    The default implementation simply calls toString method.

  18. trait Reporter[T] extends Serializable

    Reporters report results of ScalaMeter benchmarks.

    Reporters report results of ScalaMeter benchmarks.

    Reporters are called at the completion of each benchmark, and once more after all benchmarks complete.

  19. class ScalaMeterFramework extends Framework
  20. case class Setup[T](context: Context, gen: Gen[T], setupbeforeall: Option[() => Unit], teardownafterall: Option[() => Unit], setup: Option[(T) => Any], teardown: Option[(T) => Any], customwarmup: Option[() => Any], snippet: (T) => Any) extends Product with Serializable

Value Members

  1. def config(kvs: KeyValue*): MeasureBuilder[Unit, Double]
    Definition Classes
    MeasureBuilder
  2. val ctx: Context
    Definition Classes
    MeasureBuilder
  3. def currentContext: Context
  4. def events: Events
  5. def log: Log
  6. def measure[S](b: => S): Quantity[Double]
    Definition Classes
    MeasureBuilder
  7. def measureWith[S](b: (Unit) => S): Quantity[Double]
    Definition Classes
    MeasureBuilder
  8. def measured[S](b: => S): (S, Quantity[Double])
    Definition Classes
    MeasureBuilder
  9. def measuredWith[S](b: (Unit) => S): (S, Quantity[Double])
    Definition Classes
    MeasureBuilder
  10. val measurer: Measurer[Double]
    Definition Classes
    MeasureBuilder
  11. val regen: () => Unit
    Definition Classes
    MeasureBuilder
  12. val resultFunction: (Seq[Quantity[Double]]) => Quantity[Double]
    Definition Classes
    MeasureBuilder
  13. def setUp(b: (Unit) => Unit): MeasureBuilder[Unit, Double]
    Definition Classes
    MeasureBuilder
  14. val setup: (Unit) => Unit
    Definition Classes
    MeasureBuilder
  15. def tearDown(b: (Unit) => Unit): MeasureBuilder[Unit, Double]
    Definition Classes
    MeasureBuilder
  16. val teardown: (Unit) => Unit
    Definition Classes
    MeasureBuilder
  17. val warmer: Warmer
    Definition Classes
    MeasureBuilder
  18. def withMeasurer[V](m: Measurer[V], a: (Seq[Quantity[V]]) => Quantity[V]): MeasureBuilder[Unit, V]
    Definition Classes
    MeasureBuilder
  19. def withMeasurer(m: Measurer[Double]): MeasureBuilder[Unit, Double]
    Definition Classes
    MeasureBuilder
  20. def withTestContext[U](ctx: Context, log: Log, handler: Events)(body: => U): U
  21. def withWarmer(w: Warmer): MeasureBuilder[Unit, Double]
    Definition Classes
    MeasureBuilder
  22. object BasePerformanceTest
  23. object Bench extends Serializable
  24. object CurveData extends Serializable
  25. object DSL
  26. object Executor

    Companion object with default implementations.

  27. object FrameworkKey extends KeyContainer

    Object containing keys specific to the ScalaMeter benchmarking framework.

  28. object Gen extends Serializable
  29. object History extends Serializable
  30. object Main
  31. object Measurement extends Serializable
  32. object Parameters extends Serializable
  33. object Persistor
  34. object PrettyPrinter extends LowPriorityImplicits with Serializable
  35. object Reporter extends Serializable
  36. object api extends Keys

    Import the contents of this singleton object to obtain access to most abstractions in the ScalaMeter API.

    Import the contents of this singleton object to obtain access to most abstractions in the ScalaMeter API.

    Note that some definitions might shadow others, so if you import the contents of this object, you should not import the contents of other packages directly.

    This object contains:

    • basic datatypes and singleton objects for writing tests, such as PerformanceTest
    • all the context map keys
    • contents of the execution package
    • contents of the reporting package
    • contents of the persistence package
    • the Executor.Measurer object
    • the RegressionReporter.Tester object
    • the RegressionReporter.Historian object
    • the ChartReporter.ChartFactory object
    • the HtmlReporter.Renderer object
    • and much more...

Deprecated Value Members

  1. def defaultClasspath: String
    Annotations
    @deprecated
    Deprecated

    (Since version 0.5) Use utils.ClassPath.default

  2. def extractClasspath(classLoader: ClassLoader, default: => String): String
    Annotations
    @deprecated
    Deprecated

    (Since version 0.5) Use utils.ClassPath.extract

Inherited from MeasureBuilder[Unit, Double]

Inherited from AnyRef

Inherited from Any

Ungrouped