Version 1.2 (June 2013)
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | List of all members
utils.VectorizedArray Class Reference

Creates a 2D or 3D Vectorized array of a set size, and provides utilities to set and get values from this array. More...

Public Member Functions

 VectorizedArray (int nI, int nJ, int nK)
 Creates an empty 3D array of three provided dimensions. More...
 
 VectorizedArray (int nI, int nJ)
 Creates an empty 2D array in two provided dimensions. More...
 
double getValueAt (int i, int j, int k)
 Return the value at a specified index in the array. More...
 
void setValueAt (double value, int i, int j, int k)
 Set a value at a given array position. More...
 
double getMax ()
 Return the maximum value of the array. More...
 
double getMin ()
 Return the minimum value of the array. More...
 
double[][][] getValues ()
 Return the array as a 3D double array. More...
 

Detailed Description

Creates a 2D or 3D Vectorized array of a set size, and provides utilities to set and get values from this array.

Creates a 2D or 3D Vectorized array of a set size, and provides utilities to set and get values from this array

Constructor & Destructor Documentation

utils.VectorizedArray.VectorizedArray ( int  nI,
int  nJ,
int  nK 
)

Creates an empty 3D array of three provided dimensions.

Creates an empty 3D array of three provided dimensions

Parameters
nIArray size in I (X) direction
nJArray size in J (Y) direction
nKArray size in K (Z) direction
utils.VectorizedArray.VectorizedArray ( int  nI,
int  nJ 
)

Creates an empty 2D array in two provided dimensions.

Creates an empty 2D array in two provided dimensions

Parameters
nIArray size in I (X) direction
nJArray size in J (Y) direction

Member Function Documentation

double utils.VectorizedArray.getMax ( )

Return the maximum value of the array.

Return the maximum value of the array

Returns
Double value which is the maximum value in the array
double utils.VectorizedArray.getMin ( )

Return the minimum value of the array.

Return the minimum value of the array

Returns
Double value which is the minimum value in the array
double utils.VectorizedArray.getValueAt ( int  i,
int  j,
int  k 
)

Return the value at a specified index in the array.

Return the value at a specified index in the array

Parameters
iInteger index of the i position for which the value is being sought
jInteger index of the j position for which the value is being sought
kInteger index of the k position for which the value is being sought
Returns
Double value at this position
double [][][] utils.VectorizedArray.getValues ( )

Return the array as a 3D double array.

Return the array as a 3D double array

Returns
Vectorized array as a 3D double array
void utils.VectorizedArray.setValueAt ( double  value,
int  i,
int  j,
int  k 
)

Set a value at a given array position.

Set a value at a given array position

Parameters
valueValue to set position to
iInteger index of the i position for which the value is to be set
jInteger index of the j position for which the value is to be set
kInteger index of the k position for which the value is to be set

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