ANTAREX API

Clava API

LARA API

LARA Common Language API

(.js)
laraImport("clava.memoi.MemoiProf");

(.lara)
import clava.memoi.MemoiProf;

MemoiProf

Constructor

MemoiProf

new MemoiProf(targetSig, id, reportDir, target)

Library to instrument applications with the memoiprof profiling
library.

Parameters

targetSig: string - the signature of the target funtion
id: string - unique ID representing this function
reportDir: string - path to the directory where the report will be saved (does not need trailing /)
target: any

Instance Members

profAll

profAll()

Profiles all calls of the target function. This includes making a single
wrapper for all calls and adding the memoization profiling code inside this
wrapper.


profEach

profEach()

Profiles each call to the target function separately. This includes
making a wrapper for each call and adding the memoization profiling code
inside the wrapper.


setApprox

setApprox(approxKind, approxBits)

Parameters

approxKind: any
approxBits: any

setCulling

setCulling(cullingKind, cullingRatio)

Parameters

cullingKind: any
cullingRatio: any

setPeriodicReporting

setPeriodicReporting(periodicReportKind, periodicReportRate)

Parameters

periodicReportKind: any
periodicReportRate: any

setSampling

setSampling(samplingKind, samplingRate)

Parameters

samplingKind: any
samplingRate: any

MemoiprofOptions

Constructor

MemoiprofOptions

new MemoiprofOptions()

Class used to store memoiprof options.


Instance Members

setApprox

setApprox(approxKind, approxBits)

Supported approxKind values are: true, false.

Parameters

approxKind: any
approxBits: any

setCulling

setCulling(cullingKind, cullingRatio)

Supported cullingKind values are: true, false.
cullingRatio is the threshold (% of calls) for printing to the JSON.

Parameters

cullingKind: any
cullingRatio: any

setPeriodicReporting

setPeriodicReporting(periodicReportKind, periodicReportRate)

Supported periodicReportKind values are: true, false.
periodicReportRate is the number of calls between writes of periodic reports.

Parameters

periodicReportKind: any
periodicReportRate: any

setSampling

setSampling(samplingKind, samplingRate)

Supported samplingKind values are: 'random', 'fixed', 'off'.
For 1/x sampling, samplingRate should be x.

Parameters

samplingKind: any
samplingRate: any