Iterator_g_const Class Reference

Detailed Description

Iterate through the elements (i1,i2,....,in) with i1 ... in unsigned integers with the following constrain (i1>i2>......>in)

Definition at line 1081 of file grid_sm.hpp.

#include <grid_sm.hpp>

Public Member Functions
size_t	getDim ()
	Get the dimensionality of the iterator.
	Iterator_g_const (size_t n, size_t sz)
	Constructor.
Iterator_g_const &	operator++ ()
	Get the next element.
bool	isNext ()
	Check if there is the next element.
grid_key_dx_r &	get ()
	Return the actual key.

Private Attributes
size_t	dim
size_t	sz
	size of the grid (the grid is assumed a square so equal on each dimension)
grid_key_dx_r	gk

Constructor & Destructor Documentation

Iterator_g_const()

Iterator_g_const::Iterator_g_const ( size_t  n, size_t  sz  )

inline

Constructor.

Parameters

n	Dimensionality (how many i1 ... in you have)
sz	Size of the grid on all dimensions range of the value i1 ... in can assume

Definition at line 1111 of file grid_sm.hpp.

Member Function Documentation

get()

grid_key_dx_r & Iterator_g_const::get ( )

inline

Return the actual key.

Return the actual key

Returns

The actual key that identify with the set of index

Definition at line 1208 of file grid_sm.hpp.

getDim()

size_t Iterator_g_const::getDim ( )

inline

Get the dimensionality of the iterator.

Get the dimensionality of the iterator

Definition at line 1099 of file grid_sm.hpp.

isNext()

bool Iterator_g_const::isNext ( )

inline

Check if there is the next element.

Check if there is the next element

Returns

true if there is the next, false otherwise

we did not reach the end of the grid

we reach the end of the grid

Definition at line 1183 of file grid_sm.hpp.

operator++()

Iterator_g_const & Iterator_g_const::operator++ ( )

inline

Get the next element.

Get the next element

Returns

the next grid_key

increment the first index

check the overflow of all the index with exception of the last dimensionality

Definition at line 1130 of file grid_sm.hpp.

Field Documentation

dim

size_t Iterator_g_const::dim

private

Definition at line 1083 of file grid_sm.hpp.

gk

grid_key_dx_r Iterator_g_const::gk

private

Definition at line 1089 of file grid_sm.hpp.

sz

size_t Iterator_g_const::sz

private

size of the grid (the grid is assumed a square so equal on each dimension)

Definition at line 1086 of file grid_sm.hpp.

---

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

• openfpm_data/src/Grid/grid_sm.hpp