Description

template<typename T>
class LLU::IterableContainer< T >

Abstract class that provides iterators (c/r/begin and c/r/end methods) and subscript operator for any contiguous container.

Template Parameters

T	- underlying data type

Inheritance diagram for LLU::IterableContainer< T >:

#include <IterableContainer.hpp>

Public Types
using	value_type = T
	Type of elements stored. More...

using	iterator = value_type *
	Iterator type. More...

using	const_iterator = const value_type *
	Constant iterator type. More...

using	reverse_iterator = std::reverse_iterator< iterator >
	Reverse iterator type. More...

using	const_reverse_iterator = std::reverse_iterator< const_iterator >
	Constant reverse iterator type. More...

using	reference = value_type &
	Reference type. More...

using	const_reference = const value_type &
	Constant reference type. More...

Public Member Functions
value_type *	data () noexcept
	Get raw pointer to underlying data. More...

const value_type *	data () const noexcept
	Get raw pointer to const underlying data. More...

mint	size () const noexcept
	Get total number of elements in the container. More...

iterator	begin () noexcept
	Get iterator at the beginning of underlying data. More...

const_iterator	begin () const noexcept
	Get constant iterator at the beginning of underlying data. More...

const_iterator	cbegin () const noexcept
	Get constant iterator at the beginning of underlying data. More...

iterator	end () noexcept
	Get iterator after the end of underlying data. More...

const_iterator	end () const noexcept
	Get constant iterator after the end of underlying data. More...

const_iterator	cend () const noexcept
	Get constant iterator after the end of underlying data. More...

reverse_iterator	rbegin () noexcept
	Get iterator at the beginning of underlying data. More...

const_reverse_iterator	rbegin () const noexcept
	Get constant iterator at the beginning of underlying data. More...

const_reverse_iterator	crbegin () const noexcept
	Get constant iterator at the beginning of underlying data. More...

reverse_iterator	rend () noexcept
	Get iterator after the end of underlying data. More...

const_reverse_iterator	rend () const noexcept
	Get constant iterator after the end of underlying data. More...

const_reverse_iterator	crend () const noexcept
	Get constant iterator after the end of underlying data. More...

reference	operator[] (mint index)
	Get a reference to the data element at given position. More...

const_reference	operator[] (mint index) const
	Get a constant reference to the data element at given position. More...

reference	front ()
	Get reference to the first element. More...

const_reference	front () const
	Get constant reference to the first element. More...

reference	back ()
	Get reference to the last element. More...

const_reference	back () const
	Get constant reference to the last element. More...

std::vector< value_type >	asVector () const
	Copy contents of the data to a std::vector of matching type. More...

Type aliases documentation

◆ const_iterator

template<typename T >

using LLU::IterableContainer< T >::const_iterator = const value_type*

Constant iterator type.

◆ const_reference

template<typename T >

using LLU::IterableContainer< T >::const_reference = const value_type&

Constant reference type.

◆ const_reverse_iterator

template<typename T >

using LLU::IterableContainer< T >::const_reverse_iterator = std::reverse_iterator<const_iterator>

Constant reverse iterator type.

◆ iterator

template<typename T >

using LLU::IterableContainer< T >::iterator = value_type*

Iterator type.

◆ reference

template<typename T >

using LLU::IterableContainer< T >::reference = value_type&

Reference type.

◆ reverse_iterator

template<typename T >

using LLU::IterableContainer< T >::reverse_iterator = std::reverse_iterator<iterator>

Reverse iterator type.

◆ value_type

template<typename T >

using LLU::IterableContainer< T >::value_type = T

Type of elements stored.

Member Function Documentation

◆ asVector()

template<typename T >

std::vector<value_type> LLU::IterableContainer< T >::asVector ( ) const

inline

Copy contents of the data to a std::vector of matching type.

Returns: std::vector with the copy of the data

◆ back() [1/2]

template<typename T >

reference LLU::IterableContainer< T >::back ( )

inline

Get reference to the last element.

Note: For empty container the behavior is undefined.

◆ back() [2/2]

template<typename T >

const_reference LLU::IterableContainer< T >::back ( ) const

inline

Get constant reference to the last element.

Note: For empty container the behavior is undefined.

◆ begin() [1/2]

template<typename T >

const_iterator LLU::IterableContainer< T >::begin ( ) const

inlinenoexcept

Get constant iterator at the beginning of underlying data.

◆ begin() [2/2]

template<typename T >

iterator LLU::IterableContainer< T >::begin ( )

inlinenoexcept

Get iterator at the beginning of underlying data.

◆ cbegin()

template<typename T >

const_iterator LLU::IterableContainer< T >::cbegin ( ) const

inlinenoexcept

Get constant iterator at the beginning of underlying data.

◆ cend()

template<typename T >

const_iterator LLU::IterableContainer< T >::cend ( ) const

inlinenoexcept

Get constant iterator after the end of underlying data.

◆ crbegin()

template<typename T >

const_reverse_iterator LLU::IterableContainer< T >::crbegin ( ) const

inlinenoexcept

Get constant iterator at the beginning of underlying data.

◆ crend()

template<typename T >

const_reverse_iterator LLU::IterableContainer< T >::crend ( ) const

inlinenoexcept

Get constant iterator after the end of underlying data.

◆ data() [1/2]

template<typename T >

const value_type* LLU::IterableContainer< T >::data ( ) const

inlinenoexcept

Get raw pointer to const underlying data.

◆ data() [2/2]

template<typename T >

value_type* LLU::IterableContainer< T >::data ( )

inlinenoexcept

Get raw pointer to underlying data.

◆ end() [1/2]

template<typename T >

const_iterator LLU::IterableContainer< T >::end ( ) const

inlinenoexcept

Get constant iterator after the end of underlying data.

◆ end() [2/2]

template<typename T >

iterator LLU::IterableContainer< T >::end ( )

inlinenoexcept

Get iterator after the end of underlying data.

◆ front() [1/2]

template<typename T >

reference LLU::IterableContainer< T >::front ( )

inline

Get reference to the first element.

Note: For empty container the behavior is undefined.

◆ front() [2/2]

template<typename T >

const_reference LLU::IterableContainer< T >::front ( ) const

inline

Get constant reference to the first element.

Note: For empty container the behavior is undefined.

◆ operator[]() [1/2]

template<typename T >

reference LLU::IterableContainer< T >::operator[] ( mint index )

inline

Get a reference to the data element at given position.

Parameters

[in] index - position of desired data element

◆ operator[]() [2/2]

template<typename T >

const_reference LLU::IterableContainer< T >::operator[] ( mint index ) const

inline

Get a constant reference to the data element at given position.

Parameters

[in] index - position of desired data element

◆ rbegin() [1/2]

template<typename T >

const_reverse_iterator LLU::IterableContainer< T >::rbegin ( ) const

inlinenoexcept

Get constant iterator at the beginning of underlying data.

◆ rbegin() [2/2]

template<typename T >

reverse_iterator LLU::IterableContainer< T >::rbegin ( )

inlinenoexcept

Get iterator at the beginning of underlying data.

◆ rend() [1/2]

template<typename T >

const_reverse_iterator LLU::IterableContainer< T >::rend ( ) const

inlinenoexcept

Get constant iterator after the end of underlying data.

◆ rend() [2/2]

template<typename T >

reverse_iterator LLU::IterableContainer< T >::rend ( )

inlinenoexcept

Get iterator after the end of underlying data.

◆ size()

template<typename T >

mint LLU::IterableContainer< T >::size ( ) const

inlinenoexcept

Get total number of elements in the container.

Description

template<typename T> class LLU::IterableContainer< T >

Public Types

Public Member Functions

Type aliases documentation

◆ const_iterator

◆ const_reference

◆ const_reverse_iterator

◆ iterator

◆ reference

◆ reverse_iterator

◆ value_type

Member Function Documentation

◆ asVector()

◆ back() [1/2]

◆ back() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ cbegin()

◆ cend()

◆ crbegin()

◆ crend()

◆ data() [1/2]

◆ data() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ front() [1/2]

◆ front() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ rbegin() [1/2]

◆ rbegin() [2/2]

◆ rend() [1/2]

◆ rend() [2/2]

◆ size()

template<typename T>
class LLU::IterableContainer< T >