PrintSparseMatrixMicrobenchmarkResults: Prints results of a sparse matrix microbenchmark

Description Usage Arguments Details

View source: R/benchmarking_utils.R

Description

PrintSparseMatrixMicrobenchmarkResults prints performance results for a sparse matrix microbenchmark to standard output in a format that is easily human readable

Usage

1
2
3
PrintSparseMatrixMicrobenchmarkResults(benchmarkName, numberOfThreads,
  numberOfRows, numberOfColumns, numberOfNonzeros, numberOfSuccessfulTrials,
  trialTimes, averageWallClockTimes, standardDeviations)

Arguments

benchmarkName

character string specifying the name of the microbenchmark

numberOfThreads

the number of threads all of the performance trials were conducted with

numberOfRows

the number of expected rows in the matrix; assumed to be greater than zero

numberOfColumns

the number of expected columns in the matrix; assumed to be greater than zero

numberOfNonzeros

the number of non-zero elements in the matrix

numberOfSuccessfulTrials

an integer vector specifying the number of performance trials that were successfully performed for each matrix tested

trialTimes

a real matrix with each column containing the run times of all of the successful performance trials associated with a particular matrix. The number of valid entries in each column are specified by the entries in the numberOfSuccessfulTrials vector

averageWallClockTimes

a vector of average wall clock times computed for each matrix tested during the performance trials

standardDeviations

a vector of standard deviations of the wall clock times obtained for each matrix tested during the performance trials

Details

This function prints the run time performance results obtained by a sparse matrix microbenchmark for matrices of various dimensions. The summary statistics include the minimum, maximum, average, and standard deviation of the wall clock times obtained by the performance trials with respect to each matrix tested.


RHPCBenchmark documentation built on May 2, 2019, 6:40 a.m.