Size Class Reference
class encapsulating 1D to 3D size
More...
#include <size.hh>
Detailed Description
class encapsulating 1D to 3D size
Definition at line 39 of file size.hh.
Constructor & Destructor Documentation
Size |
( |
unsigned int |
w |
) |
[explicit] |
Size |
( |
unsigned int |
w, |
|
|
unsigned int |
h | |
|
) |
| | [explicit] |
Size |
( |
unsigned int |
w, |
|
|
unsigned int |
h, |
|
|
unsigned int |
d | |
|
) |
| | [explicit] |
initialize from two points
Member Function Documentation
unsigned int GetDepth |
( |
|
) |
const |
get depth component (convenience to index 2)
unsigned int GetDim |
( |
|
) |
const |
return dimensionality (1-3)
return the point at half the size
for even dimension, its N/2-1, for odd dimension its (N-1)/2
unsigned int GetHeight |
( |
|
) |
const |
get height component (convenience to index 1)
unsigned int GetSlab |
( |
|
) |
const |
get area (width * height)
unsigned int GetVol |
( |
|
) |
const |
unsigned int GetVolume |
( |
|
) |
const |
unsigned int GetWidth |
( |
|
) |
const |
get width component (convenience to index 0)
bool operator!= |
( |
const Size & |
s |
) |
const |
bool operator== |
( |
const Size & |
s |
) |
const |
unsigned int& operator[] |
( |
unsigned int |
index |
) |
|
unsigned int operator[] |
( |
unsigned int |
index |
) |
const |
The documentation for this class was generated from the following file: