Bridges-Java-2.3.2  2.3.2
Bridges(JavaAPI)
Public Member Functions | List of all members
bridges.base.Array< E > Class Template Reference

This class can be used to create arrays of type Element<E> where E is a generic type representation application specific data. Arrays are internally represented as 1D arrays; currently 1D, 2D and 3D arrays are supported. More...

Inheritance diagram for bridges.base.Array< E >:
bridges.base.DataStruct

Public Member Functions

 Array ()
 
 Array (int num_dims, int[] dims)
 
String getDataStructType ()
 
void setNumDimensions (int nd)
 
int getNumDimensions ()
 
void setDimensions (int[] dim)
 
void getDimensions (int[] dim)
 
int getSize ()
 
Element< E > getValue (int indx)
 
void setValue (int indx, Element< E > el)
 
Element< E > getValue (int col, int row)
 
void setValue (int col, int row, Element< E > el)
 
Element< E > getValue (int col, int row, int slice)
 
void setValue (int col, int row, int slice, Element< E > el)
 

Additional Inherited Members

- Protected Member Functions inherited from bridges.base.DataStruct
abstract String getDataStructType ()
 
- Protected Attributes inherited from bridges.base.DataStruct
String QUOTE = "\""
 

Detailed Description

This class can be used to create arrays of type Element<E> where E is a generic type representation application specific data. Arrays are internally represented as 1D arrays; currently 1D, 2D and 3D arrays are supported.

Author
Kalpathi Subramanian
Parameters
<E>
Author
Kalpathi Subramanian
Date
10/8/16

Constructor & Destructor Documentation

bridges.base.Array< E >.Array ( int  num_dims,
int[]  dims 
)

Create an array object with the specified dimensions

Parameters
num_dimsnumber of dimensions of the array
dimssize of each dimension

Member Function Documentation

String bridges.base.Array< E >.getDataStructType ( )

This method gets the data structure type

Returns
The date structure type as a string
void bridges.base.Array< E >.getDimensions ( int[]  dim)

Get the size of each dimensions;

Parameters
dims[]size of each dimension is returned
int bridges.base.Array< E >.getNumDimensions ( )

Get the number of dimensions of the array;

Returns
number of dimensions
int bridges.base.Array< E >.getSize ( )

Get the array size

Returns
size
Element<E> bridges.base.Array< E >.getValue ( int  indx)

Get the object at 'indx'

Parameters
indxindex into the array
Returns
Element<E> object at 'indx'
Element<E> bridges.base.Array< E >.getValue ( int  col,
int  row 
)

2D array: Get the object at 'col, row'

Parameters
colcol index into the array
rowrow index into the array
Returns
Element<E> object at 'col, row'
Element<E> bridges.base.Array< E >.getValue ( int  col,
int  row,
int  slice 
)

3D array: Get the object at 'col, row, slice'

Parameters
colcol index into the array
rowrow index into the array
sliceslice index into the array
Returns
Element<E> object at 'col, row'
void bridges.base.Array< E >.setDimensions ( int[]  dim)

Set the size of each dimensions; also allocates array space

Parameters
dim[]size of each dimension
void bridges.base.Array< E >.setNumDimensions ( int  nd)

Set the number of dimensions of the array;

Parameters
ndnumber of dimensions
void bridges.base.Array< E >.setValue ( int  indx,
Element< E >  el 
)

Set the input object at 'indx'

Parameters
indxindex into the array
elelement object to be assigned at 'indx'
void bridges.base.Array< E >.setValue ( int  col,
int  row,
Element< E >  el 
)

Set the input object at 'indx'

Parameters
colcolumn index into the array
rowrow index into the array
elelement object to be assigned at 'indx'
void bridges.base.Array< E >.setValue ( int  col,
int  row,
int  slice,
Element< E >  el 
)

Set the input object at 'col, row, slice'

Parameters
colcolumn index into the array
rowrow index into the array
sliceslice index into the array
elelement object to be assigned at 'indx'

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