OpenFPM_data  0.1.0
Project that contain the implementation and interfaces for basic structure like vectors, grids, graph ... .
 All Data Structures Namespaces Functions Variables Typedefs Friends
openfpm::vector_key_iterator Class Reference

Vector iterator. More...

Detailed Description

Vector iterator.

Definition at line 44 of file map_vector.hpp.

#include <map_vector.hpp>

Public Member Functions

 vector_key_iterator (size_t end, size_t start=0)
 Constructor require the size of the vector. More...
 
vector_key_iterator operator++ ()
 Get the next element. More...
 
void set (int d, size_t sz)
 Set the dimension. More...
 
bool isNext ()
 Check if there is the next element. More...
 
size_t get ()
 Get the actual key. More...
 

Protected Attributes

size_t gk
 Actual key.
 

Private Attributes

size_t end
 Linearized end element.
 

Constructor & Destructor Documentation

openfpm::vector_key_iterator::vector_key_iterator ( size_t  end,
size_t  start = 0 
)
inline

Constructor require the size of the vector.

Parameters
endsize of the vector

Definition at line 60 of file map_vector.hpp.

Member Function Documentation

size_t openfpm::vector_key_iterator::get ( )
inline

Get the actual key.

Get the actual key

Returns
the actual key

Definition at line 121 of file map_vector.hpp.

bool openfpm::vector_key_iterator::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 101 of file map_vector.hpp.

vector_key_iterator openfpm::vector_key_iterator::operator++ ( )
inline

Get the next element.

Get the next element

Returns
the next grid_key

increment the first index

Definition at line 72 of file map_vector.hpp.

void openfpm::vector_key_iterator::set ( int  d,
size_t  sz 
)
inline

Set the dimension.

Parameters
dis the dimension (IGNORED is by default 0)
szset the counter to sz

Definition at line 87 of file map_vector.hpp.


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