OpenCMISS-Iron Python Bindings API Documentation
iron.DistributedVector Class Reference
Inheritance diagram for iron.DistributedVector:
Collaboration diagram for iron.DistributedVector:

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)
 

Public Attributes

 cmiss_type
 

Properties

 dataType = property(DataTypeGet, None, None, )
 

Detailed Description

A vector that may be distributed across multiple computational nodes

Definition at line 2283 of file iron.py.

Constructor & Destructor Documentation

def iron.DistributedVector.__init__ (   self)
Initialise a null cmfe_DistributedVectorType

Definition at line 2287 of file iron.py.

Member Function Documentation

def iron.DistributedVector.DataGetDP (   self)
Get the data array for this vector on this computational node

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

Definition at line 2292 of file iron.py.

def iron.DistributedVector.DataGetIntg (   self)
Get the data array for this vector on this computational node

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

Definition at line 2303 of file iron.py.

def iron.DistributedVector.DataGetL (   self)
Get the data array for this vector on this computational node

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

Definition at line 2314 of file iron.py.

def iron.DistributedVector.DataGetSP (   self)
Get the data array for this vector on this computational node

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

Definition at line 2325 of file iron.py.

def iron.DistributedVector.DataRestoreDP (   self,
  data 
)
Restore the data array for this vector once it has finished being used

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

Definition at line 2336 of file iron.py.

def iron.DistributedVector.DataRestoreIntg (   self,
  data 
)
Restore the data array for this vector once it has finished being used

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

Definition at line 2347 of file iron.py.

def iron.DistributedVector.DataRestoreL (   self,
  data 
)
Restore the data array for this vector once it has finished being used

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

Definition at line 2358 of file iron.py.

def iron.DistributedVector.DataRestoreSP (   self,
  data 
)
Restore the data array for this vector once it has finished being used

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

Definition at line 2369 of file iron.py.

def iron.DistributedVector.DataTypeGet (   self)
Get the data type of a distributed vector

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

Definition at line 2380 of file iron.py.

Member Data Documentation

iron.DistributedVector.cmiss_type

Definition at line 2290 of file iron.py.

Property Documentation

iron.DistributedVector.dataType = property(DataTypeGet, None, None, )
static

Definition at line 2390 of file iron.py.