geos::LifoStorage< T, INDEX_TYPE > Class Template Reference

#include <LifoStorage.hpp>

Public Member Functions
	LifoStorage (std::string name, size_t elemCnt, int numberOfBuffersToStoreOnDevice, int numberOfBuffersToStoreOnHost, int maxNumberOfBuffers)
	LifoStorage (std::string name, arrayView1d< T > array, int numberOfBuffersToStoreOnDevice, int numberOfBuffersToStoreOnHost, int maxNumberOfBuffers)
void	pushAsync (arrayView1d< T > array)
void	pushWait ()
void	push (arrayView1d< T > array)
void	popAsync (arrayView1d< T > array)
void	popWait ()
void	pop (arrayView1d< T > array)
bool	empty ()

Detailed Description

template<typename T, typename INDEX_TYPE>
class geos::LifoStorage< T, INDEX_TYPE >

This class is used to store in a LIFO way buffers, first on device, then on host, then on disk.

Definition at line 43 of file LifoStorage.hpp.

Constructor & Destructor Documentation

LifoStorage() [1/2]

template<typename T , typename INDEX_TYPE >

geos::LifoStorage< T, INDEX_TYPE >::LifoStorage ( std::string  name, size_t  elemCnt, int  numberOfBuffersToStoreOnDevice, int  numberOfBuffersToStoreOnHost, int  maxNumberOfBuffers  )

inline

A LIFO storage will store numberOfBuffersToStoreDevice buffer on deevice, numberOfBuffersToStoreHost on host and the rest on disk.

Parameters

name	Prefix of the files used to save the occurenncy of the saved buffer on disk.
elemCnt	Number of elments in the LvArray we want to store in the LIFO storage.
numberOfBuffersToStoreOnDevice	Maximum number of array to store on device memory. If negative opposite of the percent of left memory we want to use( -80 = use 80% of remaining memory ).
numberOfBuffersToStoreOnHost	Maximum number of array to store on host memory . If negative opposite of the percent of left memory we want to use( -80 = use 80% of remaining memory ).
maxNumberOfBuffers	Number of arrays expected to be stores in the LIFO.

Definition at line 61 of file LifoStorage.hpp.

LifoStorage() [2/2]

template<typename T , typename INDEX_TYPE >

geos::LifoStorage< T, INDEX_TYPE >::LifoStorage ( std::string  name, arrayView1d< T >  array, int  numberOfBuffersToStoreOnDevice, int  numberOfBuffersToStoreOnHost, int  maxNumberOfBuffers  )

inline

Build a LIFO storage for a given LvArray array.

Parameters

name	Prefix of the files used to save the occurenncy of the saved buffer on disk.
array	The LvArray that will be store in the LIFO.
numberOfBuffersToStoreOnDevice	Maximum number of array to store on device memory.
numberOfBuffersToStoreOnHost	Maximum number of array to store on host memory.
maxNumberOfBuffers	Number of arrays expected to be stores in the LIFO.

Definition at line 105 of file LifoStorage.hpp.

Member Function Documentation

empty()

template<typename T , typename INDEX_TYPE >

bool geos::LifoStorage< T, INDEX_TYPE >::empty ( )

inline

Check if the LIFO is empty

Returns

true if the LIFO does not contain a buffer.

Definition at line 178 of file LifoStorage.hpp.

pop()

template<typename T , typename INDEX_TYPE >

void geos::LifoStorage< T, INDEX_TYPE >::pop ( arrayView1d< T >  array )

inline

Copy last data from the LIFO into the LvArray.

Parameters

array

LvArray to store data from the LIFO into it.

Definition at line 166 of file LifoStorage.hpp.

popAsync()

template<typename T , typename INDEX_TYPE >

void geos::LifoStorage< T, INDEX_TYPE >::popAsync ( arrayView1d< T >  array )

inline

Asynchroneously copy last data from the LIFO into the LvArray.

Parameters

array

LvArray to store data from the LIFO into it.

Definition at line 145 of file LifoStorage.hpp.

popWait()

template<typename T , typename INDEX_TYPE >

void geos::LifoStorage< T, INDEX_TYPE >::popWait ( )

inline

Waits for last pop to be terminated

Definition at line 155 of file LifoStorage.hpp.

push()

template<typename T , typename INDEX_TYPE >

void geos::LifoStorage< T, INDEX_TYPE >::push ( arrayView1d< T >  array )

inline

Push a copy of the given LvArray into the LIFO

Parameters

array

The LvArray to store in the LIFO, should match the size of the data used in constructor.

Definition at line 133 of file LifoStorage.hpp.

pushAsync()

template<typename T , typename INDEX_TYPE >

void geos::LifoStorage< T, INDEX_TYPE >::pushAsync ( arrayView1d< T >  array )

inline

Asynchroneously push a copy of the given LvArray into the LIFO

Parameters

array

The LvArray to store in the LIFO, should match the size of the data used in constructor.

Definition at line 113 of file LifoStorage.hpp.

pushWait()

template<typename T , typename INDEX_TYPE >

void geos::LifoStorage< T, INDEX_TYPE >::pushWait ( )

inline

Waits for last push to be terminated

Definition at line 122 of file LifoStorage.hpp.

---

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

• coreComponents/common/LifoStorage.hpp