OpenFPM_pdata  4.1.0 Project that contain the implementation of distributed structures
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 1051 of file grid_sm.hpp.

#include <grid_sm.hpp>

## Public Member Functions

size_t getDim ()
Get the dimensionality of the iterator. More...

Iterator_g_const (size_t n, size_t sz)
Constructor. More...

Iterator_g_constoperator++ ()
Get the next element. More...

bool isNext ()
Check if there is the next element. More...

grid_key_dx_rget ()
Return the actual key. More...

## 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

## ◆ 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 1081 of file grid_sm.hpp.

## ◆ 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 1178 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 1069 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 1153 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 1100 of file grid_sm.hpp.

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