Profile Detail Report :: Tuning and Managing M-Files (Desktop Tools and Development Environment)

Desktop Tools and Development Environment

Profile Detail Report

The Profile Detail report shows profiling results for a selected function that was called during profiling. A Profile Detail report is made up of seven sections, summarized below. By default, the Profile Detail report includes all seven sections, although, depending on the function, not every section contains data. You can customize the display to include only sections you are interested in--see Controlling the Contents of the Detail Report Display. The following sections provide more detail about each section:

Profile Detail Report Header -- Provides general information about the function.
Parent Files -- Provides information about the parent function.
Busy Lines -- Lists the lines in the function that used the greatest amount of processing time.
Child Files -- Lists the functions called by this function, with links to Profile Detail reports for these functions.
M-Lint Results -- Lists the lines in the functions that M-lint highlighted.
File Coverage -- Provides statistics about the lines of code in the function that executed while profiling was on.
File Listing -- Includes the source code for the function, if it is an M-file.

To return to the Profile Summary report from the Profile Detail report, click the Home button in the toolbar.

Controlling the Contents of the Detail Report Display

You can determine which sections are included in the display by selecting them and then clicking the Refresh button. The following sections provide more detail about each section of this report.

Image of Profiler detail report and options for it.

Profile Detail Report Header

The detail report header includes the name of the function that was profiled, the number of times it was called in the parent function, and the amount of time it used.

The header includes a link that opens the function in your default text editor.

The header also includes a link that copies the report to a separate window. Creating a copy of the report can be helpful when you make changes to the file, run the Profiler for the updated file, and compare the Profile Detail reports for the two runs. Do not make changes to M-files provided with MathWorks products, that is, files in $matlabroot/toolbox directories.

Image of header in the Profile detail report, highlighting main features. Click the M-function in file link to the file in the default editor. Click Copy to new window to copy the detail report to a new window.

Parent Files

To include the Parents section in the detail report, select the Show parent files check box. This section of the report provides information about the parent functions, with links to their detail reports.

$Image of Profile detail report showing parents (calling functions). Click a filename to show that parent file\xd5 s detail report.$

Busy Lines

To include information about the lines of code that used the most amount of processing time in the detail report, select the Show busy lines check box. Click a line number to view that line of code in the source listing.

Image of Profile detail report with Show busy lines selected. Five lines are shown, and there is an entry for other lines and overhead. Click one of the lines to go to that line in the file.

Child Files

To include the Children section of the detail report, select the Show child files check box. This section of the report lists all the functions called by the profiled function. If the called function is an M-file, you can view the source code for the function by clicking on its name.

Image of children portion of Profile detail report.

M-Lint Results

To include the M-Lint results section in the detail report display, select the Show M-Lint results check box. This section of the report provides information generated by M-Lint about the function.

Image of Profile detail report showing M-Lint results section.

File Coverage

To include the Coverage results section in the detail report display, select the Show file coverage check box. This section of the report provides statistical information about the number of lines in the code that executed during the profile run.

Image of Profile report showing file coverage secton.

File Listing

To include the File listing section in the detail report display, select the Show file listing check box. If the file is an M-file, the Profile Detail report includes a column listing the execution time for a particular line, a column listing the number of times the line was called, and the source code for the function.

In the file listing, comment lines appear in green, lines of code that executed appear in black, and lines of code that did not execute appear in gray. If you click a function name in the listing, you can view its detail report.

By default, the Profile Detail report uses color to highlight the lines of code with the longest execution time. The darker the shade of color, the longer the line of code took to execute. Using the menu in this section of the detail report you can change this default and choose to highlight other lines of code in the listing, such as the lines called the most, lines called out by M-Lint, or lines of code that were (or were not) executed. Using this menu, you can also turn off highlighting completely.

Image of Profile detail report with File listing section shown.

Profile Summary Report The profile Function