The GenericBuffer class is a templated class for buffers. More...

#include <buffers.hpp>

Collaboration diagram for GenericBuffer< AllocFunc, FreeFunc >:

Public Member Functions
	GenericBuffer (nvinfer1::DataType type=nvinfer1::DataType::kFLOAT)
	Construct an empty buffer.

	GenericBuffer (size_t size, nvinfer1::DataType type)
	Construct a buffer with the specified allocation size in bytes.

	GenericBuffer (GenericBuffer &&buf)

GenericBuffer &	operator= (GenericBuffer &&buf)

void *	data ()
	Returns pointer to underlying array.

const void *	data () const
	Returns pointer to underlying array.

size_t	size () const
	Returns the size (in number of elements) of the buffer.

size_t	nbBytes () const
	Returns the size (in bytes) of the buffer.

void	resize (size_t newSize)
	Resizes the buffer. This is a no-op if the new size is smaller than or equal to the current capacity.

void	resize (const nvinfer1::Dims &dims)
	Overload of resize that accepts Dims.

	~GenericBuffer ()

Private Attributes
size_t	mSize {0}

size_t	mCapacity {0}

nvinfer1::DataType	mType

void *	mBuffer

AllocFunc	allocFn

FreeFunc	freeFn

Detailed Description

template<typename AllocFunc, typename FreeFunc>
class GenericBuffer< AllocFunc, FreeFunc >

The GenericBuffer class is a templated class for buffers.

This templated RAII (Resource Acquisition Is Initialization) class handles the allocation, deallocation, querying of buffers on both the device and the host. It can handle data of arbitrary types because it stores byte buffers. The template parameters AllocFunc and FreeFunc are used for the allocation and deallocation of the buffer. AllocFunc must be a functor that takes in (void** ptr, size_t size) and returns bool. ptr is a pointer to where the allocated buffer address should be stored. size is the amount of memory in bytes to allocate. The boolean indicates whether or not the memory allocation was successful. FreeFunc must be a functor that takes in (void* ptr) and returns void. ptr is the allocated buffer address. It must work with nullptr input.

Definition at line 103 of file buffers.hpp.

Constructor & Destructor Documentation

◆ GenericBuffer() [1/3]

template<typename AllocFunc , typename FreeFunc >

GenericBuffer< AllocFunc, FreeFunc >::GenericBuffer ( nvinfer1::DataType type = nvinfer1::DataType::kFLOAT )

inline

Construct an empty buffer.

Definition at line 109 of file buffers.hpp.

◆ GenericBuffer() [2/3]

template<typename AllocFunc , typename FreeFunc >

GenericBuffer< AllocFunc, FreeFunc >::GenericBuffer	(	size_t	size,
		nvinfer1::DataType	type
	)

inline

Construct a buffer with the specified allocation size in bytes.

Definition at line 120 of file buffers.hpp.

◆ GenericBuffer() [3/3]

template<typename AllocFunc , typename FreeFunc >

GenericBuffer< AllocFunc, FreeFunc >::GenericBuffer ( GenericBuffer< AllocFunc, FreeFunc > && buf )

inline

Definition at line 131 of file buffers.hpp.

◆ ~GenericBuffer()

template<typename AllocFunc , typename FreeFunc >

GenericBuffer< AllocFunc, FreeFunc >::~GenericBuffer ( )

inline

Definition at line 217 of file buffers.hpp.

Member Function Documentation

◆ data() [1/2]

template<typename AllocFunc , typename FreeFunc >

void * GenericBuffer< AllocFunc, FreeFunc >::data ( )

inline

Returns pointer to underlying array.

Definition at line 163 of file buffers.hpp.

Referenced by adcCtrl.AdcFitter::clear(), utils.AdcFitter::clear(), camtipSR.utils.camtipFitter::clear(), adcCtrl.AdcFitter::cost(), utils.AdcFitter::cost(), adcCtrl.AdcFitter::estimate_angle(), utils.AdcFitter::estimate_angle(), adcCtrl.AdcFitter::estimate_centroid(), utils.AdcFitter::estimate_centroid(), adcCtrl.AdcFitter::find_speckle_angles2(), utils.AdcFitter::find_speckle_angles2(), and camtipSR.utils.camtipFitter::set_data().

◆ data() [2/2]

template<typename AllocFunc , typename FreeFunc >

const void * GenericBuffer< AllocFunc, FreeFunc >::data ( ) const

inline

Returns pointer to underlying array.

Definition at line 171 of file buffers.hpp.

Referenced by adcCtrl.AdcFitter::clear(), utils.AdcFitter::clear(), camtipSR.utils.camtipFitter::clear(), adcCtrl.AdcFitter::cost(), utils.AdcFitter::cost(), adcCtrl.AdcFitter::estimate_angle(), utils.AdcFitter::estimate_angle(), adcCtrl.AdcFitter::estimate_centroid(), utils.AdcFitter::estimate_centroid(), adcCtrl.AdcFitter::find_speckle_angles2(), utils.AdcFitter::find_speckle_angles2(), and camtipSR.utils.camtipFitter::set_data().

◆ nbBytes()

template<typename AllocFunc , typename FreeFunc >

size_t GenericBuffer< AllocFunc, FreeFunc >::nbBytes ( ) const

inline

Returns the size (in bytes) of the buffer.

Definition at line 187 of file buffers.hpp.

Referenced by GenericBuffer< AllocFunc, FreeFunc >::GenericBuffer(), and GenericBuffer< AllocFunc, FreeFunc >::resize().

◆ operator=()

template<typename AllocFunc , typename FreeFunc >

GenericBuffer & GenericBuffer< AllocFunc, FreeFunc >::operator= ( GenericBuffer< AllocFunc, FreeFunc > && buf )

inline

Definition at line 143 of file buffers.hpp.

◆ resize() [1/2]

template<typename AllocFunc , typename FreeFunc >

void GenericBuffer< AllocFunc, FreeFunc >::resize ( const nvinfer1::Dims & dims )

inline

Overload of resize that accepts Dims.

Definition at line 212 of file buffers.hpp.

◆ resize() [2/2]

template<typename AllocFunc , typename FreeFunc >

void GenericBuffer< AllocFunc, FreeFunc >::resize ( size_t newSize )

inline

Resizes the buffer. This is a no-op if the new size is smaller than or equal to the current capacity.

Definition at line 195 of file buffers.hpp.

Referenced by GenericBuffer< AllocFunc, FreeFunc >::resize().

◆ size()

template<typename AllocFunc , typename FreeFunc >

size_t GenericBuffer< AllocFunc, FreeFunc >::size ( ) const

inline

Returns the size (in number of elements) of the buffer.

Definition at line 179 of file buffers.hpp.

Referenced by GenericBuffer< AllocFunc, FreeFunc >::nbBytes().

Member Data Documentation

◆ allocFn

template<typename AllocFunc , typename FreeFunc >

AllocFunc GenericBuffer< AllocFunc, FreeFunc >::allocFn

private

Definition at line 226 of file buffers.hpp.

Referenced by GenericBuffer< AllocFunc, FreeFunc >::GenericBuffer(), and GenericBuffer< AllocFunc, FreeFunc >::resize().

◆ freeFn

template<typename AllocFunc , typename FreeFunc >

FreeFunc GenericBuffer< AllocFunc, FreeFunc >::freeFn

private

Definition at line 227 of file buffers.hpp.

Referenced by GenericBuffer< AllocFunc, FreeFunc >::~GenericBuffer(), GenericBuffer< AllocFunc, FreeFunc >::operator=(), and GenericBuffer< AllocFunc, FreeFunc >::resize().

◆ mBuffer

template<typename AllocFunc , typename FreeFunc >

void* GenericBuffer< AllocFunc, FreeFunc >::mBuffer

private

Definition at line 225 of file buffers.hpp.

Referenced by GenericBuffer< AllocFunc, FreeFunc >::GenericBuffer(), GenericBuffer< AllocFunc, FreeFunc >::~GenericBuffer(), GenericBuffer< AllocFunc, FreeFunc >::data(), GenericBuffer< AllocFunc, FreeFunc >::data(), GenericBuffer< AllocFunc, FreeFunc >::operator=(), and GenericBuffer< AllocFunc, FreeFunc >::resize().

◆ mCapacity

template<typename AllocFunc , typename FreeFunc >

size_t GenericBuffer< AllocFunc, FreeFunc >::mCapacity {0}

private

Definition at line 223 of file buffers.hpp.

Referenced by GenericBuffer< AllocFunc, FreeFunc >::operator=(), and GenericBuffer< AllocFunc, FreeFunc >::resize().

◆ mSize

template<typename AllocFunc , typename FreeFunc >

size_t GenericBuffer< AllocFunc, FreeFunc >::mSize {0}

private

Definition at line 223 of file buffers.hpp.

Referenced by GenericBuffer< AllocFunc, FreeFunc >::operator=(), GenericBuffer< AllocFunc, FreeFunc >::resize(), and GenericBuffer< AllocFunc, FreeFunc >::size().

◆ mType

template<typename AllocFunc , typename FreeFunc >

nvinfer1::DataType GenericBuffer< AllocFunc, FreeFunc >::mType

private

Definition at line 224 of file buffers.hpp.

Referenced by GenericBuffer< AllocFunc, FreeFunc >::nbBytes(), and GenericBuffer< AllocFunc, FreeFunc >::operator=().

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

apps/nnReconstructor/OLD/buffers.hpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GenericBuffer() [1/3]

◆ GenericBuffer() [2/3]

◆ GenericBuffer() [3/3]

◆ ~GenericBuffer()

Member Function Documentation

◆ data() [1/2]

◆ data() [2/2]

◆ nbBytes()

◆ operator=()

◆ resize() [1/2]

◆ resize() [2/2]

◆ size()

Member Data Documentation

◆ allocFn

◆ freeFn

◆ mBuffer

◆ mCapacity

◆ mSize

◆ mType