It is a class that work like a vector of vector. More...

#include <MemFast.hpp>

Inheritance diagram for Mem_fast< Memory, local_index >:

Public Types
typedef Mem_fast_ker< Memory, memory_traits_lin, local_index >	toKernel_type

typedef local_index	local_index_type

typedef local_index	loc_index
	expose the type of the local index

Public Member Functions
size_t	size () const
	return the number of elements More...

void	destroy ()
	Destroy the internal memory including the retained one.

void	init_to_zero (local_index slot, local_index tot_n_cell)
	Initialize the data to zero. More...

void	operator= (const Mem_fast< Memory, local_index > &mem)
	copy an object Mem_fast More...

void	operator= (Mem_fast< Memory, local_index > &&mem)
	copy an object Mem_fast More...

template<typename Memory2 >
void	copy_general (const Mem_fast< Memory2, local_index > &mem)
	copy an object Mem_fast More...

void	addCellGhostMarkers ()
	Add ghost marker to the cell. More...

size_t	getGhostMarker (local_index cell_id) const
	Get ghost marker of the cell.

void	addCell (local_index cell_id, local_index ele)
	Add an element to the cell. More...

auto	get (local_index cell, local_index ele) -> decltype(cl_base.template get< 0 >(cell *slot+ele)) &
	Get an element in the cell. More...

auto	get (local_index cell, local_index ele) const -> decltype(cl_base.template get< 0 >(cell *slot+ele)) &
	Get an element in the cell. More...

void	remove (local_index cell_id, local_index ele)
	Remove an element in the cell. More...

size_t	getNelements (const local_index cell_id) const
	Get the number of elements in the cell. More...

void	swap (Mem_fast< Memory, local_index > &mem)
	swap to Mem_fast object More...

void	swap (Mem_fast< Memory, local_index > &&mem)
	swap to Mem_fast object More...

void	clear ()
	Delete all the elements in every cell.

void	clear (local_index cell_id)
	Delete cell elements in Cell p.

const local_index &	getStartId (local_index cell_id) const
	Get the first element of a cell (as reference) More...

const local_index &	getGhostId (local_index cell_id) const
	Get the index of the first ghost element. More...

const local_index &	getStopId (local_index cell_id) const
	Get the last element of a cell (as reference) More...

const local_index &	get_lin (const local_index *part_id) const
	Just return the value pointed by part_id. More...

	Mem_fast (local_index slot)
	Constructor. More...

void	set_slot (local_index slot)
	Set the number of slot for each cell. More...

const openfpm::vector< aggregate< local_index >, Memory > &	private_get_cl_n () const
	Return the private data-structure cl_n. More...

const openfpm::vector< size_t > &	getGhostMarkers () const
	Return the private data-structure ghostMarkers. More...

const int &	private_get_slot () const
	Return the private slot. More...

const base &	private_get_cl_base () const
	Return the private data-structure cl_base. More...

template<int ... prp>
void	packRequest (size_t &req) const
	It calculate the number of byte required to serialize the object. More...

template<int ... prp>
void	pack (ExtPreAlloc< HeapMemory > &mem, Pack_stat &sts) const
	pack a vector selecting the properties to pack More...

template<int ... prp, typename MemType >
void	unpack (ExtPreAlloc< MemType > &mem, Unpack_stat &ps)
	unpack a vector More...

Static Public Member Functions
static bool	pack ()

static bool	packRequest ()

Private Types
typedef openfpm::vector< aggregate< local_index >, Memory >	base
	base that store the data

Private Member Functions
void	realloc ()
	realloc the data structures

Private Attributes
local_index	slot
	Number of slot for each cell.

openfpm::vector< aggregate< local_index >, Memory >	cl_n
	number of particle in each cell list

openfpm::vector< size_t >	ghostMarkers
	ghost marker for every cell (non-ghost particles < gm (ghost marker))

base	cl_base

Detailed Description

template<typename Memory = HeapMemory, typename local_index = size_t>
class Mem_fast< Memory, local_index >

It is a class that work like a vector of vector.

Template Parameters

local_index type used for the local index

It is a class that work like a vector(1) of vector(2). To emulate the vector of vector it use a 1D array of size N_ele * N_max_slot where N_ele is the number of elements in vector(1) and N_max_slot is the maximum number of elements across the vectors

Definition at line 87 of file MemFast.hpp.

Constructor & Destructor Documentation

◆ Mem_fast()

template<typename Memory = HeapMemory, typename local_index = size_t>

Mem_fast< Memory, local_index >::Mem_fast ( local_index slot )

inline

Constructor.

Parameters

slot	number of slot for each cell

Definition at line 433 of file MemFast.hpp.

Member Function Documentation

◆ addCell()

template<typename Memory = HeapMemory, typename local_index = size_t>

void Mem_fast< Memory, local_index >::addCell	(	local_index	cell_id,
		local_index	ele
	)

inline

Add an element to the cell.

Parameters

cell_id	id of the cell
ele	element to add

Definition at line 248 of file MemFast.hpp.

◆ addCellGhostMarkers()

template<typename Memory = HeapMemory, typename local_index = size_t>

void Mem_fast< Memory, local_index >::addCellGhostMarkers ( )

inline

Add ghost marker to the cell.

Parameters

cell_id	id of the cell
g_m	ghost marker to add

Definition at line 224 of file MemFast.hpp.

◆ copy_general()

template<typename Memory = HeapMemory, typename local_index = size_t>

template<typename Memory2 >

void Mem_fast< Memory, local_index >::copy_general ( const Mem_fast< Memory2, local_index > & mem )

inline

copy an object Mem_fast

Parameters

mem	Mem_fast to copy

Definition at line 209 of file MemFast.hpp.

◆ get() [1/2]

template<typename Memory = HeapMemory, typename local_index = size_t>

auto Mem_fast< Memory, local_index >::get	(	local_index	cell,
		local_index	ele
	)		-> decltype(cl_base.template get<0>(cell * slot + ele)) &

inline

Get an element in the cell.

Parameters

cell	id of the cell
ele	element id in the cell

Returns: the reference to the selected element

Definition at line 273 of file MemFast.hpp.

◆ get() [2/2]

template<typename Memory = HeapMemory, typename local_index = size_t>

auto Mem_fast< Memory, local_index >::get	(	local_index	cell,
		local_index	ele
	)		const -> decltype(cl_base.template get<0>(cell * slot + ele)) &

inline

Get an element in the cell.

Parameters

cell	id of the cell
ele	element id in the cell

Returns: the reference to the selected element

Definition at line 287 of file MemFast.hpp.

◆ get_lin()

template<typename Memory = HeapMemory, typename local_index = size_t>

const local_index& Mem_fast< Memory, local_index >::get_lin ( const local_index * part_id ) const

inline

Just return the value pointed by part_id.

Parameters

part_id

Returns: the value pointed by part_id

Definition at line 418 of file MemFast.hpp.

◆ getGhostId()

template<typename Memory = HeapMemory, typename local_index = size_t>

const local_index& Mem_fast< Memory, local_index >::getGhostId ( local_index cell_id ) const

inline

Get the index of the first ghost element.

Parameters

cell_id cell-id

Returns: a reference to the first element

Definition at line 394 of file MemFast.hpp.

◆ getGhostMarkers()

template<typename Memory = HeapMemory, typename local_index = size_t>

const openfpm::vector<size_t>& Mem_fast< Memory, local_index >::getGhostMarkers ( ) const

inline

Return the private data-structure ghostMarkers.

Returns: ghostMarkers

Definition at line 484 of file MemFast.hpp.

◆ getNelements()

template<typename Memory = HeapMemory, typename local_index = size_t>

size_t Mem_fast< Memory, local_index >::getNelements ( const local_index cell_id ) const

inline

Get the number of elements in the cell.

Parameters

cell_id id of the cell

Returns: the number of elements in the cell

Definition at line 315 of file MemFast.hpp.

◆ getStartId()

template<typename Memory = HeapMemory, typename local_index = size_t>

const local_index& Mem_fast< Memory, local_index >::getStartId ( local_index cell_id ) const

inline

Get the first element of a cell (as reference)

Parameters

cell_id cell-id

Returns: a reference to the first element

Definition at line 382 of file MemFast.hpp.

◆ getStopId()

template<typename Memory = HeapMemory, typename local_index = size_t>

const local_index& Mem_fast< Memory, local_index >::getStopId ( local_index cell_id ) const

inline

Get the last element of a cell (as reference)

Parameters

cell_id cell-id

Returns: a reference to the last element

Definition at line 406 of file MemFast.hpp.

◆ init_to_zero()

template<typename Memory = HeapMemory, typename local_index = size_t>

void Mem_fast< Memory, local_index >::init_to_zero	(	local_index	slot,
		local_index	tot_n_cell
	)

inline

Initialize the data to zero.

Parameters

slot	number of slot for each cell
tot_n_cell	total number of cells

Definition at line 162 of file MemFast.hpp.

◆ operator=() [1/2]

template<typename Memory = HeapMemory, typename local_index = size_t>

void Mem_fast< Memory, local_index >::operator= ( const Mem_fast< Memory, local_index > & mem )

inline

copy an object Mem_fast

Parameters

mem	Mem_fast to copy

Definition at line 184 of file MemFast.hpp.

◆ operator=() [2/2]

template<typename Memory = HeapMemory, typename local_index = size_t>

void Mem_fast< Memory, local_index >::operator= ( Mem_fast< Memory, local_index > && mem )

inline

copy an object Mem_fast

Parameters

mem	Mem_fast to copy

Definition at line 198 of file MemFast.hpp.

◆ pack() [1/2]

template<typename Memory = HeapMemory, typename local_index = size_t>

static bool Mem_fast< Memory, local_index >::pack ( )

inlinestatic

This Function to indicate the vector class has a packer function

Returns: true vector has a pack function

Definition at line 514 of file MemFast.hpp.

◆ pack() [2/2]

template<typename Memory = HeapMemory, typename local_index = size_t>

template<int ... prp>

void Mem_fast< Memory, local_index >::pack	(	ExtPreAlloc< HeapMemory > &	mem,
		Pack_stat &	sts
	)		const

inline

pack a vector selecting the properties to pack

Parameters

mem	preallocated memory where to pack the vector
sts	pack-stat info

Definition at line 551 of file MemFast.hpp.

◆ packRequest() [1/2]

template<typename Memory = HeapMemory, typename local_index = size_t>

static bool Mem_fast< Memory, local_index >::packRequest ( )

inlinestatic

This Function indicate that vector class has a packRequest function

Returns: true vector has a packRequest function

Definition at line 524 of file MemFast.hpp.

◆ packRequest() [2/2]

template<typename Memory = HeapMemory, typename local_index = size_t>

template<int ... prp>

void Mem_fast< Memory, local_index >::packRequest ( size_t & req ) const

inline

It calculate the number of byte required to serialize the object.

Template Parameters

prp	list of properties

Parameters

req	reference to the total counter required to pack the information

Definition at line 536 of file MemFast.hpp.

◆ private_get_cl_base()

template<typename Memory = HeapMemory, typename local_index = size_t>

const base& Mem_fast< Memory, local_index >::private_get_cl_base ( ) const

inline

Return the private data-structure cl_base.

Returns: cl_base

Definition at line 504 of file MemFast.hpp.

◆ private_get_cl_n()

template<typename Memory = HeapMemory, typename local_index = size_t>

const openfpm::vector<aggregate<local_index>,Memory>& Mem_fast< Memory, local_index >::private_get_cl_n ( ) const

inline

Return the private data-structure cl_n.

Returns: cl_n

Definition at line 474 of file MemFast.hpp.

◆ private_get_slot()

template<typename Memory = HeapMemory, typename local_index = size_t>

const int& Mem_fast< Memory, local_index >::private_get_slot ( ) const

inline

Return the private slot.

Returns: slot

Definition at line 494 of file MemFast.hpp.

◆ remove()

template<typename Memory = HeapMemory, typename local_index = size_t>

void Mem_fast< Memory, local_index >::remove	(	local_index	cell_id,
		local_index	ele
	)

inline

Remove an element in the cell.

Parameters

cell	id of the cell
ele	element id to remove

Definition at line 298 of file MemFast.hpp.

◆ set_slot()

template<typename Memory = HeapMemory, typename local_index = size_t>

void Mem_fast< Memory, local_index >::set_slot ( local_index slot )

inline

Set the number of slot for each cell.

Parameters

number of slot

Definition at line 442 of file MemFast.hpp.

◆ size()

template<typename Memory = HeapMemory, typename local_index = size_t>

size_t Mem_fast< Memory, local_index >::size ( ) const

inline

return the number of elements

Returns: the number of elements

Definition at line 141 of file MemFast.hpp.

◆ swap() [1/2]

template<typename Memory = HeapMemory, typename local_index = size_t>

void Mem_fast< Memory, local_index >::swap ( Mem_fast< Memory, local_index > && mem )

inline

swap to Mem_fast object

Parameters

mem	object to swap the memory with

Definition at line 342 of file MemFast.hpp.

◆ swap() [2/2]

template<typename Memory = HeapMemory, typename local_index = size_t>

void Mem_fast< Memory, local_index >::swap ( Mem_fast< Memory, local_index > & mem )

inline

swap to Mem_fast object

Parameters

mem	object to swap the memory with

Definition at line 326 of file MemFast.hpp.

◆ unpack()

template<typename Memory = HeapMemory, typename local_index = size_t>

template<int ... prp, typename MemType >

void Mem_fast< Memory, local_index >::unpack	(	ExtPreAlloc< MemType > &	mem,
		Unpack_stat &	ps
	)

inline

unpack a vector

Parameters

mem	preallocated memory from where to unpack the vector
ps	unpack-stat info

Definition at line 564 of file MemFast.hpp.

Field Documentation

◆ cl_base

template<typename Memory = HeapMemory, typename local_index = size_t>

base Mem_fast< Memory, local_index >::cl_base

private

elements that each cell store (each cell can store a number of elements == slot )

Definition at line 103 of file MemFast.hpp.

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

openfpm_data/src/NN/Mem_type/MemFast.hpp

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

template<typename Memory = HeapMemory, typename local_index = size_t> class Mem_fast< Memory, local_index >

Constructor & Destructor Documentation

◆ Mem_fast()

Member Function Documentation

◆ addCell()

◆ addCellGhostMarkers()

◆ copy_general()

◆ get() [1/2]

◆ get() [2/2]

◆ get_lin()

◆ getGhostId()

◆ getGhostMarkers()

◆ getNelements()

◆ getStartId()

◆ getStopId()

◆ init_to_zero()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ pack() [1/2]

◆ pack() [2/2]

◆ packRequest() [1/2]

◆ packRequest() [2/2]

◆ private_get_cl_base()

◆ private_get_cl_n()

◆ private_get_slot()

◆ remove()

◆ set_slot()

◆ size()

◆ swap() [1/2]

◆ swap() [2/2]

◆ unpack()

Field Documentation

◆ cl_base

template<typename Memory = HeapMemory, typename local_index = size_t>
class Mem_fast< Memory, local_index >