scalameter

Type Members

sealed trait AbstractPerformanceTest extends AnyRef

Abstract required for the org.scalameter.ScalaMeterFramework to find all performance tests.
abstract class BasePerformanceTest[U] extends AbstractPerformanceTest
abstract class Bench[U] extends DSL[U] with Serializable

Base class for ScalaMeter benchmarks.
case class CurveData[T](measurements: Seq[Measurement[T]], info: Map[Key[_], Any], context: Context) extends Product with Serializable
abstract class DSL[U] extends BasePerformanceTest[U]
class Errors[T] extends AnyRef
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.
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.
trait GroupedPerformanceTest extends BasePerformanceTest[Nothing]
case class History[V](results: Seq[Entry[V]], infomap: Map[Key[_], Any] = Map.empty) extends Product with Serializable

Annotations
@SerialVersionUID()
type KeyValue = (Key[T], T) forSome {type T}
sealed trait LowPriorityImplicits extends AnyRef
case class Measurement[T](value: T, params: Parameters, data: MeasurementData[T], units: String)(implicit evidence$1: Pickler[T]) extends Product with Serializable

Annotations
@SerialVersionUID()
case class Parameter[T](fullName: String)(implicit evidence$1: Pickler[T]) extends PicklerBasedKey[T] with Product with Serializable
case class Parameters(axisData: Map[Parameter[_], Any]) extends Product with Serializable

Annotations
@SerialVersionUID()
trait Persistor extends AnyRef

Persistors are used to store historical data about benchmark runs.
trait PrettyPrinter[T] extends Serializable

Pretty prints values.
Pretty prints values.
The default implementation simply calls toString method.
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.
class ScalaMeterFramework extends Framework
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

object BasePerformanceTest
object Bench extends Serializable
object CurveData extends Serializable
object DSL
object Executor

Companion object with default implementations.
object FrameworkKey extends KeyContainer

Object containing keys specific to the ScalaMeter benchmarking framework.
object Gen extends Serializable
object History extends Serializable
object Main
object Measurement extends Serializable
object Parameters extends Serializable
object Persistor
object PrettyPrinter extends LowPriorityImplicits with Serializable
object Reporter extends Serializable
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...
def config(kvs: KeyValue*): MeasureBuilder[T, U]

Definition Classes
MeasureBuilder
val ctx: Context

Definition Classes
MeasureBuilder
def currentContext: Context
def events: Events
package execution
package japi
def log: Log
def measure[S](b: ⇒ S): Quantity[U]

Definition Classes
MeasureBuilder
def measureWith[S](b: (T) ⇒ S): Quantity[U]

Definition Classes
MeasureBuilder
val measurer: Measurer[U]

Definition Classes
MeasureBuilder
package persistence
val regen: () ⇒ T

Definition Classes
MeasureBuilder
package reporting
val resultFunction: (Seq[Quantity[U]]) ⇒ Quantity[U]

Definition Classes
MeasureBuilder
def setUp(b: (T) ⇒ Unit): MeasureBuilder[T, U]

Definition Classes
MeasureBuilder
val setup: (T) ⇒ Unit

Definition Classes
MeasureBuilder
def tearDown(b: (T) ⇒ Unit): MeasureBuilder[T, U]

Definition Classes
MeasureBuilder
val teardown: (T) ⇒ Unit

Definition Classes
MeasureBuilder
package utils
val warmer: Warmer

Definition Classes
MeasureBuilder
def withMeasurer[V](m: Measurer[V], a: (Seq[Quantity[V]]) ⇒ Quantity[V]): MeasureBuilder[T, V]

Definition Classes
MeasureBuilder
def withMeasurer(m: Measurer[U]): MeasureBuilder[T, U]

Definition Classes
MeasureBuilder
def withTestContext[U](ctx: Context, log: Log, handler: Events)(body: ⇒ U): U
def withWarmer(w: Warmer): MeasureBuilder[T, U]

Definition Classes
MeasureBuilder

Deprecated Value Members

def defaultClasspath: String

Annotations
@deprecated
Deprecated
(Since version 0.5) Use utils.ClassPath.default
def extractClasspath(classLoader: ClassLoader, default: ⇒ String): String

Annotations
@deprecated
Deprecated
(Since version 0.5) Use utils.ClassPath.extract

package scalameter

Type Members

sealed trait AbstractPerformanceTest extends AnyRef

abstract class BasePerformanceTest[U] extends AbstractPerformanceTest

abstract class Bench[U] extends DSL[U] with Serializable

case class CurveData[T](measurements: Seq[Measurement[T]], info: Map[Key[_], Any], context: Context) extends Product with Serializable

abstract class DSL[U] extends BasePerformanceTest[U]

class Errors[T] extends AnyRef

trait Executor[V] extends AnyRef

abstract class Gen[T] extends Serializable

trait GroupedPerformanceTest extends BasePerformanceTest[Nothing]

case class History[V](results: Seq[Entry[V]], infomap: Map[Key[_], Any] = Map.empty) extends Product with Serializable

type KeyValue = (Key[T], T) forSome {type T}

sealed trait LowPriorityImplicits extends AnyRef

case class Measurement[T](value: T, params: Parameters, data: MeasurementData[T], units: String)(implicit evidence$1: Pickler[T]) extends Product with Serializable

case class Parameter[T](fullName: String)(implicit evidence$1: Pickler[T]) extends PicklerBasedKey[T] with Product with Serializable

case class Parameters(axisData: Map[Parameter[_], Any]) extends Product with Serializable

trait Persistor extends AnyRef

trait PrettyPrinter[T] extends Serializable

trait Reporter[T] extends Serializable

class ScalaMeterFramework extends Framework

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

object BasePerformanceTest

object Bench extends Serializable

object CurveData extends Serializable

object DSL

object Executor

object FrameworkKey extends KeyContainer

object Gen extends Serializable

object History extends Serializable

object Main

object Measurement extends Serializable

object Parameters extends Serializable

object Persistor

object PrettyPrinter extends LowPriorityImplicits with Serializable

object Reporter extends Serializable

object api extends Keys

def config(kvs: KeyValue*): MeasureBuilder[T, U]

val ctx: Context

def currentContext: Context

def events: Events

package execution

package japi

def log: Log

def measure[S](b: ⇒ S): Quantity[U]

def measureWith[S](b: (T) ⇒ S): Quantity[U]

val measurer: Measurer[U]

package persistence

val regen: () ⇒ T

package reporting

val resultFunction: (Seq[Quantity[U]]) ⇒ Quantity[U]

def setUp(b: (T) ⇒ Unit): MeasureBuilder[T, U]

val setup: (T) ⇒ Unit

def tearDown(b: (T) ⇒ Unit): MeasureBuilder[T, U]

val teardown: (T) ⇒ Unit

package utils

val warmer: Warmer

def withMeasurer[V](m: Measurer[V], a: (Seq[Quantity[V]]) ⇒ Quantity[V]): MeasureBuilder[T, V]

def withMeasurer(m: Measurer[U]): MeasureBuilder[T, U]

def withTestContext[U](ctx: Context, log: Log, handler: Events)(body: ⇒ U): U

def withWarmer(w: Warmer): MeasureBuilder[T, U]

Deprecated Value Members

def defaultClasspath: String

def extractClasspath(classLoader: ClassLoader, default: ⇒ String): String

Inherited from MeasureBuilder[Unit, Double]

Inherited from AnyRef

Inherited from Any

Ungrouped