Inheritance diagram for mxberry::dev::prof::ProfileManager:

Collaboration diagram for mxberry::dev::prof::ProfileManager:

Public Member Functions
function	ProfileManager (in profMode, in profDir)
	ProfileManager performs a command execution and displaying the profiling results Input: optional: profileMode: char [1,] - profiling mode, the following modes are supported: 'none'/'off' - no profiling 'viewer' - profiling reports are just displayed 'file' - profiling reports are displayed and saved to the file profileDir: char [1,] - name of directory in which profiling reports are to be saved. More...

function	runAndProcess (in self, in fRun, in varargin)
	RUNANDPROCESS executes the specified command and generates a profiling report using the specified name as a marker. More...

function	profSave (in SProfileInfo, in dirName)
	PROFSAVE does the same as the built-in `profsave` function except for displaying the saved report in the browser. More...

function	profView (in varargin)
	PROFVIEW enhances a functionality of Matlab built-in function profview by allowing to display several profiler windows simultaneously and specify a title for each window. Having multiple profiler windows is useful for performance comparison. More...

function	createBrowser ()

Private Attributes
Property	profMode

Property	profDir

Detailed Description

Author: Peter Gagarinov, PhD pgaga.nosp@m.rino.nosp@m.v@gma.nosp@m.il.c.nosp@m.om

Copyright: 2015-2016 Peter Gagarinov, PhD
2012-2015 Moscow State University,
Faculty of Applied Mathematics and Computer Science,
System Analysis Department

Definition at line 7 of file ProfileManager.m.

Constructor & Destructor Documentation

◆ ProfileManager()

function mxberry::dev::prof::ProfileManager::ProfileManager	(	in	profMode,
		in	profDir
	)

ProfileManager performs a command execution and displaying the profiling results Input: optional: profileMode: char [1,] - profiling mode, the following modes are supported: 'none'/'off' - no profiling 'viewer' - profiling reports are just displayed 'file' - profiling reports are displayed and saved to the file profileDir: char [1,] - name of directory in which profiling reports are to be saved.

*  Output:
*    self: constructed object
*

Author: Peter Gagarinov, PhD pgaga.nosp@m.rino.nosp@m.v@gma.nosp@m.il.c.nosp@m.om

Copyright: 2015-2016 Peter Gagarinov, PhD
2015 Moscow State University
Faculty of Computational Mathematics and Computer Science
System Analysis Department

Member Function Documentation

◆ createBrowser()

function mxberry::dev::prof::ProfileManager::createBrowser ( )

◆ profSave()

function mxberry::dev::prof::ProfileManager::profSave	(	in	SProfileInfo,
		in	dirName
	)

PROFSAVE does the same as the built-in profsave function except for displaying the saved report in the browser.

*  Input:
*    regular:
*        SProfileInfo: struct[1,1] - structure generated by profile('info')
*            call
*    optional:
*        dirName: char[1,] - name of directory for storing the profiling
*            results in form of a set of HTML files. If not specified
*            "profile_results" subdirectory of current directory is used.
*

Author: Peter Gagarinov, PhD pgaga.nosp@m.rino.nosp@m.v@gma.nosp@m.il.c.nosp@m.om

Copyright: 2015-2016 Peter Gagarinov, PhD
2015 Moscow State University,
Faculty of Computational Mathematics and Computer Science,
System Analysis Department

◆ profView()

function mxberry::dev::prof::ProfileManager::profView ( in varargin )

PROFVIEW enhances a functionality of Matlab built-in function profview by allowing to display several profiler windows simultaneously and specify a title for each window. Having multiple profiler windows is useful for performance comparison.

/// Input:
///   optional:
///       functionName char[1,]/numeric[1,1] - a name or an index number into
///          the profile (see built-in profview's help for more details)
///
///       profileInfo struct[1,1] - structure returned by profile('info')
///
///   properties:
///       titlePrefix: char[1,] - title for profiler report
///       keepCache: logical[1,1] - if true, cache profiling reports are kept
///          intact and overriden for the same cacheKey otherwise, false by default
///       cacheKey: char[1,] - key used to extract profile info structure and
///           activeBrowser window from the cache
///
/// Output:
///   activeBrowser: com.mathworks.mde.webbrowser.WebBrowser[1,1] - browser
///       in which the report is displayed.
///

Author: Peter Gagarinov, PhD pgaga.nosp@m.rino.nosp@m.v@gma.nosp@m.il.c.nosp@m.om

Copyright: 2015-2016 Peter Gagarinov, PhD
2015 Moscow State University,
Faculty of Computational Mathematics and Computer Science,
System Analysis Department

◆ runAndProcess()

function mxberry::dev::prof::ProfileManager::runAndProcess	(	in	self,
		in	fRun,
		in	varargin
	)

RUNANDPROCESS executes the specified command and generates a profiling report using the specified name as a marker.

*  Input:
*    regular:
*        self:
*        fRun: function_handle[1,] - function to execute
*    optional:
*        profCaseName: char[1,] - name of profiling case
* 
*    properties:
*        nRuns: numeric[1,1] - number of runs (1 by default)
*        useMedianTime: logical [1,1] - if true, then median
*            time of calculation is returned for all runs
*

Author: Peter Gagarinov, PhD pgaga.nosp@m.rino.nosp@m.v@gma.nosp@m.il.c.nosp@m.om

Copyright: 2015-2016 Peter Gagarinov, PhD
2015 Moscow State University
Faculty of Computational Mathematics and Computer Science
System Analysis Department

Member Data Documentation

◆ profDir

Property mxberry::dev::prof::ProfileManager::profDir

private

Definition at line 14 of file ProfileManager.m.

◆ profMode

Property mxberry::dev::prof::ProfileManager::profMode