dev.roanh.cpqkeys

Class ReportSummaryStatistics

java.lang.Object

dev.roanh.cpqkeys.ReportSummaryStatistics

public class ReportSummaryStatistics
extends java.lang.Object

Report summarising a collection of individual runtime reports.

See Also:

RuntimeReport

Field Summary

Fields

Modifier and Type	Field and Description
private Algorithm	algo The algorithm that produced the runtimes for this report summary.
private java.util.LongSummaryStatistics	canonTime Summary of the canonization runtime statistics.
private java.util.LongSummaryStatistics	nativeSetupTime Summary of the native setup runtime statistics.
private java.util.LongSummaryStatistics	otherTime Summary of other runtime statistics.
private java.util.List<RuntimeReport>	reports List of individual runtime reports that make up this summary.
private java.util.LongSummaryStatistics	setupTime Summary of the setup runtime statistics.
private java.util.LongSummaryStatistics	totalTime Summary of the total runtime statistics.

Constructor Summary

Constructors

Constructor and Description
ReportSummaryStatistics(Algorithm algo, GraphDataSet data) Constructs a new summary report by running the given algorithm on the graphs in the given data set.

Method Summary

Modifier and Type	Method and Description
void	addReport(RuntimeReport report) Appends a new report to this summary.
private static java.lang.String	formatNanos(double nanos) Formats the given number of nanoseconds as a string breaking the time up into units of increasing magnitude as required.
double	getCanonizationTimeAverage() Gets the average canonization time for all runtime reports.
double	getCanonizationTimeStdDev() Gets the sample standard deviation for the canonization runtime.
double	getNativeSetupTimeAverage() Gets the average native setup time for all runtime reports.
double	getNativeSetupTimeStdDev() Gets the sample standard deviation for the native setup runtime.
double	getOtherTimeAverage() Gets the average 'other' time for all runtime reports.
double	getOtherTimeStdDev() Gets the sample standard deviation for the 'other' runtime.
java.util.List<RuntimeReport>	getReports() Gets the individual runtime reports that make up this summary.
double	getSetupTimeAverage() Gets the average setup time for all runtime reports.
double	getSetupTimeStdDev() Gets the sample standard deviation for the setup runtime.
double	getTotalTimeAverage() Gets the average total time for all runtime reports.
double	getTotalTimeStdDev() Gets the sample standard deviation for the total runtime.
void	print() Prints a runtime report with all the times formatted together with their sample standard deviation.
void	print(java.io.PrintStream out) Prints a runtime report with all the times formatted together with their sample standard deviation.
private double	stdDev(java.util.LongSummaryStatistics stats, java.util.function.Function<RuntimeReport,java.lang.Long> field) Computes the sample standard deviation of the given field in the data set.
void	writeData(java.io.PrintStream out) Writes the data for this summary 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 that produced the runtimes for this report summary.

reports

private java.util.List<RuntimeReport> reports

List of individual runtime reports that make up this summary.

setupTime

private java.util.LongSummaryStatistics setupTime

Summary of the setup runtime statistics.

nativeSetupTime

private java.util.LongSummaryStatistics nativeSetupTime

Summary of the native setup runtime statistics.

canonTime

private java.util.LongSummaryStatistics canonTime

Summary of the canonization runtime statistics.

otherTime

private java.util.LongSummaryStatistics otherTime

Summary of other runtime statistics.

totalTime

private java.util.LongSummaryStatistics totalTime

Summary of the total runtime statistics.

Constructor Detail

ReportSummaryStatistics

public ReportSummaryStatistics(Algorithm algo,
                               GraphDataSet data)
                        throws java.lang.InterruptedException

Constructs a new summary report by running the given algorithm on the graphs in the given data set.

Parameters:

algo - The algorithm to run.

data - The data set of run the algorithm on.

Throws:

java.lang.InterruptedException - When the current thread is interrupted.

See Also:

Algorithm, GraphDataSet

Method Detail

addReport

public void addReport(RuntimeReport report)
               throws java.lang.IllegalArgumentException

Appends a new report to this summary.

Parameters:

report - The report to append.

Throws:

java.lang.IllegalArgumentException - When the given report was not generated by the same algorithm as the other reports in this summary.

getSetupTimeStdDev

public double getSetupTimeStdDev()

Gets the sample standard deviation for the setup runtime.

Returns:

The sample standard deviation for the setup runtime in nanoseconds.

See Also:

RuntimeReport.getSetupTime()

getSetupTimeAverage

public double getSetupTimeAverage()

Gets the average setup time for all runtime reports.

Returns:

The average setup time in nanoseconds.

See Also:

RuntimeReport.getSetupTime()

getNativeSetupTimeStdDev

public double getNativeSetupTimeStdDev()

Gets the sample standard deviation for the native setup runtime.

Returns:

The sample standard deviation for the native setup runtime in nanoseconds.

See Also:

RuntimeReport.getNativeSetupTime()

getNativeSetupTimeAverage

public double getNativeSetupTimeAverage()

Gets the average native setup time for all runtime reports.

Returns:

The average native setup time in nanoseconds.

See Also:

RuntimeReport.getNativeSetupTime()

getCanonizationTimeStdDev

public double getCanonizationTimeStdDev()

Gets the sample standard deviation for the canonization runtime.

Returns:

The sample standard deviation for the canonization runtime in nanoseconds.

See Also:

RuntimeReport.getCanonizationTime()

getCanonizationTimeAverage

public double getCanonizationTimeAverage()

Gets the average canonization time for all runtime reports.

Returns:

The average canonization time in nanoseconds.

See Also:

RuntimeReport.getCanonizationTime()

getOtherTimeStdDev

public double getOtherTimeStdDev()

Gets the sample standard deviation for the 'other' runtime.

Returns:

The sample standard deviation for the 'other' runtime in nanoseconds.

See Also:

RuntimeReport.getOtherTime()

getOtherTimeAverage

public double getOtherTimeAverage()

Gets the average 'other' time for all runtime reports.

Returns:

The average 'other' time in nanoseconds.

See Also:

RuntimeReport.getOtherTime()

getTotalTimeStdDev

public double getTotalTimeStdDev()

Gets the sample standard deviation for the total runtime.

Returns:

The sample standard deviation for the total runtime in nanoseconds.

See Also:

RuntimeReport.getTotalTime()

getTotalTimeAverage

public double getTotalTimeAverage()

Gets the average total time for all runtime reports.

Returns:

The average total time in nanoseconds.

See Also:

RuntimeReport.getTotalTime()

getReports

public java.util.List<RuntimeReport> getReports()

Gets the individual runtime reports that make up this summary.

Returns:

The individual runtime reports.

print

public void print()

Prints a runtime report with all the times formatted together with their sample standard deviation.

print

public void print(java.io.PrintStream out)

Prints a runtime report with all the times formatted together with their sample standard deviation.

Parameters:

out - The stream to write to.

writeData

public void writeData(java.io.PrintStream out)

Writes the data for this summary 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. Average setup time
2. Setup time standard deviation
3. Average native setup time
4. Native setup time standard deviation
5. Average canonization time
6. Canonization time standard deviation
7. Average other time
8. Other time standard deviation
9. Average total time
10. Total time standard deviation

Parameters:

out - The stream to write to.

formatNanos

private static final java.lang.String formatNanos(double 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 (will be rounded to the nearest long).

Returns:

A formatted string displaying the given nanosecond time.

See Also:

RuntimeReport.formatNanos(long)

stdDev

private double stdDev(java.util.LongSummaryStatistics stats,
                      java.util.function.Function<RuntimeReport,java.lang.Long> field)

Computes the sample standard deviation of the given field in the data set.

Parameters:

stats - Summary statistics of the field to compute the standard deviation for.

field - The field to compute the standard deviation of.

Returns:

The sample standard deviation of the given field.