This class defines an Index, i.e. an unsigned integer representing a value in a onedimensional index space.
More...
#include <Index.h>

typedef size_t  index_type 
 Actual type used to store the unsigned integer representing the Index.


This class defines an Index, i.e. an unsigned integer representing a value in a onedimensional index space.
Definition at line 54 of file Index.h.
Creates an Index with the given value.
 Parameters

index  The value is used to create the Index. 
Definition at line 49 of file Index.cpp.
Explicit function to access the underlying unsigned integer representing this Index object.
 Returns
 The unsigned integer representing this Index object.
Definition at line 69 of file Index.cpp.
Conversion operator. The Index object is automatically converted in the underlying unsigned integer representing this Index object.
 Returns
 The unsigned integer representing this Index object.
Definition at line 64 of file Index.cpp.
bool skelcl::Index::operator!= 
( 
const Index & 
rhs  ) 
const 
Inequality operator. Two Index objects are not equal if and only if the two underlying unsigned integer are not equal.
 Parameters

rhs  The Index to be compared with. 
 Returns
 True if and only if the two underlying unsigned integers are not equal. False otherwise.
Definition at line 59 of file Index.cpp.
bool skelcl::Index::operator== 
( 
const Index & 
rhs  ) 
const 
Equality operator. Two Index objects are equal if and only if the two underlying unsigned integer are equal.
 Parameters

rhs  The Index to be compared with. 
 Returns
 True if and only if the two underlying unsigned integers are equal. False otherwise.
Definition at line 54 of file Index.cpp.
The documentation for this class was generated from the following files: