#include <tnt_array3d.h>
Public Types | |
| typedef T | value_type |
Public Methods | |
| Array3D () | |
| Array3D (int m, int n, int k) | |
| Array3D (int m, int n, int k, T *a) | |
| Array3D (int m, int n, int k, const T &a) | |
| Array3D (const Array3D &A) | |
| Array3D& | operator= (const T &a) |
| Array3D& | operator= (const Array3D &A) |
| Array3D& | ref (const Array3D &A) |
| Array3D | copy () const |
| Array3D& | inject (const Array3D &A) |
| T** | operator[] (int i) |
| const T* const* | operator[] (int i) const |
| int | dim1 () const |
| int | dim2 () const |
| int | dim3 () const |
| ~Array3D () | |
Array assignment is by reference (i.e. shallow assignment). That is, B=A implies that the A and B point to the same array, so modifications to the elements of A will be reflected in B. If an independent copy is required, then B = A.copy() can be used. Note that this facilitates returning arrays from functions without relying on compiler optimizations to eliminate extensive data copying.
The indexing and layout of this array object makes it compatible with C and C++ algorithms that utilize the familiar C[i][j][k] notation. This includes numerous textbooks, such as Numercial Recipes, and various public domain codes.
|
|||
|
|
|
||||
|
Create a null (0x0x0) array. |
|
||||||||
|
Create a new (m x n x k) array, WIHOUT initializing array elements. To create an initialized array of constants, see Array3D(m,n,k, value).
This version avoids the O(m*n*k) initialization overhead and is used just before manual assignment.
|
|
||||||||||
|
Create a new (m x n x k) array, as a view of an existing one-dimensional array stored in C order, i.e. right-most dimension varying fastest. (Often referred to as "row-major" ordering.) Note that the storage for this pre-existing array will never be garbage collected by the Array3D class.
|
|
||||||||||
|
Create a new (m x n x k) array, initializing array elements to constant specified by argument. Most often used to create an array of zeros, as in A(m, n, k, 0.0).
|
|
||||
|
Copy constructor. Array data is NOT copied, but shared. Thus, in Array3D B(A), subsequent changes to A will be reflected in B. For an indepent copy of A, use Array3D B(A.copy()), or B = A.copy(), instead. |
|
||||
|
|
|
||||
|
Create a new of existing matrix. Used in B = A.copy() or in the construction of B, e.g. Array3D B(A.copy()), to create a new array that does not share data. |
|
||||
|
|
|
||||
|
|
|
||||
|
|
|
||||
|
Copy the elements to from one array to another, in place. That is B.inject(A), both A and B must conform (i.e. have identical dimensions). This differs from B = A.copy() in that references to B before this assignment are also affected. That is, if we have Array3D A(m,n,k); Array3D C(m,n,k); Array3D B(C); // elements of B and C are shared.then B.inject(A) affects both and C, while B=A.copy() creates a new array B which shares no data with C or A.
|
|
||||
|
B = A is shorthand notation for B.ref(A). |
|
||||
|
Assign all elemnts of A to a constant scalar. |
|
||||
|
|
|
||||
|
Used for A[i][j][k] indexing. The first [] operator returns a conventional pointer which can be dereferenced using the same [] notation. If TNT_BOUNDS_CHECK macro is define, the left-most index is checked that it falls within the array bounds (via the assert() macro.) |
|
||||
|
Create a reference (shallow assignment) to another existing array. In B.ref(A), B and A shared the same data and subsequent changes to the array elements of one will be reflected in the other. This is what operator= calls, and B=A and B.ref(A) are equivalent operations.
|
1.2.5 written by Dimitri van Heesch,
© 1997-2001