SparseMatrixMicrobenchmark {RHPCBenchmark}

This class specifies a sparse matrix microbenchmark.

Description

This class specifies a sparse matrix microbenchmark.

Fields

active

a logical indicating whether the microbenchmark is to be executed (TRUE) or not (FALSE).

benchmarkName

a character string that is the name of the microbenchmark.

benchmarkDescription

a character string describing the microbenchmark.

matrixObjectName

a character string specifying the name of the sparse matrix object that is input to the benchmark; the object must be stored in the R data file with name matrixObjectName.RData Setting the field to NA_character_ indicates that the test data will be generated dynamically by the function given in the allocatorFunction field instead of read from a data file.

numberOfRows

an integer specifying the expected number of rows in the input sparse matrix.

numberOfColumns

an integer specifying the expected number of columns in the input sparse matrix.

numberOfNonzeros

an integer specifying the expected number of nonzeros in the input sparse matrix.

numberOfTrials

an integer vector specifying the number of performance trials conducted for each matrix to be tested.

numberOfWarmupTrials

an integer vector specifying the number of warmup trials to be performed for each matrix to be tested.

allocatorFunction

the function that allocates and initializes input to the benchmark function. The function takes a SparseMatrixMicrobenchmark object and an integer index indicating which matrix parameter from numberOfRows, numberOfColumns, and numberOfNonzeros should be used to generate the matrix.

benchmarkFunction

the benchmark function which executes the functionality to be timed. The function takes a SparseMatrixMicrobenchmark and a list of kernel parameters returned by the allocator function.