dev.roanh.cpqkeys

Class RuntimeReport

java.lang.Object

dev.roanh.cpqkeys.RuntimeReport

public class RuntimeReport
extends java.lang.Object

Report summarising various runtimes about an algorithm

See Also:

Algorithm

Field Summary

Fields

Modifier and Type	Field and Description
private Algorithm	algo The algorithm these runtimes were measured for.
private long	canonTime Canonization time for the algorithm (nanoseconds)
private long	nativeSetupTime Native setup time for the algorithm (nanoseconds).
private long	setupTime Setup time for the algorithm (nanoseconds).
private long	totalTime Raw execution time (nanoseconds).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RuntimeReport(Algorithm algo, long[] times, long total) Constructs a new runtime report for the given algorithm with the given runtime information.

Method Summary

Modifier and Type	Method and Description
protected static java.lang.String	formatNanos(long nanos) Formats the given number of nanoseconds as a string breaking the time up into units of increasing magnitude as required.
Algorithm	getAlgorithm() Gets the algorithm that was executed to generate this report.
long	getCanonizationTime() Gets the time spent by the algorithm computing the canonical representation of the input graph.
long	getNativeSetupTime() Gets the time spent on the side of the native implementation preparing all the input data for the canonization step.
long	getOtherTime() Gets the total time spend on other tasks.
long	getSetupTime() Gets the time spent Java side transforming the input CPQ query graph into a form suitable for the algorithm.
long	getTotalTime() Gets the total time spent running the Algorithm.time(dev.roanh.gmark.util.Graph) method.
void	print() Prints a runtime report with all the times formatted.
void	print(java.io.PrintStream out) Prints a runtime report with all the times formatted.
void	writeData(java.io.PrintStream out) Writes the data for this report as a single line to the given stream.

Methods inherited from class java.lang.Object

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

Field Detail

algo

private Algorithm algo

The algorithm these runtimes were measured for.

setupTime

private long setupTime

Setup time for the algorithm (nanoseconds).

nativeSetupTime

private long nativeSetupTime

Native setup time for the algorithm (nanoseconds).

canonTime

private long canonTime

Canonization time for the algorithm (nanoseconds)

totalTime

private long totalTime

Raw execution time (nanoseconds).

Constructor Detail

RuntimeReport

protected RuntimeReport(Algorithm algo,
                        long[] times,
                        long total)

Constructs a new runtime report for the given algorithm with the given runtime information.

Parameters:

algo - The algorithm that was execute.

times - An array with runtimes, the array is expected to contain in order the setup time native setup time and lastly the canonization time. All times are expected to be in nanoseconds.

total - The total number of nanoseconds spent executing the algorithm and all associated transforms.

Method Detail

getSetupTime

public long getSetupTime()

Gets the time spent Java side transforming the input CPQ query graph into a form suitable for the algorithm. This includes transforms that transform the input into a form that can be passed to the algorithm. Major time sinks for this setup include graph transforms to make the graph undirected or without edge labels and the transform to turn the graph into a coloured graph.

Returns:

The setup time for this algorithm run in nanoseconds.

getNativeSetupTime

public long getNativeSetupTime()

Gets the time spent on the side of the native implementation preparing all the input data for the canonization step. The major time sink for this step is reading the input graph into proper data structures.

Returns:

The native setup time for this algorithm run in nanoseconds.

getCanonizationTime

public long getCanonizationTime()

Gets the time spent by the algorithm computing the canonical representation of the input graph.

Returns:

The total canonization time in nanoseconds.s

getTotalTime

public long getTotalTime()

Gets the total time spent running the Algorithm.time(dev.roanh.gmark.util.Graph) method.

Returns:

The total runtime for this algorithm in nanoseconds.

getOtherTime

public long getOtherTime()

Gets the total time spend on other tasks. In general this is the total execution time minus the setup time, native setup time and canonization time. Main contributors to this measurement are JNI calls, Python startup times and general function calls.

Returns:

The time spent on other tasks for this algorithm run in nanoseconds.

getAlgorithm

public Algorithm getAlgorithm()

Gets the algorithm that was executed to generate this report.

Returns:

The algorithm for this report.

print

public void print()

Prints a runtime report with all the times formatted.

print

public void print(java.io.PrintStream out)

Prints a runtime report with all the times formatted.

Parameters:

out - The stream to write to.

writeData

public void writeData(java.io.PrintStream out)

Writes the data for this report as a single line to the given stream. The data will be separated by spaces and the following numbers will be written in order:

1. Setup time
2. Native setup time
3. Canonization time
4. Other time
5. Total time

Parameters:

out - The stream to write to.

formatNanos

protected static final java.lang.String formatNanos(long nanos)

Formats the given number of nanoseconds as a string breaking the time up into units of increasing magnitude as required. The used splits are, nanoseconds, milliseconds, seconds and minutes.

Parameters:

nanos - The nanosecond time to format.

Returns:

A formatted string displaying the given nanosecond time.