mmind::eye::BatchArray< ElementData > Class Template Reference

Represents the data struct of the profile data. More...

#include <BatchArray.h>

Public Member Functions
	BatchArray (size_t width)
	Describes a constructor.
	~BatchArray ()=default
	Describes a destructor.
size_t	width () const
	Returns the width of the BatchArray object.
size_t	height () const
	Returns the height of the BatchArray object.
void	setHeight (size_t height)
	Sets the height of the BatchArray object.
size_t	capacity () const
	Returns the size of the storage space currently allocated for the BatchArray object, expressed in number of lines.
bool	isEmpty () const
	Returns true if the BatchArray object has no elements.
void	reserve (size_t height)
	Requests for enough capacity of the BatchArray object to contain the number of lines corresponding to the height.
bool	append (const BatchArray &data)
	Appends the data variable onto the end of this BatchArray object.
const ElementData *	data () const
	Returns the pointer to the element data.
ElementData *	data ()
	Returns the pointer to the element data.
const ElementData &	operator[] (std::size_t n) const
	Returns a const element reference to the specified index in the BatchArray object using the operator [].
ElementData &	operator[] (std::size_t n)
	Returns an element reference to the specified index in the BatchArray object using the operator [].
const ElementData &	at (uint32_t row, uint32_t col) const
	Returns a const element reference to the specified row and column index in the BatchArray object.
ElementData &	at (size_t row, size_t col)
	Returns an element reference to the specified row and column index in the BatchArray object.
BatchArray< ElementData >	clone () const
	Creates a deep copy of the BatchArray object.
void	clear ()
	Clears the data of the BatchArray object.

Detailed Description

template<typename ElementData>
class mmind::eye::BatchArray< ElementData >

Represents the data struct of the profile data.

Definition at line 14 of file BatchArray.h.

Constructor & Destructor Documentation

BatchArray()

template<typename ElementData >

mmind::eye::BatchArray< ElementData >::BatchArray ( size_t width )

inline

Describes a constructor.

Definition at line 20 of file BatchArray.h.

Member Function Documentation

append()

template<typename ElementData >

bool mmind::eye::BatchArray< ElementData >::append ( const BatchArray< ElementData > & data )

inline

Appends the data variable onto the end of this BatchArray object.

Definition at line 79 of file BatchArray.h.

at() [1/2]

template<typename ElementData >

ElementData & mmind::eye::BatchArray< ElementData >::at ( size_t row, size_t col )

inline

Returns an element reference to the specified row and column index in the BatchArray object.

Parameters

row	Index along the height dimension. An exception is thrown if the input row is greater than width.
col	Index along the width dimension. An exception is thrown if the input col is greater than height.

Definition at line 152 of file BatchArray.h.

at() [2/2]

template<typename ElementData >

const ElementData & mmind::eye::BatchArray< ElementData >::at ( uint32_t row, uint32_t col ) const

inline

Returns a const element reference to the specified row and column index in the BatchArray object.

Parameters

row	Index along the height dimension. An exception is thrown if the input row is greater than width.
col	Index along the width dimension. An exception is thrown if the input col is greater than height.

Definition at line 136 of file BatchArray.h.

capacity()

template<typename ElementData >

size_t mmind::eye::BatchArray< ElementData >::capacity ( ) const

inline

Returns the size of the storage space currently allocated for the BatchArray object, expressed in number of lines.

Definition at line 51 of file BatchArray.h.

clear()

template<typename ElementData >

void mmind::eye::BatchArray< ElementData >::clear ( )

inline

Clears the data of the BatchArray object.

Definition at line 173 of file BatchArray.h.

clone()

template<typename ElementData >

BatchArray< ElementData > mmind::eye::BatchArray< ElementData >::clone ( ) const

inline

Creates a deep copy of the BatchArray object.

Definition at line 161 of file BatchArray.h.

data() [1/2]

template<typename ElementData >

ElementData * mmind::eye::BatchArray< ElementData >::data ( )

inline

Returns the pointer to the element data.

Definition at line 101 of file BatchArray.h.

data() [2/2]

template<typename ElementData >

const ElementData * mmind::eye::BatchArray< ElementData >::data ( ) const

inline

Returns the pointer to the element data.

Definition at line 96 of file BatchArray.h.

height()

template<typename ElementData >

size_t mmind::eye::BatchArray< ElementData >::height ( ) const

inline

Returns the height of the BatchArray object.

Definition at line 34 of file BatchArray.h.

isEmpty()

template<typename ElementData >

bool mmind::eye::BatchArray< ElementData >::isEmpty ( ) const

inline

Returns true if the BatchArray object has no elements.

Definition at line 56 of file BatchArray.h.

operator[]() [1/2]

template<typename ElementData >

ElementData & mmind::eye::BatchArray< ElementData >::operator[] ( std::size_t n )

inline

Returns an element reference to the specified index in the BatchArray object using the operator [].

Parameters

n	Index of an element. An exception is thrown if the input n is greater than width * height.

Definition at line 123 of file BatchArray.h.

operator[]() [2/2]

template<typename ElementData >

const ElementData & mmind::eye::BatchArray< ElementData >::operator[] ( std::size_t n ) const

inline

Returns a const element reference to the specified index in the BatchArray object using the operator [].

Parameters

n	Index of an element. An exception is thrown if the input n is greater than width * height.

Definition at line 109 of file BatchArray.h.

reserve()

template<typename ElementData >

void mmind::eye::BatchArray< ElementData >::reserve ( size_t height )

inline

Requests for enough capacity of the BatchArray object to contain the number of lines corresponding to the height.

Definition at line 62 of file BatchArray.h.

setHeight()

template<typename ElementData >

void mmind::eye::BatchArray< ElementData >::setHeight ( size_t height )

inline

Sets the height of the BatchArray object.

Definition at line 39 of file BatchArray.h.

width()

template<typename ElementData >

size_t mmind::eye::BatchArray< ElementData >::width ( ) const

inline

Returns the width of the BatchArray object.

Definition at line 29 of file BatchArray.h.

---

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

• profiler/BatchArray.h