SkelCL
SkelCL is a high level multi GPU skeleton library developed at the university of M√ľnster, Germany.
 All Classes Namespaces Files Functions Variables Typedefs Groups
Public Types | Public Member Functions | List of all members
skelcl::Index Class Reference

This class defines an Index, i.e. an unsigned integer representing a value in a one-dimensional index space. More...

#include <Index.h>

Public Types

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

Public Member Functions

 Index ()
 Creates an Index with the value 0.
 
 Index (const index_type index)
 Creates an Index with the given value. More...
 
bool operator== (const Index &rhs) const
 Equality operator. Two Index objects are equal if and only if the two underlying unsigned integer are equal. More...
 
bool 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. More...
 
 operator index_type () const
 Conversion operator. The Index object is automatically converted in the underlying unsigned integer representing this Index object. More...
 
index_type get () const
 Explicit function to access the underlying unsigned integer representing this Index object. More...
 

Detailed Description

This class defines an Index, i.e. an unsigned integer representing a value in a one-dimensional index space.

Definition at line 54 of file Index.h.

Constructor & Destructor Documentation

skelcl::Index::Index ( const index_type  index)

Creates an Index with the given value.

Parameters
indexThe value is used to create the Index.

Definition at line 49 of file Index.cpp.

Member Function Documentation

Index::index_type skelcl::Index::get ( ) const

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.

skelcl::Index::operator index_type ( ) const

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
rhsThe 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
rhsThe 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: