bridges.array.Array Class Reference

Detailed Description

This class can be used to create arrays of type Element<E>.

Author

Matthew McQuaigue

Date

10/8/16, 6/09/19

This class can be used to create arrays of type Element<E> where E is a generic object representing application specific data.

Arrays are internally represented as 1D arrays; currently 1D, 2D and 3D arrays are supported.

Public Member Functions
def	__init__ (self, kwargs)
	Array constructor. More...
def	num_dims (self)
	Getter for representing the number of dimensions in the array. More...
def	num_dims
	Setter function for the number of dimensions for the array. More...
def	size (self)
	Getter for representing the size of array. More...
def	size
	Setter for representing the size of the array. More...
def	get_data_structure_type (self)
	Gets the data structure type. More...
def	set_dimensions
	Sets the size of each dimension and allocates array space. More...
def	get_dimensions (self)
def	get_element (self, args, kwargs)
	Getter function for an element in the array at given position. More...
def	set_element (self, args, kwargs)
	Setter function for an element in the array at given position. More...
def	__getitem__ (self, item)
def	__setitem__ (self, key, value)
def	get_data_structure_representation (self)
	Generating the JSON string for a bridges array object. More...

Public Attributes
	size

Static Public Attributes
list	dims = [1,1,1]

Constructor & Destructor Documentation

__init__()

def bridges.array.Array.__init__	(		self,
			kwargs
	)

Array constructor.

Parameters

num_dims	The dimensions of the array (1-3). Defaults to 1 dimension (int)
dims	size of each dimension (array)
x_dim	number of elements on the x dimension (int)
y_dim	number of elements on the y dimension (int)
z_dim	number of elements on the z dimension (int)

Returns

None

Member Function Documentation

__getitem__()

def bridges.array.Array.__getitem__	(		self,
			item
	)

__setitem__()

def bridges.array.Array.__setitem__	(		self,
			key,
			value
	)

get_data_structure_representation()

def bridges.array.Array.get_data_structure_representation	(		self,
			dict
	)

Generating the JSON string for a bridges array object.

Returns

dict the dict that will represent the json when dumped

get_data_structure_type()

def bridges.array.Array.get_data_structure_type	(		self,
			str
	)

Gets the data structure type.

Exceptions

ValueError

if number of dimensions is < 1 or > 3

Returns

str type of data structure

get_dimensions()

def bridges.array.Array.get_dimensions

(

self

)

get_element()

def bridges.array.Array.get_element	(		self,
			args,
			kwargs
	)

Getter function for an element in the array at given position.

(int) x,y,z,: indices

(int) index: the index of array to get in array (int) x: column index into array (int) y: row index into array (int) z: slice index into array

Returns

Element the element at position given

num_dims() [1/2]

def bridges.array.Array.num_dims	(		self,
			int
	)

Getter for representing the number of dimensions in the array.

Returns

int number of dimensions

num_dims() [2/2]

def bridges.array.Array.num_dims	(		self,
			value
	)

Setter function for the number of dimensions for the array.

Parameters

value

An integer for the number of dimensions (Between 1 and 3 inclusive)

Returns

None

Exceptions

ValueError

if dimension passed in is < 1 or > 3

set_dimensions()

def bridges.array.Array.set_dimensions	(		self,
			dim
	)

Sets the size of each dimension and allocates array space.

(list) dim: size of each dimension in array

Returns

None

set_element()

def bridges.array.Array.set_element	(		self,
			args,
			kwargs
	)

Setter function for an element in the array at given position.

(int) x,y,z: indices (Element) el: element object to be assigned to index, always last position arg if using unnamed args

(Element) el: element object to be assigned to index (int) index: the index of array to get in array (int) x: column index into array (int) y: row index into array (int) z: slice index into array

Returns

None

size() [1/2]

def bridges.array.Array.size	(		self,
			int
	)

Getter for representing the size of array.

Returns

int the size

size() [2/2]

def bridges.array.Array.size	(		self,
			sz
	)

Setter for representing the size of the array.

(int) sz: The size to be set for array

Returns

None

Member Data Documentation

dims

list bridges.array.Array.dims = [1,1,1]

static

size

bridges.array.Array.size

---

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

• /home/erik/work/bridges/bridges-python/bridges/array.py