org.bitbucket.inkytonik.dsprofile

Profiler

object Profiler extends Profiler

The default profiler, useful for testing via the REPL.

Source
Profiler.scala
Linear Supertypes
Profiler, Values, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Profiler
  2. Profiler
  3. Values
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. case class Record(stime: Long, dimensions: Dimensions)(dirDescs: List[Record], allDescs: List[Record]) extends Product with Serializable

    A record of execution of some particular type of action during profiling.

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def checkFor(record: Record, dim: Dimension, eventtype: String, needed: Dimension)(f: (Value) ⇒ Value): Value

    Check for an intrinsic dimension needed on record, while looking for a value of the derived dimension dim.

    Check for an intrinsic dimension needed on record, while looking for a value of the derived dimension dim. If needed is found, get its value and pass it to f, using the f's return value as the value of the dim dimension. Otherwise, use error to report the missing dimension. If eventtype is empty, accept any event.

    Definition Classes
    Values
  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  9. def dimValue(record: Record, dim: Dimension): Value

    Given a record, an event type and a dimension name, return the value of the record at that dimension.

    Given a record, an event type and a dimension name, return the value of the record at that dimension. This implementation provides standard derived dimensions and defaults to just looking up intrinsic dimensions. The supported derived dimensions are: type (the prefix of a Product given by the record's subject dimension).

    Definition Classes
    ProfilerValues
  10. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  12. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  13. def finishReport(): Unit

    Called when the report writing is about to finish.

    Called when the report writing is about to finish. By default this method does nothing.

    Definition Classes
    Values
  14. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  15. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  16. def includeTimings: Boolean

    Return true if the profile tables should include timings.

    Return true if the profile tables should include timings. Default: yes.

    Definition Classes
    Profiler
  17. def isEventType(record: Record, eventtype: String): Boolean

    Check the event type of a record by looking for its event intrinsic dimension and comparing to the given event string.

    Check the event type of a record by looking for its event intrinsic dimension and comparing to the given event string. Return true if it is of the given event type, false otherwise.

    Definition Classes
    Values
  18. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  19. def nanoToMs(nano: Long): Long

    Convert a nanoTime difference to ms.

    Convert a nanoTime difference to ms.

    Definition Classes
    Profiler
  20. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  23. def output(str: String): Unit

    Send string to the profile output.

    Send string to the profile output.

    Definition Classes
    Values
  24. def outputln(str: String = ""): Unit

    Send string and a newline to the profile output.

    Send string and a newline to the profile output. Default: print an empty line.

    Definition Classes
    Values
  25. def parseProfileOption(value: String): Seq[Dimension]

    Process a profiling command-line option value.

    Process a profiling command-line option value. By convention we use the -p option to introduce this value, but that is not checked here and the option itself should not be present in the value. The option value is interpreted as a comma-separated list of dimension names. The list of names is returned. If the inupt value is the empty strnig, we return an empty sequence, not a sequence containing an empty string.

    Definition Classes
    Profiler
  26. def percent(v: Long, total: Long): String

    Definition Classes
    Profiler
  27. def printReports(totalTime: Long, dimensionNames: Seq[Dimension], records: List[Record]): Unit

    Print the profiling report by summarising along the requested dimensions.

    Print the profiling report by summarising along the requested dimensions. FIXME: avoid multiple passes through the data?

    Definition Classes
    Profiler
  28. var printTables: Boolean

    Whether or not to print the profile tables.

    Whether or not to print the profile tables. Some special profile dimensions produce their own output rather than using the default table style. They can turn this flag off in the startReport method to inhibit the default output.

    Definition Classes
    Values
  29. def profile[T](computation: ⇒ T, dimensionNames: Dimension*): T

    Profile computation along the given dimensions and produce reports.

    Profile computation along the given dimensions and produce reports. If dimensionsNames is empty, run the computation and then enter an interactive shell to allow reports to be produced.

    Definition Classes
    Profiler
  30. def profileStart(): Unit

    Start profiling by turning on the profiling system, resetting the events buffer and recording the start time.

    Start profiling by turning on the profiling system, resetting the events buffer and recording the start time.

    Definition Classes
    Profiler
  31. def profileStop(): (Seq[Dimension]) ⇒ Unit

    Stop profiling by turning off the profiling system and recording the total execution time.

    Stop profiling by turning off the profiling system and recording the total execution time. Return a function that can be used to generate a profile report when given the relevant dimension names.

    Definition Classes
    Profiler
  32. def profileStop(dimensionNames: Seq[Dimension]): Unit

    Stop profiling and generate a profile report for the given dimension names.

    Stop profiling and generate a profile report for the given dimension names.

    Definition Classes
    Profiler
  33. def profileStopInteractive(): Unit

    Stop profiling and generate profile reports based on interactively specified dimensions.

    Stop profiling and generate profile reports based on interactively specified dimensions.

    Definition Classes
    Profiler
  34. def startReport(dimensionNames: Seq[Dimension]): Unit

    Called when the report writing is about to start.

    Called when the report writing is about to start. By default this method does nothing. The method is passed the dimension names that have been requested so that can react to them.

    Definition Classes
    Values
  35. var startTime: Long

    Definition Classes
    Profiler
  36. def summariseAlongDims(dimensionNames: Seq[Dimension], records: List[Record], nrecords: Int, profiledTime: Long): Unit

    Summarise attribute evaluations along a list of dimensions.

    Summarise attribute evaluations along a list of dimensions.

    Definition Classes
    Profiler
  37. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  38. def time[T](computation: ⇒ T, warmup: Int = 10, n: Int = 24, discard: Int = 2): Unit

    Run computation and report timings.

    Run computation and report timings. computation is first run init times to warm up the JVM. Then it is run n more times. The discard biggest and smallest values are then discarded and the resulting values are printed.

    Definition Classes
    Profiler
  39. def toString(): String

    Definition Classes
    AnyRef → Any
  40. def trace(predicate: (Event) ⇒ Boolean = _ => true): Unit

    Print a trace of the events for which a given predicate is true.

    Print a trace of the events for which a given predicate is true. If the predicate is omitted it defaults to one that is always true.

    Definition Classes
    Profiler
  41. def valueToString(a: Value): String

    Convert an arbitrary value to a string using toString.

    Convert an arbitrary value to a string using toString. Override this method to customise how values are shown.

    Definition Classes
    Values
  42. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  43. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  44. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from Profiler

Inherited from Values

Inherited from AnyRef

Inherited from Any

Ungrouped