nova.core.util

Class Profiler

java.lang.Object

nova.core.util.Profiler

public final class Profiler
extends java.lang.Object

A simple stop watch profiler. All results are in microseconds.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	name Name of this profiler

Constructor Summary

Constructors

Constructor and Description
Profiler(java.lang.String name) Creates new profiler.

Method Summary

Modifier and Type	Method and Description
double	average() Calculates average time between cycles.
Profiler	clearResults() Clears saved results for average computations.
double	elapsed() Measures time since last (lap)start of this profiler.
double	end() Ends current profiling session.
boolean	isRunning() States whether profiler is currently performing time measurements.
double	lap() Helper method for loop time measurements.
double	lastTime() Getter for last cycle time.
java.util.List<java.lang.Double>	results() Getter for lap timing.
Profiler	start() Starts this profiler.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

name

public final java.lang.String name

Name of this profiler

Constructor Detail

Profiler

public Profiler(java.lang.String name)

Creates new profiler.

Parameters:

name - of this profiler.

Method Detail

start

public Profiler start()

Starts this profiler.

Returns:

this for chaining.

Throws:

java.lang.IllegalStateException - if profiler is currently running. See isRunning()

end

public double end()

Ends current profiling session. Saves result for average calculations.

Returns:

time elapsed since last start or lap measured in microseconds.

Throws:

java.lang.IllegalStateException - if profiler is not currently running. See isRunning()

lap

public double lap()

Helper method for loop time measurements. Class end() and then start()

Returns:

time in microseconds previous lap took.

Throws:

java.lang.IllegalStateException - if profiler is not currently running. See isRunning()

isRunning

public boolean isRunning()

States whether profiler is currently performing time measurements.

Returns:

true if profiler is running.

elapsed

public double elapsed()

Measures time since last (lap)start of this profiler.

Returns:

time elapsed since last start or lap measured in microseconds.

Throws:

java.lang.IllegalStateException - if profiler is not currently running. See isRunning()

lastTime

public double lastTime()

Getter for last cycle time.

Returns:

time in seconds between last start-lap/lap-lap/lap-end or start-end cycle.

average

public double average()

Calculates average time between cycles.

Returns:

average time in microseconds.

results

public java.util.List<java.lang.Double> results()

Getter for lap timing.

Returns:

unmodifiable list of elapsed times between cycles.

clearResults

public Profiler clearResults()

Clears saved results for average computations.

Returns:

this for chaining.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object