Public Member Functions
garlic::sequence< ValueType, SizeType > Class Template Reference

A container to store a list of items, similar to std::vector but far more limited. More...

#include <containers.h>

Public Member Functions

iterator begin ()
 
iterator end ()
 
const_iterator begin () const
 
const_iterator end () const
 
SizeType size () const noexcept
 
SizeType capacity () const noexcept
 
bool empty () const noexcept
 

Detailed Description

template<typename ValueType, typename SizeType = unsigned>
class garlic::sequence< ValueType, SizeType >

A container to store a list of items, similar to std::vector but far more limited.

This container is mostly used in constrains and modules where only a small number of elements are stored so it is designed to work with small counts.

Member Function Documentation

◆ begin() [1/2]

template<typename ValueType , typename SizeType = unsigned>
iterator garlic::sequence< ValueType, SizeType >::begin ( )
inline
Returns
a const iterator that points to the first item in the sequence.

◆ begin() [2/2]

template<typename ValueType , typename SizeType = unsigned>
const_iterator garlic::sequence< ValueType, SizeType >::begin ( ) const
inline
Returns
a iterator that points to the first item in the sequence.

◆ capacity()

template<typename ValueType , typename SizeType = unsigned>
SizeType garlic::sequence< ValueType, SizeType >::capacity ( ) const
inlinenoexcept
Returns
the current capacity of the sequence.

◆ empty()

template<typename ValueType , typename SizeType = unsigned>
bool garlic::sequence< ValueType, SizeType >::empty ( ) const
inlinenoexcept
Returns
whether or not the sequence is empty.

◆ end() [1/2]

template<typename ValueType , typename SizeType = unsigned>
iterator garlic::sequence< ValueType, SizeType >::end ( )
inline
Returns
a const iterator that points to the one past the last item in the sequence.

◆ end() [2/2]

template<typename ValueType , typename SizeType = unsigned>
const_iterator garlic::sequence< ValueType, SizeType >::end ( ) const
inline
Returns
a iterator that points to the one past the last item in the sequence.

◆ size()

template<typename ValueType , typename SizeType = unsigned>
SizeType garlic::sequence< ValueType, SizeType >::size ( ) const
inlinenoexcept
Returns
the number of the elements stored in the sequence.
The documentation for this class was generated from the following file: