PerformSparseMatrixKernelMicrobenchmarking {RHPCBenchmark}

Performs microbenchmarking of sparse matrix kernels specified by an input list

Description

PerformSparseMatrixKernelMicrobenchmarking performs microbenchmarking of sparse matrix kernels specified by the input list of SparseMatrixMicrobenchmark objects. Objects with the active flag set to TRUE indicate that the corresponding microbenchmark will be performed; FALSE indicates that the microbenchmark will be skipped. If the matrixObjectName field of an input SparseMatrixMicrobenchmark object is set to NA_character_, then the sparse matrix is assumed to be dynamically generated by the allocator function specified in the allocatorFunction field. If the matrixObjectName field is specified, then the sparse matrix object is expected to be found in an .RData file with base file name the same as the value of matrixObjectName, and located in the either an attached R data package or a directory named data in the current working directory. See the the data package for more details.

Usage

PerformSparseMatrixKernelMicrobenchmarking(microbenchmarks, numberOfThreads,
  runIdentifier, resultsDirectory)

Arguments

microbenchmarks

a list of SparseMatrixMicrobenchmark objects defining the sparse matrix microbenchmarks to be executed as part of the sparse matrix benchmark.

numberOfThreads

the number of threads the microbenchmarks are intended to be executed with; the value is for display purposes only as the number of threads used is assumed to be controlled through environment variables

runIdentifier

a character string specifying the suffix to be appended to the base of the file name of the output CSV format files

resultsDirectory

a character string specifying the directory where all of the CSV performance results files will be saved

Value

a data frame containing the benchmark name, user, system, and elapsed (wall clock) times of each performance trial for each microbenchmark

See Also

data