iron.DistributedMatrix Class Reference

Inheritance diagram for iron.DistributedMatrix:

Collaboration diagram for iron.DistributedMatrix:

Public Member Functions
def	__init__ (self)
def	DataGetDP (self)
def	DataGetIntg (self)
def	DataGetL (self)
def	DataGetSP (self)
def	DataRestoreDP (self, data)
def	DataRestoreIntg (self, data)
def	DataRestoreL (self, data)
def	DataRestoreSP (self, data)
def	DataTypeGet (self)
def	DimensionsGet (self)
def	StorageLocationsGet (self)
def	StorageTypeGet (self)

Public Attributes
	cmiss_type

Properties
	dataType = property(DataTypeGet, None, None, )
	storageType = property(StorageTypeGet, None, None, )

Detailed Description

A matrix that may be distributed across multiple computational nodes
and may use sparse or full storage.

Definition at line 2138 of file iron.py.

Constructor & Destructor Documentation

def iron.DistributedMatrix.__init__

(

self

)

Initialise a null cmfe_DistributedMatrixType

Definition at line 2143 of file iron.py.

Member Function Documentation

def iron.DistributedMatrix.DataGetDP

(

self

)

Get the data array for this matrix on this computational node

:param dataSize: Size of data to allocate.
:returns: data. The matrix data
:rtype: Array of floats

Definition at line 2148 of file iron.py.

def iron.DistributedMatrix.DataGetIntg

(

self

)

Get the data array for this matrix on this computational node

:param dataSize: Size of data to allocate.
:returns: data. The matrix data
:rtype: Array of ints

Definition at line 2159 of file iron.py.

def iron.DistributedMatrix.DataGetL

(

self

)

Get the data array for this matrix on this computational node

:param dataSize: Size of data to allocate.
:returns: data. The matrix data
:rtype: Array of bools

Definition at line 2170 of file iron.py.

def iron.DistributedMatrix.DataGetSP

(

self

)

Get the data array for this matrix on this computational node

:param dataSize: Size of data to allocate.
:returns: data. The matrix data
:rtype: Array of floats

Definition at line 2181 of file iron.py.

def iron.DistributedMatrix.DataRestoreDP	(		self,
			data
	)

Restore the data array for this matrix once it has finished being used

:param data: On entry, a pointer to the matrix data. On return, a nullified pointer.
:type data: Array of floats
:rtype: None

Definition at line 2192 of file iron.py.

def iron.DistributedMatrix.DataRestoreIntg	(		self,
			data
	)

Restore the data array for this matrix once it has finished being used

:param data: On entry, a pointer to the matrix data. On return, a nullified pointer.
:type data: Array of ints
:rtype: None

Definition at line 2203 of file iron.py.

def iron.DistributedMatrix.DataRestoreL	(		self,
			data
	)

Restore the data array for this matrix once it has finished being used

:param data: On entry, a pointer to the matrix data. On return, a nullified pointer.
:type data: Array of bools
:rtype: None

Definition at line 2214 of file iron.py.

def iron.DistributedMatrix.DataRestoreSP	(		self,
			data
	)

Restore the data array for this matrix once it has finished being used

:param data: On entry, a pointer to the matrix data. On return, a nullified pointer.
:type data: Array of floats
:rtype: None

Definition at line 2225 of file iron.py.

def iron.DistributedMatrix.DataTypeGet

(

self

)

Get the data type of a distributed matrix

:returns: dataType. The matrix data type. Will be a value from the MatrixVectorDataTypes enum.
:rtype: int

Definition at line 2236 of file iron.py.

def iron.DistributedMatrix.DimensionsGet

(

self

)

Get the dimensions of a distributed matrix on this computational node

:returns: (The number of rows for this computational node, The number of columns)
:rtype: tuple. (int, int)

Definition at line 2246 of file iron.py.

def iron.DistributedMatrix.StorageLocationsGet

(

self

)

Get the row indices and column indices for a sparse matrix

:param rowIndicesSize: Size of rowIndices to allocate.
:param columnIndicesSize: Size of columnIndices to allocate.
:returns: (The matrix storage row indices, The matrix storage column indices)
:rtype: tuple. (Array of ints, Array of ints)

Definition at line 2256 of file iron.py.

def iron.DistributedMatrix.StorageTypeGet

(

self

)

Get the storage type for a distributed matrix

:returns: storageType. The matrix storage type. Will be a value from the MatrixStorageTypes enum.
:rtype: int

Definition at line 2268 of file iron.py.

Member Data Documentation

iron.DistributedMatrix.cmiss_type

Definition at line 2146 of file iron.py.

Property Documentation

iron.DistributedMatrix.dataType = property(DataTypeGet, None, None, )

static

Definition at line 2278 of file iron.py.

iron.DistributedMatrix.storageType = property(StorageTypeGet, None, None, )

static

Definition at line 2280 of file iron.py.