A class for controlling the parallel pool for paralell computations. More...

Inheritance diagram for Parallel:

[legend]

Public Member Functions
function	closePool ()
	Closes a parallel pool. More...

function	diagInv (A)
	Calculates the diagonal part of the inverse of a sparse matrix. More...

function	display (message, nosilent)
	Displays output messages on the screen. More...

function	eig (A, B)
	Calculates the generalized eigenvalue problem based on the zggev and dggev LAPACK functions. More...

function	getOpt ()
	Retrives the structure containing the calculation parameters. 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	openPool ()
	Opens a parallel pool for parallel computations. More...

function	Parallel (Opt)
	Constructor of the class. 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	BadInputType (variable, type)
	Throws a "bad input type" warning, with using the default value. More...

static function	BadInputTypeNoDefault (variable, type)
	Throws a "bad input type" warning without setting it to default. More...

static function	checkMEXfile (fncname)
	Checks the presence of a given MEX file. More...

static function	ExceedIteration ()
	Throws an "iteration exceeded" warning. 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...

Public Attributes
Property	NumWorkers
	Number of workers. 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	Opt
	An instance of structure Opt. More...

Property	poolobj
	The parallel.Pool object, see the documentation for more details. More...

Property	ProgramName
	Name of the package. More...

Property	ProgramShortName
	Short name of the package. More...

Property	try2open
	Number of attempts to open the parallel pool. More...

Property	try2open_max
	Maximal number of attemts to open the parallel pool. More...

Property	version
	The current version of the package. More...

Property	waitsec
	A period to wait between the attempts to open the parallel pool. More...

Detailed Description

A class for controlling the parallel pool for paralell computations.

(compatble only wih MATLAB)

Available

EQuUs v4.6 or later

Definition at line 26 of file Parallel.m.

Constructor & Destructor Documentation

◆ Parallel()

function Parallel::Parallel ( Opt )

Constructor of the class.

Parameters

Opt	An instance of the structure Opt.

Returns: An instance of the class

Member Function Documentation

◆ BadInputType()

static function Messages::BadInputType	(	variable	,
		type
	)

staticinherited

Throws a "bad input type" warning, with using the default value.

Parameters

variable	A string conatining the name of the variable.
type	A string describing the desired type.

◆ BadInputTypeNoDefault()

static function Messages::BadInputTypeNoDefault	(	variable	,
		type
	)

staticinherited

Throws a "bad input type" warning without setting it to default.

Parameters

variable	A string conatining the name of the variable.
type	A string describing the desired type.

◆ checkMEXfile()

static function CommonFunctions::checkMEXfile ( fncname )

staticinherited

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.

◆ closePool()

function Parallel::closePool ( )

Closes a parallel pool.

◆ diagInv()

function CommonFunctions::diagInv ( A )

inherited

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

◆ display()

function Messages::display	(	message	,
		nosilent
	)

inherited

Displays output messages on the screen.

Parameters

message	String containing the message to be displayed
nosilent	Set true to override the silent option given in Opt.Silent.

◆ eig()

function CommonFunctions::eig	(	A	,
		B
	)

inherited

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.

◆ ExceedIteration()

static function Messages::ExceedIteration ( )

staticinherited

Throws an "iteration exceeded" warning.

◆ getOpt()

function Messages::getOpt ( )

inherited

Retrives the structure containing the calculation parameters.

Returns: Return an instance of structure Opt.

◆ getProgramName()

function CommonFunctions::getProgramName ( )

inherited

Gets the name of the package.

Returns: Returns the name of the package.

◆ getProgramShortName()

function CommonFunctions::getProgramShortName ( )

inherited

Gets the short name of the package.

Returns: Returns the short name of the package.

◆ getVersion()

function CommonFunctions::getVersion ( )

inherited

Gets the current version of the package.

Returns: Returns the current version of the package.

◆ inv_SVD()

static function CommonFunctions::inv_SVD ( A )

staticinherited

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 ( )

inherited

Checks whether the MKL component is deployed.

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

◆ isOctave()

static function CommonFunctions::isOctave ( )

staticinherited

Checks whether the running environment is matlab or octave.

Returns: Returns true if running environment is octave, false otherwise.

◆ openPool()

function Parallel::openPool ( )

Opens a parallel pool for parallel computations.

◆ partialInv()

function CommonFunctions::partialInv	(	A	,
		sizeInv
	)

inherited

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
	)

staticinherited

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 )

inherited

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
	)

inherited

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

protectedinherited

True if MKL component is built, false otherwise.

Definition at line 32 of file CommonFunctions.m.

◆ MaxSize

Property CommonFunctions::MaxSize

protectedinherited

Maximal size of full matrixes to be handled.

Definition at line 44 of file CommonFunctions.m.

◆ NumWorkers

Property Parallel::NumWorkers

Number of workers.

Definition at line 49 of file Parallel.m.

◆ Opt

Property Messages::Opt

protectedinherited

An instance of structure Opt.

Definition at line 31 of file Messages.m.

◆ poolobj

Property Parallel::poolobj

protected

The parallel.Pool object, see the documentation for more details.

Definition at line 34 of file Parallel.m.

◆ ProgramName

Property CommonFunctions::ProgramName

protectedinherited

Name of the package.

Definition at line 38 of file CommonFunctions.m.

◆ ProgramShortName

Property CommonFunctions::ProgramShortName

protectedinherited

Short name of the package.

Definition at line 41 of file CommonFunctions.m.

◆ try2open

Property Parallel::try2open

protected

Number of attempts to open the parallel pool.

Definition at line 37 of file Parallel.m.

◆ try2open_max

Property Parallel::try2open_max

protected

Maximal number of attemts to open the parallel pool.

Definition at line 40 of file Parallel.m.

◆ version

Property CommonFunctions::version

protectedinherited

The current version of the package.

Definition at line 35 of file CommonFunctions.m.

◆ waitsec

Property Parallel::waitsec

protected

A period to wait between the attempts to open the parallel pool.

Definition at line 43 of file Parallel.m.

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

Parallel.m

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Available

Constructor & Destructor Documentation

◆ Parallel()

Member Function Documentation

◆ BadInputType()

◆ BadInputTypeNoDefault()

◆ checkMEXfile()

◆ closePool()

◆ diagInv()

◆ display()

◆ eig()

◆ ExceedIteration()

◆ getOpt()

◆ getProgramName()

◆ getProgramShortName()

◆ getVersion()

◆ inv_SVD()

◆ IsDeployedMKL()

◆ isOctave()

◆ openPool()

◆ partialInv()

◆ SimphsonInt()

◆ xmlread()

◆ xmlwrite()

Member Data Documentation

◆ DeployedMKL

◆ MaxSize

◆ NumWorkers

◆ Opt

◆ poolobj

◆ ProgramName

◆ ProgramShortName

◆ try2open

◆ try2open_max

◆ version

◆ waitsec