report

Open code execution profiling report and specify display of time measurements

Syntax

report(myExecutionProfile)

report(myExecutionProfile, name-value pair)

Description

report(myExecutionProfile) opens the code execution profiling report using default display options.

report(myExecutionProfile, name-value pair) opens the report with display options specified by the name-value character vector pairs.

Examples

Create Report by Using Options

To create a report that displays time in microseconds (10^-6 seconds) with a precision of three decimal places, select options by using name-value pairs.

report(myExecutionProfile, ...
    'Units','Seconds', ...
    'ScaleFactor','1e-06', ...
    'NumericFormat','%0.3f')

Create Report Comparing Against Baseline

To create a report that compares execution-time performance against a baseline, use the baseline option.

report(myExecutionProfile, ...
    'baseline', executionProfileBaseline)

Input Arguments

myExecutionProfile — Variable specifies annotation

workspace variable

myExecutionProfile is a workspace variable, specified through the configuration parameter CodeExecutionProfileVariable and generated by a simulation.

Example: myExecutionProfile

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: 'Units','Seconds'

Units — Time measurement unit

'Seconds' (default for SIL simulation on Windows^®) | 'Ticks' (default for SIL simulation on non-Windows and PIL simulation unless overridden to 'Seconds' by number of ticks per second in the target connectivity configuration)

Time measurements displayed in seconds or timer ticks.

Example: 'Units','Seconds'

ScaleFactor — Scale factor for displayed measurements

'1e-9' (default) | character vector representation of a number that is a power of 10

To display measurements in microseconds, use a scale factor name-value pair 'ScaleFactor', '1e-6'. The value must be a character vector representation of a number that is a power of 10. For example, '1', '1e-6', or '1e-9'. Default value is '1e-9'. To specify the scale factor, you must also specify 'Units', 'Seconds'.

Example: 'ScaleFactor','1e-9'

NumericFormat — Numeric format for displayed measurements

'%0.0f' (default) | decimal convention utilized by the ANSI C fallback for ANSI C function sprintf

Use the decimal convention utilized by the ANSI^® C function sprintf, for example, '%1.2f'. Default is '%0.0f'. To specify the numeric format, you must also specify 'Units', 'Seconds'.

Example: 'NumericFormat','%0.0f'

baseline — Baseline for performance comparison

executionProfileBaseline

The executionProfileBaseline is the workspace variable that contains baseline execution-time metrics.

Example: 'baseline',executionProfileBaseline

Version History

Introduced in R2011b