VerletNNIteratorM< dim, Ver, sh_byte > Class Template Reference

Iterator for the neighborhood of the cell structures. More...

Detailed Description

template<unsigned int dim, typename Ver, unsigned int sh_byte>
class VerletNNIteratorM< dim, Ver, sh_byte >

Iterator for the neighborhood of the cell structures.

In general you never create it directly but you get it from the CellList structures

It iterate across all the element of the selected cell and the near cells

Template Parameters

dim	dimensionality of the space where the cell live
Ver	Base verlet structure
sh_byte	number of bits for the phase number

Definition at line 24 of file VerletNNIteratorM.hpp.

#include <VerletNNIteratorM.hpp>

Inheritance diagram for VerletNNIteratorM< dim, Ver, sh_byte >:

Public Member Functions
	VerletNNIteratorM (size_t part_id, Ver &ver)
	Constructor for the Verlet iterator Multi-phase.
size_t	getP ()
	Get the value of the cell.
size_t	getV ()
	Get the value of the cell.
Public Member Functions inherited from VerletNNIterator< dim, Ver >
	VerletNNIterator (size_t part_id, Ver &ver)
	Cell NN iterator.
bool	isNext ()
	Check if there is the next element.
VerletNNIterator &	operator++ ()
	take the next element
Ver::Mem_type_type::local_index_type	get ()
	Get the value of the cell.

Private Types
typedef boost::high_bit_mask_t< sh_byte >	mask_high
	Mask to get the high bits of a number.
typedef boost::low_bits_mask_t< sizeof(size_t) *8-sh_byte >	mask_low
	Mask to get the low bits of a number.

Member Typedef Documentation

mask_high

template<unsigned int dim, typename Ver , unsigned int sh_byte>

typedef boost::high_bit_mask_t<sh_byte> VerletNNIteratorM< dim, Ver, sh_byte >::mask_high

private

Mask to get the high bits of a number.

Definition at line 27 of file VerletNNIteratorM.hpp.

mask_low

template<unsigned int dim, typename Ver , unsigned int sh_byte>

typedef boost::low_bits_mask_t<sizeof(size_t)*8-sh_byte> VerletNNIteratorM< dim, Ver, sh_byte >::mask_low

private

Mask to get the low bits of a number.

Definition at line 30 of file VerletNNIteratorM.hpp.

Constructor & Destructor Documentation

VerletNNIteratorM()

template<unsigned int dim, typename Ver , unsigned int sh_byte>

VerletNNIteratorM< dim, Ver, sh_byte >::VerletNNIteratorM ( size_t  part_id, Ver &  ver  )

inline

Constructor for the Verlet iterator Multi-phase.

Definition at line 39 of file VerletNNIteratorM.hpp.

Member Function Documentation

getP()

template<unsigned int dim, typename Ver , unsigned int sh_byte>

size_t VerletNNIteratorM< dim, Ver, sh_byte >::getP ( )

inline

Get the value of the cell.

Returns

the next element object

Definition at line 49 of file VerletNNIteratorM.hpp.

getV()

template<unsigned int dim, typename Ver , unsigned int sh_byte>

size_t VerletNNIteratorM< dim, Ver, sh_byte >::getV ( )

inline

Get the value of the cell.

Returns

the next element object

Definition at line 59 of file VerletNNIteratorM.hpp.

---

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

• openfpm_data/src/NN/VerletList/VerletNNIteratorM.hpp