Implementation of 1-D std::vector like structure. More...

Detailed Description

template<typename T, typename Memory, typename layout, template< typename > class layout_base, typename grow_p>
class openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >

Implementation of 1-D std::vector like structure.

Add and access elements

    openfpm::vector< aggregate<float,float,float,float,float[3],float[3][3],openfpm::vector<int>> > v_ofp_test;
    for (size_t i = 0 ; i < n_ele ; i++)
    {
        v_ofp_test.add();
        size_t last = v_ofp_test.size()-1;
        // Modify the point
        v_ofp_test.get<P::x>(last) = 100.0 + i;
        v_ofp_test.get<P::y>(last) = 102.0 + i;
        v_ofp_test.get<P::z>(last) = 107.0 + i;
        v_ofp_test.get<P::s>(last) = 109.0 + i;
        v_ofp_test.get<P::v>(last)[0] = 1.0 + i;
        v_ofp_test.get<P::v>(last)[1] = 2.0 + i;
        v_ofp_test.get<P::v>(last)[2] = 7.0 + i;
        v_ofp_test.get<P::t>(last)[0][0] = 10.0 + i;
        v_ofp_test.get<P::t>(last)[0][1] = 13.0 + i;
        v_ofp_test.get<P::t>(last)[0][2] = 8.0 + i;
        v_ofp_test.get<P::t>(last)[1][0] = 19.0 + i;
        v_ofp_test.get<P::t>(last)[1][1] = 23.0 + i;
        v_ofp_test.get<P::t>(last)[1][2] = 5.0 + i;
        v_ofp_test.get<P::t>(last)[2][0] = 4.0 + i;
        v_ofp_test.get<P::t>(last)[2][1] = 3.0 + i;
        v_ofp_test.get<P::t>(last)[2][2] = 11.0 + i;
    }

Template Parameters

T	type of object the vector store
Memory	allocator to use
layout	layout to use
grow_p	grow policy for vector in case of reallocation

OPENFPM_NATIVE implementation

Definition at line 96 of file map_vector.hpp.

#include <map_vector.hpp>

Data Structures
struct	pack_cond
	Structures that do a nested packing, depending on the existence of 'pack()' function inside the object. More...

struct	pack_cond< true, T1, Memory1, prp...>
	Structures that do a nested packing, depending on the existence of 'pack()' function inside the object. More...

struct	pack_simple_cond
	These structures serialize a simple (no "pack()" inside) object. More...

struct	pack_simple_cond< true, prp...>
	These structures serialize a simple (no "pack()" inside) object. More...

struct	packMem_cond
	Structures that calculate how many bytes are required to serialize an object. More...

struct	packMem_cond< true, T1 >
	Structures that calculate memory for an object, depending on the existence of 'packMem()'. More...

struct	unpack_simple_cond
	These structures do an de-serialize a simple object (no pack() inside) More...

struct	unpack_simple_cond< true, prp...>

Public Types
typedef int	yes_i_am_vector
	it define that it is a vector

typedef layout	layout_type
	Type of the encapsulation memory parameter.

typedef vector_key_iterator	iterator_key
	iterator for the vector

typedef grid_cpu< 1, T, Memory, typename layout_base< T > ::type >::container	container
	Object container for T, it is the return type of get_o it return a object type trough.

typedef T	value_type
	Type of the value the vector is storing.

typedef size_t	access_key
	Access key for the vector.

Public Member Functions
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< Memory > &mem, Pack_stat &sts) const
	pack a vector selecting the properties to pack More...

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

size_t	size () const
	Return the size of the vector. More...

void	reserve (size_t sp)
	Reserve slots in the vector to avoid reallocation. More...

void	clear ()
	Clear the vector. More...

void	resize (size_t slot)
	Resize the vector. More...

void	add ()
	It insert a new emtpy object on the vector, eventually it reallocate the grid. More...

void	add (const T &v)
	It insert a new object on the vector, eventually it reallocate the grid. More...

void	add (const typename grid_cpu< 1, T, Memory, typename layout_base< T >::type >::container &v)
	It insert a new object on the vector, eventually it reallocate the vector. More...

template<typename M , typename gp >
void	add (const vector< T, M, layout, layout_base, gp, OPENFPM_NATIVE > &v)
	It add the element of another vector to this vector. More...

template<template< typename, typename > class op, typename S , typename M , typename gp , unsigned int... args>
void	merge_prp (const vector< S, M, typename layout_base< S >::type, layout_base, gp, OPENFPM_NATIVE > &v, const openfpm::vector< size_t > &opart)
	It merge the elements of a source vector to this vector. More...

template<template< typename, typename > class op, typename S , typename M , typename gp , template< typename > class layout_base2, unsigned int... args>
void	merge_prp_v (const vector< S, M, typename layout_base2< S >::type, layout_base2, gp, OPENFPM_NATIVE > &v, const openfpm::vector< aggregate< size_t, size_t >> &opart)
	It merge the elements of a source vector to this vector. More...

template<template< typename, typename > class op, typename S , typename M , typename gp , template< typename > class layout_base2, unsigned int... args>
void	merge_prp_v (const vector< S, M, typename layout_base2< S >::type, layout_base2, gp, OPENFPM_NATIVE > &v, size_t start)
	It merge the elements of a source vector to this vector. More...

template<typename S , typename M , typename gp , unsigned int impl, template< typename > class layout_base2, unsigned int... args>
void	add_prp (const vector< S, M, typename layout_base2< S >::type, layout_base2, gp, impl > &v)
	It add the element of a source vector to this vector. More...

void	insert (size_t key)
	Insert an entry in the vector. More...

void	remove (size_t key)
	Remove one entry from the vector. More...

void	remove (openfpm::vector< size_t > &keys, size_t start=0)
	Remove several entries from the vector. More...

template<unsigned int p>
auto	get (size_t id) const -> decltype(base.template get< p >(grid_key_dx< 1 >(0)))
	Get an element of the vector. More...

auto	get (size_t id) -> decltype(base.get_o(grid_key_dx< 1 >(id)))
	Get an element of the vector. More...

auto	get (size_t id) const -> const decltype(base.get_o(grid_key_dx< 1 >(id)))
	Get an element of the vector. More...

const grid_cpu< 1, T, Memory, typename layout_base< T > ::type >::container	get_o (size_t id) const
	Get an element of the vector. More...

const grid_cpu< 1, T, Memory, typename layout_base< T > ::type >::container	last () const
	Get the last element of the vector. More...

template<unsigned int p>
auto	get (size_t id) -> decltype(base.template get< p >(grid_key_dx< 1 >(0)))
	Get an element of the vector. More...

grid_cpu< 1, T, Memory, typename layout_base< T > ::type >::container	last ()
	Get the last element of the vector. More...

	~vector () THROW
	Destructor.

vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >	duplicate () const
	It duplicate the vector. More...

	vector (vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE > &&v)
	Constructor from another temporal vector. More...

	vector (const vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE > &v) THROW
	Constructor from another constant vector. More...

	vector () THROW
	Constructor, vector of size 0.

	vector (size_t sz) THROW
	Constructor, vector of size sz.

void	set (size_t id, const typename grid_cpu< 1, T, Memory, typename layout_base< T >::type >::container &obj)
	Set the object id to obj. More...

template<typename encap_S , unsigned int... args>
void	set_o (size_t i, const encap_S &obj)
	It set an element of the vector from a object that is a subset of the vector properties. More...

void	set (size_t id, const T &obj)
	Set the object id to obj. More...

void	set (size_t id, vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE > &v, size_t src)
	Set the element of the vector v from another element of another vector. More...

vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE > &	operator= (vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE > &&mv)
	Assignment operator. More...

vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE > &	operator= (const vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE > &mv)
	Assignment operator. More...

template<typename Mem , typename gp >
vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE > &	operator= (vector< T, Mem, layout, layout_base, gp, OPENFPM_NATIVE > &&mv)
	Assignment operator. More...

template<typename Mem , typename gp >
vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE > &	operator= (const vector< T, Mem, layout, layout_base, gp, OPENFPM_NATIVE > &mv)
	Assignment operator. More...

bool	operator!= (const vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE > &v) const
	Check that two vectors are equal. More...

bool	operator== (const vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE > &v) const
	Check that two vectors are not equal. More...

void	swap (openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE > &v)
	Swap the memory with another vector. More...

void	swap (openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE > &&v)
	Swap the memory with another vector. More...

vector_key_iterator	getIteratorFrom (size_t start) const
	Get iterator over the particles from a particular index. More...

vector_key_iterator	getIteratorTo (size_t stop) const
	Get iterator over the particles from 0 until a particular index. More...

vector_key_iterator	getIterator () const
	Get the vector elements iterator. More...

size_t	packObjectSize ()
	Return the size of the message needed to pack this object. More...

size_t	packObject (void *mem)
	Pack the object into the given pointer. More...

void	setMemory (Memory &mem)
	Set the memory of the base structure using an object. More...

void *	getPointer ()
	Return the pointer that store the data. More...

const void *	getPointer () const
	Return the pointer that store the data. More...

long int	who ()

const size_t &	getInternal_v_size () const
	Internal function. More...

const grid_cpu< 1, T, Memory, layout > &	getInternal_base () const
	Internal function. More...

Static Public Member Functions
static bool	pack ()

static bool	packRequest ()

static bool	packMem ()

template<int... prp>
static size_t	calculateMem (size_t n, size_t e)
	Calculate the memory size required to allocate n elements. More...

template<int... prp>
static size_t	packMem (size_t n, size_t e)
	Calculate the memory size required to pack n elements. More...

static size_t	calculateNMem (size_t n)
	How many allocation are required to create n-elements. More...

static bool	noPointers ()
	This class has pointer inside. More...

Private Member Functions
void	non_zero_one (size_t sz[1], size_t arg)
	If the argument is zero return 1 otherwise return the argument. More...

Private Attributes
size_t	v_size

grid_cpu< 1, T, Memory, typename layout_base< T > ::type >	base
	1-D static grid

Constructor & Destructor Documentation

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::vector ( vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE > && v )

inline

Constructor from another temporal vector.

Parameters

v	the vector

Definition at line 844 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::vector ( const vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE > & v )

inline

Constructor from another constant vector.

Parameters

v	the vector

Definition at line 859 of file map_vector.hpp.

Member Function Documentation

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

void openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::add ( )

inline

It insert a new emtpy object on the vector, eventually it reallocate the grid.

Warning: It is not thread safe should not be used in multi-thread environment reallocation, work only on cpu

Check if we have enough space

Resize the memory, double up the actual memory allocated for the vector

increase the vector size

Definition at line 243 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

void openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::add ( const T & v )

inline

It insert a new object on the vector, eventually it reallocate the grid.

Parameters

v	element to add

Warning: It is not thread safe should not be used in multi-thread environment reallocation, work only on cpu

Check if we have enough space

Resize the memory, double up the actual memory allocated for the vector

copy the element

increase the vector size

Definition at line 270 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

void openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::add ( const typename grid_cpu< 1, T, Memory, typename layout_base< T >::type >::container & v )

inline

It insert a new object on the vector, eventually it reallocate the vector.

Parameters

v	object (encapsulated)

Warning: It is not thread safe should not be used in multi-thread environment reallocation, work only on cpu

Check if we have enough space

Resize the memory, double up the actual memory allocated for the vector

copy the added element

increase the vector size

Definition at line 301 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

template<typename M , typename gp >

void openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::add ( const vector< T, M, layout, layout_base, gp, OPENFPM_NATIVE > & v )

inline

It add the element of another vector to this vector.

Parameters

v	from where to take the vector

Add the element of v

Definition at line 328 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

template<typename S , typename M , typename gp , unsigned int impl, template< typename > class layout_base2, unsigned int... args>

void openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::add_prp ( const vector< S, M, typename layout_base2< S >::type, layout_base2, gp, impl > & v )

inline

It add the element of a source vector to this vector.

The number of properties in the source vector must be smaller than the destination all the properties of S must be mapped so if S has 3 properties 3 numbers for args are required

Template Parameters

S	Base object of the source vector
M	memory type of the source vector
gp	Grow policy of the source vector
args	one or more number that define which property to set-up

Parameters

v	source vector

Add the element of v

Definition at line 549 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

template<int... prp>

static size_t openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::calculateMem	(	size_t	n,
		size_t	e
	)

inlinestatic

Calculate the memory size required to allocate n elements.

Calculate the total size required to store n-elements in a vector

Parameters

n	number of elements
e	unused

Returns: the size of the allocation number e

Definition at line 1220 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

static size_t openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::calculateNMem ( size_t n )

inlinestatic

How many allocation are required to create n-elements.

Parameters

n	number of elements

Returns: the number of allocations

Definition at line 1264 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

void openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::clear ( )

inline

Clear the vector.

Eliminate all the elements for from the vector

Definition at line 199 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

vector<T, Memory,layout,layout_base,grow_p,OPENFPM_NATIVE> openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::duplicate ( ) const

inline

It duplicate the vector.

Returns: a duplicated vector

Definition at line 826 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

template<unsigned int p>

auto openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::get ( size_t id ) const -> decltype(base.template get<p>(grid_key_dx<1>(0)))

inline

Get an element of the vector.

Get an element of the vector

Template Parameters

p	Property to get

Parameters

id	Element to get

Returns: the element value requested

Definition at line 673 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

auto openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::get ( size_t id ) -> decltype(base.get_o(grid_key_dx<1>(id)))

inline

Get an element of the vector.

Get an element of the vector

Parameters

id	Element to get

Returns: the element (encapsulated)

Definition at line 695 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

auto openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::get ( size_t id ) const -> const decltype(base.get_o(grid_key_dx<1>(id)))

inline

Get an element of the vector.

Get an element of the vector

Parameters

id	Element to get

Returns: the element (encapsulated)

Definition at line 717 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

template<unsigned int p>

auto openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::get ( size_t id ) -> decltype(base.template get<p>(grid_key_dx<1>(0)))

inline

Get an element of the vector.

Get an element of the vector

Template Parameters

p	Property to get

Parameters

id	Element to get

Returns: the element value requested

Definition at line 783 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

const grid_cpu<1,T,Memory,typename layout_base<T>::type>::container openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::get_o ( size_t id ) const

inline

Get an element of the vector.

Deprecated:

exactly as get, exist to keep the compatibility with grid

Parameters

id	Element to get

Returns: the element (encapsulated)

Definition at line 742 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

const grid_cpu<1,T,Memory,layout>& openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::getInternal_base ( ) const

inline

Internal function.

Returns: the internal 1D grid base

Definition at line 1347 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

const size_t& openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::getInternal_v_size ( ) const

inline

Internal function.

Returns: the size of the vector

Definition at line 1337 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

vector_key_iterator openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::getIterator ( ) const

inline

Get the vector elements iterator.

Returns: an iterator to iterate through all the elements of the vector

Definition at line 1173 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

vector_key_iterator openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::getIteratorFrom ( size_t start ) const

inline

Get iterator over the particles from a particular index.

Parameters

start starting point

Returns: an iterator to iterate from a particular index

Definition at line 1141 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

vector_key_iterator openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::getIteratorTo ( size_t stop ) const

inline

Get iterator over the particles from 0 until a particular index.

Warning: stop point is not included

Parameters

stop	stop point

Returns: an iterator to iterate until a particular index

Definition at line 1158 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

void* openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::getPointer ( )

inline

Return the pointer that store the data.

Returns: the pointer that store the data

Definition at line 1287 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

const void* openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::getPointer ( ) const

inline

Return the pointer that store the data.

Returns: the pointer that store the data

Definition at line 1300 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

void openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::insert ( size_t key )

inline

Insert an entry in the vector.

key Where to insert the element

Definition at line 570 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

const grid_cpu<1,T,Memory,typename layout_base<T>::type >::container openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::last ( ) const

inline

Get the last element of the vector.

Returns: the last element (encapsulated)

Definition at line 761 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

grid_cpu<1,T,Memory,typename layout_base<T>::type >::container openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::last ( )

inline

Get the last element of the vector.

Returns: the element (encapsulated)

Definition at line 802 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

template<template< typename, typename > class op, typename S , typename M , typename gp , unsigned int... args>

void openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::merge_prp	(	const vector< S, M, typename layout_base< S >::type, layout_base, gp, OPENFPM_NATIVE > &	v,
		const openfpm::vector< size_t > &	opart
	)

inline

It merge the elements of a source vector to this vector.

Given 2 vector v1 and v2 of size 7,3. and as merging operation the function add. Merging the second vector v2 to the first one v1 starting from the element 2. Mean

*
* 6   8  3   2  1   0  3    v1 elements
*        |   |  |
*       op  op  op
*        |   |  |
*        5   1  9           v2 elements
*
*-------------------------------------
* 6   8  8   3  10  0   3   updated v1 elements
*
* This operation is done for each selected property in args
*
*

The number of properties in the source vector must be smaller than the destination all the properties of S must be mapped so if S has 3 properties 3 numbers for args are required

Template Parameters

op	merging operation
S	Base object of the source vector
M	memory type of the source vector
gp	Grow policy of the source vector
args	one or more number that define which property to set-up

Parameters

v	source vector
start	index from where to start the merging

Add the element of v

Definition at line 374 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

template<template< typename, typename > class op, typename S , typename M , typename gp , template< typename > class layout_base2, unsigned int... args>

void openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::merge_prp_v	(	const vector< S, M, typename layout_base2< S >::type, layout_base2, gp, OPENFPM_NATIVE > &	v,
		const openfpm::vector< aggregate< size_t, size_t >> &	opart
	)

inline

It merge the elements of a source vector to this vector.

Given 2 vector v1 and v2 of size 7,3. and as merging operation the function add. Merging the second vector v2 to the first one v1 starting from the element 2. Mean

6 8 8 3 10 0 3 updated v1 elements

This operation is done for each selected property in args

The number of properties in the source vector must be smaller than the destination all the properties of S must be mapped so if S has 3 properties 3 numbers for args are required

Template Parameters

op	merging operation
S	Base object of the source vector
M	memory type of the source vector
gp	Grow policy of the source vector
args	one or more number that define which property to set-up

Parameters

v	source vector
start	index from where to start the merging

Add the element of v

Definition at line 442 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

template<template< typename, typename > class op, typename S , typename M , typename gp , template< typename > class layout_base2, unsigned int... args>

void openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::merge_prp_v	(	const vector< S, M, typename layout_base2< S >::type, layout_base2, gp, OPENFPM_NATIVE > &	v,
		size_t	start
	)

inline

It merge the elements of a source vector to this vector.

Given 2 vector v1 and v2 of size 7,3. and as merging operation the function add. Merging the second vector v2 to the first one v1 starting from the element 2. Mean

6 8 8 3 10 0 3 updated v1 elements

This operation is done for each selected property in args

The number of properties in the source vector must be smaller than the destination all the properties of S must be mapped so if S has 3 properties 3 numbers for args are required

Template Parameters

op	merging operation
S	Base object of the source vector
M	memory type of the source vector
gp	Grow policy of the source vector
args	one or more number that define which property to set-up

Parameters

v	source vector
start	index from where to start the merging

Add the element of v

Definition at line 509 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

void openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::non_zero_one	(	size_t	sz[1],
		size_t	arg
	)

inlineprivate

If the argument is zero return 1 otherwise return the argument.

Parameters

sz	output
arg	argument

Definition at line 112 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

static bool openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::noPointers ( )

inlinestatic

This class has pointer inside.

Returns: false

Definition at line 1313 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

bool openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::operator!= ( const vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE > & v ) const

inline

Check that two vectors are equal.

Parameters

vector to compare

Definition at line 1069 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

vector<T, Memory,layout,layout_base,grow_p,OPENFPM_NATIVE>& openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::operator= ( vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE > && mv )

inline

Assignment operator.

move semantic movement operator=

Parameters

mv vector

Returns: itself

Definition at line 976 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

vector<T, Memory,layout,layout_base,grow_p,OPENFPM_NATIVE>& openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::operator= ( const vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE > & mv )

inline

Assignment operator.

it copy

Parameters

mv vector

Returns: itself

Definition at line 996 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

template<typename Mem , typename gp >

vector<T, Memory,layout,layout_base,grow_p,OPENFPM_NATIVE>& openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::operator= ( vector< T, Mem, layout, layout_base, gp, OPENFPM_NATIVE > && mv )

inline

Assignment operator.

move semantic movement operator=

Parameters

mv vector

Returns: itself

Definition at line 1025 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

template<typename Mem , typename gp >

vector<T, Memory,layout,layout_base,grow_p,OPENFPM_NATIVE>& openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::operator= ( const vector< T, Mem, layout, layout_base, gp, OPENFPM_NATIVE > & mv )

inline

Assignment operator.

it copy

Parameters

mv vector

Returns: itself

Definition at line 1045 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

bool openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::operator== ( const vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE > & v ) const

inline

Check that two vectors are not equal.

Parameters

vector to compare

Definition at line 1079 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

static bool openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::pack ( )

inlinestatic

This file contains the implemetation of packer and unpacker for vector Created on: Jan 5, 2016 Author: Yaroslav Zaluzhnyi and Pietro Incardona

This Function to indicate the vector class has a packer function

Returns: true vector has a pack function

Definition at line 13 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

template<int... prp>

void openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::pack	(	ExtPreAlloc< Memory > &	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 312 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

static bool openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::packMem ( )

inlinestatic

This Function indicate that vector class has a packMem function

Returns: true vector has a packMem function

Definition at line 33 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

template<int... prp>

static size_t openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::packMem	(	size_t	n,
		size_t	e
	)

inlinestatic

Calculate the memory size required to pack n elements.

Calculate the total size required to store n-elements in a vector

Parameters

n	number of elements
e	unused

Returns: the size of the allocation number e

Definition at line 1247 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

size_t openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::packObject ( void * mem )

inline

Pack the object into the given pointer.

Parameters

mem pointer

Returns: the size of the packed message

Definition at line 1202 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

size_t openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::packObjectSize ( )

inline

Return the size of the message needed to pack this object.

Returns: The size

Definition at line 1187 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

static bool openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::packRequest ( )

inlinestatic

This Function indicate that vector class has a packRequest function

Returns: true vector has a packRequest function

Definition at line 23 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

template<int... prp>

void openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::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 283 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

void openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::remove ( size_t key )

inline

Remove one entry from the vector.

Parameters

key	element to remove

Definition at line 595 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

void openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::remove	(	openfpm::vector< size_t > &	keys,
		size_t	start = `0`
	)

inline

Remove several entries from the vector.

Warning: the keys in the vector MUST be sorted

Parameters

keys	objects id to remove
start	key starting point

Definition at line 624 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

void openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::reserve ( size_t sp )

inline

Reserve slots in the vector to avoid reallocation.

Reserve slots in the vector to avoid reallocation

Parameters

sp	number of slot to reserve

Resize the memory

Definition at line 181 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

void openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::resize ( size_t slot )

inline

Resize the vector.

Resize the vector and allocate n elements

Parameters

slot	number of elements

Resize the memory

Definition at line 214 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

void openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::set	(	size_t	id,
		const typename grid_cpu< 1, T, Memory, typename layout_base< T >::type >::container &	obj
	)

inline

Set the object id to obj.

Parameters

id	element
obj	object (encapsulated)

copy the element

Definition at line 894 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

void openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::set	(	size_t	id,
		const T &	obj
	)

inline

Set the object id to obj.

Parameters

id
obj

copy the element

Definition at line 937 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

void openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::set	(	size_t	id,
		vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE > &	v,
		size_t	src
	)

inline

Set the element of the vector v from another element of another vector.

Parameters

id	element id
v	vector source
src	source element

Definition at line 956 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

template<typename encap_S , unsigned int... args>

void openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::set_o	(	size_t	i,
		const encap_S &	obj
	)

inline

It set an element of the vector from a object that is a subset of the vector properties.

The number of properties in the source vector must be smaller than the destination all the properties of S must be mapped so if S has 3 properties 3 numbers for args are required

Template Parameters

encap_S	object that encapsulate the object
args	ids of the properties to map the object to

Parameters

i	element to set
obj	object that encapsulate the object
v	source vector

Definition at line 921 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

void openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::setMemory ( Memory & mem )

inline

Set the memory of the base structure using an object.

Parameters

mem	Memory object to use for allocation

Definition at line 1274 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

size_t openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::size ( ) const

inline

Return the size of the vector.

Returns: the size

Definition at line 165 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

void openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::swap ( openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE > & v )

inline

Swap the memory with another vector.

Parameters

v vector

Definition at line 1101 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

void openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::swap ( openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE > && v )

inline

Swap the memory with another vector.

Parameters

v vector

Definition at line 1120 of file map_vector.hpp.

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

template<int... prp>

void openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::unpack	(	ExtPreAlloc< Memory > &	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 340 of file map_vector.hpp.

Field Documentation

template<typename T , typename Memory , typename layout , template< typename > class layout_base, typename grow_p >

size_t openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >::v_size

private

Actual size of the vector, warning: it is not the space allocated in grid grid size increase by a fixed amount every time we need a vector bigger than the actually allocated space

Definition at line 101 of file map_vector.hpp.

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

openfpm_data/src/Vector/map_vector.hpp

Detailed Description

template<typename T, typename Memory, typename layout, template< typename > class layout_base, typename grow_p> class openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >

Add and access elements

Data Structures

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation

template<typename T, typename Memory, typename layout, template< typename > class layout_base, typename grow_p>
class openfpm::vector< T, Memory, layout, layout_base, grow_p, OPENFPM_NATIVE >