CommonFunctions Class Reference

A class containing common basic functionalities. More...

Inheritance diagram for CommonFunctions:

Public Member Functions
function	diagInv (A)
	Calculates the diagonal part of the inverse of a sparse matrix. More...
function	eig (A, B)
	Calculates the generalized eigenvalue problem based on the zggev and dggev LAPACK functions. More...
function	getProgramName ()
	Gets the name of the package. More...
function	getProgramShortName ()
	Gets the short name of the package. More...
function	getVersion ()
	Gets the current version of the package. More...
function	IsDeployedMKL ()
	Checks whether the MKL component is deployed. More...
function	partialInv (A, sizeInv)
	Calculates a partial inverse of a sparse matrix. More...
function	xmlread (filename)
	Function to load XML files (based on xerces libraries), providing octave compatibility. More...
function	xmlwrite (filename, DOM)
	Function to export XML files (based on xerces libraries), providing octave compatibility. More...

Static Public Member Functions
static function	checkMEXfile (fncname)
	Checks the presence of a given MEX file. More...
static function	inv_SVD (A)
	Inverts badly conditioned matrix A with SVD regularization. More...
static function	isOctave ()
	Checks whether the running environment is matlab or octave. More...
static function	SimphsonInt (y, h)
	Simphson integral: y is a vector of function values at equal distant points: y_i = f(x_i), x_i-x_{i-1}=h. More...

Protected Attributes
Property	DeployedMKL
	True if MKL component is built, false otherwise. More...
Property	MaxSize
	Maximal size of full matrixes to be handled. More...
Property	ProgramName
	Name of the package. More...
Property	ProgramShortName
	Short name of the package. More...
Property	version
	The current version of the package. More...

Detailed Description

A class containing common basic functionalities.

Definition at line 24 of file CommonFunctions.m.

Member Function Documentation

checkMEXfile()

static function CommonFunctions::checkMEXfile ( fncname  )

static

Checks the presence of a given MEX file.

Parameters

fncname

The name of the function.

Returns

Returns true if the MEX file is present, false otherwise.

diagInv()

function CommonFunctions::diagInv

(

A

)

Calculates the diagonal part of the inverse of a sparse matrix.

If MKL component is advised to build.

Parameters

A	A sparse matrix to be inverted

Returns

Returns the diagonal elements of the inverse

eig()

function CommonFunctions::eig	(	A	,
		B
	)

Calculates the generalized eigenvalue problem based on the zggev and dggev LAPACK functions.

Parameters

A	A square matrix on the left side.
B	A square matrix on the right side.

Returns

Returns the calculated generalized eigenvalues and the right and left sided eigenvectors.

getProgramName()

function CommonFunctions::getProgramName

(

)

Gets the name of the package.

Returns

Returns the name of the package.

getProgramShortName()

function CommonFunctions::getProgramShortName

(

)

Gets the short name of the package.

Returns

Returns the short name of the package.

getVersion()

function CommonFunctions::getVersion

(

)

Gets the current version of the package.

Returns

Returns the current version of the package.

inv_SVD()

static function CommonFunctions::inv_SVD ( A  )

static

Inverts badly conditioned matrix A with SVD regularization.

Parameters

A	A square matrix to be inverted.

Returns

Returns the calculated inverse.

IsDeployedMKL()

function CommonFunctions::IsDeployedMKL

(

)

Checks whether the MKL component is deployed.

Returns

Returns with true if MKL component is deployed, false otherwise.

isOctave()

static function CommonFunctions::isOctave ( )

static

Checks whether the running environment is matlab or octave.

Returns

Returns true if running environment is octave, false otherwise.

partialInv()

function CommonFunctions::partialInv	(	A	,
		sizeInv
	)

Calculates a partial inverse of a sparse matrix.

If MKL component is not developed, the backslash operator is used insted.

Parameters

A	A sparse matrix to be inverted
sizeInv	The size of partial inverse to be calculated.

Returns

Returns the calculated partial inverse

SimphsonInt()

static function CommonFunctions::SimphsonInt ( y  , h    )

static

Simphson integral: y is a vector of function values at equal distant points: y_i = f(x_i), x_i-x_{i-1}=h.

Parameters

y	Function values to be integrated
h	Increment between the x_i points.

xmlread()

function CommonFunctions::xmlread

(

filename

)

Function to load XML files (based on xerces libraries), providing octave compatibility.

Parameters

filename

Absolute path to the file to be opened. (In matlab relative path is sufficient)

Returns

The loaded document object model (see http://www.mathworks.com/help/matlab/ref/xmlread.html#outputarg_DOMnode for details.)

xmlwrite()

function CommonFunctions::xmlwrite	(	filename	,
		DOM
	)

Function to export XML files (based on xerces libraries), providing octave compatibility.

Parameters

filename	Absolute path to the file to be opened. (In matlab relative path is sufficient)
DOM	The loaded document object model (see http://www.mathworks.com/help/matlab/ref/xmlread.html#outputarg_DOMnode for details.)

Member Data Documentation

DeployedMKL

Property CommonFunctions::DeployedMKL

protected

True if MKL component is built, false otherwise.

Definition at line 32 of file CommonFunctions.m.

MaxSize

Property CommonFunctions::MaxSize

protected

Maximal size of full matrixes to be handled.

Definition at line 44 of file CommonFunctions.m.

ProgramName

Property CommonFunctions::ProgramName

protected

Name of the package.

Definition at line 38 of file CommonFunctions.m.

ProgramShortName

Property CommonFunctions::ProgramShortName

protected

Short name of the package.

Definition at line 41 of file CommonFunctions.m.

version

Property CommonFunctions::version

protected

The current version of the package.

Definition at line 35 of file CommonFunctions.m.

---

The documentation for this class was generated from the following file:

• CommonFunctions.m