A C-style array wrapped in the facade of a C++ STL container. More...

#include <be_memory_autoarray.h>

Public Types
using	value_type = T
	Type of element. More...

using	size_type = size_t
	Type of subscripts, counts, etc. More...

using	iterator = AutoArrayIterator< false, T >
	Iterator of element. More...

using	const_iterator = AutoArrayIterator< true, T >
	Const iterator of element. More...

using	reference = T &
	Reference to element. More...

using	const_reference = const T &
	Const reference element. More...

Public Member Functions
	operator T* ()
	Convert AutoArray to T array. More...

	operator const T * () const
	Convert AutoArray to const T array. More...

reference	operator[] (ptrdiff_t index)
	Subscripting operator overload with unchecked access. More...

const_reference	operator[] (ptrdiff_t index) const
	Const subscripting operator overload with unchecked access. More...

reference	at (ptrdiff_t index)
	Subscript into the AutoArray with checked access. More...

const_reference	at (ptrdiff_t index) const
	Subscript into the AutoArray with checked access. More...

iterator	begin ()
	Obtain an iterator to the beginning of the AutoArray. More...

const_iterator	begin () const
	Obtain an iterator to the beginning of the AutoArray. More...

const_iterator	cbegin () const
	Obtain an iterator to the beginning of the AutoArray. More...

iterator	end ()
	Obtain an iterator to the end of the AutoArray. More...

const_iterator	end () const
	Obtain an iterator to the end of the AutoArray. More...

const_iterator	cend () const
	Obtain an iterator to the end of the AutoArray. More...

size_type	size () const
	Obtain the number of accessible elements. More...

void	resize (size_type new_size, bool free=false)
	Change the number of accessible elements. More...

void	copy (const T *buffer)
	Deep-copy the contents of a buffer into this AutoArray. More...

void	copy (const T *buffer, size_type size)
	Deep-copy the contents of a buffer into this AutoArray. More...

std::vector< T >	to_vector () const
	Obtain a copy of elements in this AutoArray as a vector. More...

	AutoArray (size_type size=0)
	Construct an AutoArray. More...

	AutoArray (const AutoArray &copy)
	Construct an AutoArray. More...

	AutoArray (AutoArray &&rvalue) noexcept
	Construct an AutoArray. More...

	AutoArray (std::initializer_list< T > ilist)
	Construct an AutoArray. More...

AutoArray &	operator= (const AutoArray &other)
	Copy assignment operator overload performing a deep copy. More...

AutoArray &	operator= (AutoArray &&other) noexcept(noexcept(std::swap(std::declval< value_type & >(), std::declval< value_type & >())) &&noexcept(std::swap(std::declval< size_type & >(), std::declval< size_type & >())))
	Move assignment operator. More...

	~AutoArray ()
	Destructor. More...

Detailed Description

template<class T>
class BiometricEvaluation::Memory::AutoArray< T >

A C-style array wrapped in the facade of a C++ STL container.

Forward declaration.

Objects of this type should be treated in the traditional manner for containers, where (size_type) construction creates an array of the given size, while {...} construction creates an array with the given elements.

Definition at line 44 of file be_memory_autoarray.h.

Member Typedef Documentation

◆ value_type

template<class T >

using BiometricEvaluation::Memory::AutoArray< T >::value_type = T

Type of element.

Definition at line 48 of file be_memory_autoarray.h.

◆ size_type

template<class T >

using BiometricEvaluation::Memory::AutoArray< T >::size_type = size_t

Type of subscripts, counts, etc.

Definition at line 50 of file be_memory_autoarray.h.

◆ iterator

template<class T >

using BiometricEvaluation::Memory::AutoArray< T >::iterator = AutoArrayIterator<false, T>

Iterator of element.

Definition at line 53 of file be_memory_autoarray.h.

◆ const_iterator

template<class T >

using BiometricEvaluation::Memory::AutoArray< T >::const_iterator = AutoArrayIterator<true, T>

Const iterator of element.

Definition at line 55 of file be_memory_autoarray.h.

◆ reference

template<class T >

using BiometricEvaluation::Memory::AutoArray< T >::reference = T&

Reference to element.

Definition at line 59 of file be_memory_autoarray.h.

◆ const_reference

template<class T >

using BiometricEvaluation::Memory::AutoArray< T >::const_reference = const T&

Const reference element.

Definition at line 61 of file be_memory_autoarray.h.

Constructor & Destructor Documentation

◆ AutoArray() [1/4]

template<class T >

BiometricEvaluation::Memory::AutoArray< T >::AutoArray ( size_type size = 0 )

explicit

Construct an AutoArray.

Parameters

[in] size The number of elements this AutoArray should initially hold.

Exceptions

Error::MemoryError Could not allocate new memory.

Definition at line 730 of file be_memory_autoarray.h.

◆ AutoArray() [2/4]

template<class T >

BiometricEvaluation::Memory::AutoArray< T >::AutoArray ( const AutoArray< T > & copy )

Construct an AutoArray.

Parameters

[in] copy An AutoArray whose contents will be deep copied into the new AutoArray.

Exceptions

Error::MemoryError Could not allocate new memory.

Definition at line 744 of file be_memory_autoarray.h.

◆ AutoArray() [3/4]

template<class T >

BiometricEvaluation::Memory::AutoArray< T >::AutoArray ( AutoArray< T > && rvalue )

noexcept

Construct an AutoArray.

Parameters

[in] rvalue An rvalue reference to an AutoArray whose contents will be moved and destroyed.

Definition at line 759 of file be_memory_autoarray.h.

◆ AutoArray() [4/4]

template<class T >

BiometricEvaluation::Memory::AutoArray< T >::AutoArray ( std::initializer_list< T > ilist )

Construct an AutoArray.

Parameters

[in] ilist An initializer list of type T.

Definition at line 773 of file be_memory_autoarray.h.

◆ ~AutoArray()

template<class T >

BiometricEvaluation::Memory::AutoArray< T >::~AutoArray

Destructor.

Definition at line 783 of file be_memory_autoarray.h.

Member Function Documentation

◆ operator T*()

template<class T >

BiometricEvaluation::Memory::AutoArray< T >::operator T*

Convert AutoArray to T array.

Returns: Pointer to the beginning of the underlying array storage.

Definition at line 588 of file be_memory_autoarray.h.

◆ operator const T *()

template<class T >

BiometricEvaluation::Memory::AutoArray< T >::operator const T *

Convert AutoArray to const T array.

Returns: Const pointer to the beginning of the underlying array storage.

Definition at line 594 of file be_memory_autoarray.h.

◆ operator[]() [1/2]

template<class T >

BiometricEvaluation::Memory::AutoArray< T >::reference BiometricEvaluation::Memory::AutoArray< T >::operator[] ( ptrdiff_t index )

Subscripting operator overload with unchecked access.

Parameters

[in] index Subscript into underlying storage.

Returns: Reference to the element at the specified index.

Definition at line 605 of file be_memory_autoarray.h.

◆ operator[]() [2/2]

template<class T >

BiometricEvaluation::Memory::AutoArray< T >::const_reference BiometricEvaluation::Memory::AutoArray< T >::operator[] ( ptrdiff_t index ) const

Const subscripting operator overload with unchecked access.

Parameters

[in] index Subscript into underlying storage.

Returns: Const reference to the element at the specified index.

Definition at line 613 of file be_memory_autoarray.h.

◆ at() [1/2]

template<class T >

BiometricEvaluation::Memory::AutoArray< T >::reference BiometricEvaluation::Memory::AutoArray< T >::at ( ptrdiff_t index )

Subscript into the AutoArray with checked access.

Parameters

[in] index Subscript into underlying storage.

Returns: Reference to the element at the specified index.

Exceptions

out_of_range Specified index is outside the bounds of this AutoArray.

Definition at line 565 of file be_memory_autoarray.h.

◆ at() [2/2]

template<class T >

BiometricEvaluation::Memory::AutoArray< T >::const_reference BiometricEvaluation::Memory::AutoArray< T >::at ( ptrdiff_t index ) const

Subscript into the AutoArray with checked access.

Parameters

index Subscript into underlying storage.

Returns: Const reference to the element at the specified index.

Exceptions

out_of_range Specified index is outside the bounds of this AutoArray.

Definition at line 552 of file be_memory_autoarray.h.

◆ begin() [1/2]

template<class T >

BiometricEvaluation::Memory::AutoArray< T >::iterator BiometricEvaluation::Memory::AutoArray< T >::begin

Obtain an iterator to the beginning of the AutoArray.

Returns: Iterator positioned at the first element of the AutoArray.

Definition at line 668 of file be_memory_autoarray.h.

◆ begin() [2/2]

template<class T >

BiometricEvaluation::Memory::AutoArray< T >::const_iterator BiometricEvaluation::Memory::AutoArray< T >::begin

Obtain an iterator to the beginning of the AutoArray.

Returns: Const iterator positioned at the first element of the AutoArray.

Definition at line 675 of file be_memory_autoarray.h.

◆ cbegin()

template<class T >

BiometricEvaluation::Memory::AutoArray< T >::const_iterator BiometricEvaluation::Memory::AutoArray< T >::cbegin

Obtain an iterator to the beginning of the AutoArray.

Returns: Const iterator positioned at the first element of the AutoArray.

Definition at line 683 of file be_memory_autoarray.h.

◆ end() [1/2]

template<class T >

BiometricEvaluation::Memory::AutoArray< T >::iterator BiometricEvaluation::Memory::AutoArray< T >::end

Obtain an iterator to the end of the AutoArray.

Returns: Iterator positioned at the one-past-last element of the AutoArray.

Definition at line 691 of file be_memory_autoarray.h.

◆ end() [2/2]

template<class T >

BiometricEvaluation::Memory::AutoArray< T >::const_iterator BiometricEvaluation::Memory::AutoArray< T >::end

Obtain an iterator to the end of the AutoArray.

Returns: Iterator positioned at the one-past-last element of the AutoArray.

Definition at line 705 of file be_memory_autoarray.h.

◆ cend()

template<class T >

BiometricEvaluation::Memory::AutoArray< T >::const_iterator BiometricEvaluation::Memory::AutoArray< T >::cend

Obtain an iterator to the end of the AutoArray.

Returns: Iterator positioned at the one-past-last element of the AutoArray.

Definition at line 713 of file be_memory_autoarray.h.

◆ size()

template<class T >

BiometricEvaluation::Memory::AutoArray< T >::size_type BiometricEvaluation::Memory::AutoArray< T >::size

Obtain the number of accessible elements.

Returns: Number of accessible elements.

Note: If resize() has been called, the value returned from size() may be smaller than the actual allocated size of the underlying storage.

Definition at line 496 of file be_memory_autoarray.h.

◆ resize()

template<class T >

void BiometricEvaluation::Memory::AutoArray< T >::resize	(	size_type	new_size,
		bool	free = `false`
	)

Change the number of accessible elements.

Parameters

[in]	new_size	The number of elements the AutoArray should have allocated.
[in]	free	Whether or not excess memory should be freed if the new size is smaller than the current size.

Exceptions

Error::MemoryError Problem allocating memory.

Definition at line 504 of file be_memory_autoarray.h.

◆ copy() [1/2]

template<class T >

void BiometricEvaluation::Memory::AutoArray< T >::copy ( const T * buffer )

Deep-copy the contents of a buffer into this AutoArray.

Parameters

[in] buffer An allocated buffer whose contents will be deep-copied into this object. Only size() bytes will be copied.

Warning: If buffer is smaller in size than the current size of the AutoArray, you MUST call copy(const T*, size_type). This method must only be used when buffer is larger than or equal to the size of the AutoArray.

Definition at line 534 of file be_memory_autoarray.h.

◆ copy() [2/2]

template<class T >

void BiometricEvaluation::Memory::AutoArray< T >::copy	(	const T *	buffer,
		size_type	size
	)

Deep-copy the contents of a buffer into this AutoArray.

Parameters

[in]	buffer	An allocated buffer whose contents will be deep-copied into this object.
[in]	size	The number of bytes from buffer that will be deep-copied.

Warning: size must be less than or equal to the size of buffer.

Definition at line 542 of file be_memory_autoarray.h.

◆ to_vector()

template<class T >

std::vector< T > BiometricEvaluation::Memory::AutoArray< T >::to_vector

Obtain a copy of elements in this AutoArray as a vector.

Warning: A key difference between vectors and AutoArrays is that all elements of a vector must be initialized. Calling this method on an AutoArray where not all elements have been initialized will likely cause undefined behavior.

Returns: A vector containing the contents of this AutoArray.

Definition at line 578 of file be_memory_autoarray.h.

◆ operator=() [1/2]

template<class T >

BiometricEvaluation::Memory::AutoArray< T > & BiometricEvaluation::Memory::AutoArray< T >::operator= ( const AutoArray< T > & other )

Copy assignment operator overload performing a deep copy.

Parameters

[in] other AutoArray to be copied.

Returns: Reference to a new AutoArray object, the lvalue AutoArray.

Exceptions

Error::MemoryError Could not allocate new memory.

Definition at line 622 of file be_memory_autoarray.h.

◆ operator=() [2/2]

template<class T >

BiometricEvaluation::Memory::AutoArray< T > & BiometricEvaluation::Memory::AutoArray< T >::operator= ( AutoArray< T > && other )

noexcept

Move assignment operator.

Parameters

[in] other rvalue reference to another AutoArray, whose contents will be moved and cleared from itself.

Returns: Reference to the lvalue AutoArray.

Definition at line 646 of file be_memory_autoarray.h.

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

be_memory_autoarray.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ value_type

◆ size_type

◆ iterator

◆ const_iterator

◆ reference

◆ const_reference

Constructor & Destructor Documentation

◆ AutoArray() [1/4]

◆ AutoArray() [2/4]

◆ AutoArray() [3/4]

◆ AutoArray() [4/4]

◆ ~AutoArray()

Member Function Documentation

◆ operator T*()

◆ operator const T *()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ at() [1/2]

◆ at() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ cbegin()

◆ end() [1/2]

◆ end() [2/2]

◆ cend()

◆ size()

◆ resize()

◆ copy() [1/2]

◆ copy() [2/2]

◆ to_vector()

◆ operator=() [1/2]

◆ operator=() [2/2]