Surpport fixed array and push and pack operation HOWEVER this is now experimental version. Please do not use this container until we complete review. More...
#include <push_and_pop_dynamic.hpp>
Public Types | |
| typedef const Type * | const_iterator |
| typedef const Type & | const_reference |
| typedef std::reverse_iterator < const_iterator > | const_reverse_iterator |
| typedef std::ptrdiff_t | difference_type |
| typedef formatters::PushAndPopFormatter < Type, DynamicStorage > | Formatter |
| Formatter for this class. | |
| typedef Type * | iterator |
| typedef Type & | reference |
| typedef std::reverse_iterator < iterator > | reverse_iterator |
| typedef std::size_t | size_type |
| typedef Type | value_type |
Public Member Functions | |
| unsigned int | asize () |
| The size allocated in memory for the fifo. | |
| iterator | begin () ecl_assert_throw_decl(StandardException) |
| const_iterator | begin () const ecl_assert_throw_decl(StandardException) |
| void | clear () |
| iterator | end () ecl_assert_throw_decl(StandardException) |
| const_iterator | end () const ecl_assert_throw_decl(StandardException) |
| void | fill (const Type &d) |
| void | operator() (const PushAndPop< Type, 0 > &otherOne) |
| Type & | operator[] (int idx) |
| const Type & | operator[] (int idx) const |
| Type | pop_front () |
| void | push_back (const Type &datum) |
| PushAndPop () | |
| Default constructor. | |
| PushAndPop (const unsigned int length) ecl_assert_throw_decl(StandardException) | |
| PushAndPop (const unsigned int length, const Type &d) ecl_assert_throw_decl(StandardException) | |
| reverse_iterator | rbegin () ecl_assert_throw_decl(StandardException) |
| const_reverse_iterator | rbegin () const ecl_assert_throw_decl(StandardException) |
| reverse_iterator | rend () ecl_assert_throw_decl(StandardException) |
| const_reverse_iterator | rend () const ecl_assert_throw_decl(StandardException) |
| void | resize (unsigned int length) |
| unsigned int | size () const |
| Stencil< PushAndPop< Type, DynamicStorage > > | stencil (const unsigned int &start_index, const unsigned int &n) ecl_assert_throw_decl(StandardException) |
| Open a window (stencil) onto a subset of the container. | |
| virtual | ~PushAndPop () |
Public Attributes | |
| ecl::Array< Type > | data |
| int | follower |
| int | leader |
| unsigned int | size_fifo |
Surpport fixed array and push and pack operation HOWEVER this is now experimental version. Please do not use this container until we complete review.
Usage:
@code
Definition at line 64 of file push_and_pop_dynamic.hpp.
| typedef const Type* ecl::PushAndPop< Type, DynamicStorage >::const_iterator |
Constant iterator type.
Definition at line 69 of file push_and_pop_dynamic.hpp.
| typedef const Type& ecl::PushAndPop< Type, DynamicStorage >::const_reference |
Element const reference type.
Definition at line 71 of file push_and_pop_dynamic.hpp.
| typedef std::reverse_iterator<const_iterator> ecl::PushAndPop< Type, DynamicStorage >::const_reverse_iterator |
Constant reverse iterator type.
Definition at line 75 of file push_and_pop_dynamic.hpp.
| typedef std::ptrdiff_t ecl::PushAndPop< Type, DynamicStorage >::difference_type |
Definition at line 73 of file push_and_pop_dynamic.hpp.
| typedef formatters::PushAndPopFormatter<Type,DynamicStorage> ecl::PushAndPop< Type, DynamicStorage >::Formatter |
Formatter for this class.
Definition at line 76 of file push_and_pop_dynamic.hpp.
| typedef Type* ecl::PushAndPop< Type, DynamicStorage >::iterator |
Iterator type.
Definition at line 68 of file push_and_pop_dynamic.hpp.
| typedef Type& ecl::PushAndPop< Type, DynamicStorage >::reference |
Element reference type.
Definition at line 70 of file push_and_pop_dynamic.hpp.
| typedef std::reverse_iterator<iterator> ecl::PushAndPop< Type, DynamicStorage >::reverse_iterator |
Reverse iterator type.
Definition at line 74 of file push_and_pop_dynamic.hpp.
| typedef std::size_t ecl::PushAndPop< Type, DynamicStorage >::size_type |
Type used to denote the length of the array.
Definition at line 72 of file push_and_pop_dynamic.hpp.
| typedef Type ecl::PushAndPop< Type, DynamicStorage >::value_type |
Element type.
Definition at line 67 of file push_and_pop_dynamic.hpp.
| ecl::PushAndPop< Type, DynamicStorage >::PushAndPop | ( | ) | [inline] |
Default constructor.
Creates a dynamic push and pop container of zero length.
Definition at line 83 of file push_and_pop_dynamic.hpp.
| ecl::PushAndPop< Type, DynamicStorage >::PushAndPop | ( | const unsigned int | length | ) | [inline] |
Definition at line 85 of file push_and_pop_dynamic.hpp.
| ecl::PushAndPop< Type, DynamicStorage >::PushAndPop | ( | const unsigned int | length, |
| const Type & | d | ||
| ) | [inline] |
Definition at line 92 of file push_and_pop_dynamic.hpp.
| virtual ecl::PushAndPop< Type, DynamicStorage >::~PushAndPop | ( | ) | [inline, virtual] |
Definition at line 101 of file push_and_pop_dynamic.hpp.
| unsigned int ecl::PushAndPop< Type, DynamicStorage >::asize | ( | ) | [inline] |
The size allocated in memory for the fifo.
This is different to the actual used size.
Definition at line 260 of file push_and_pop_dynamic.hpp.
| iterator ecl::PushAndPop< Type, DynamicStorage >::begin | ( | ) | [inline] |
Generates a pointer (iterator) pointing to the start of the array.
| StandardException | : throws if no storage has been allocated [debug mode only]. |
Definition at line 113 of file push_and_pop_dynamic.hpp.
| const_iterator ecl::PushAndPop< Type, DynamicStorage >::begin | ( | ) | const [inline] |
Generates a const pointer (iterator) pointing to the start of the array.
| StandardException | : throws if no storage has been allocated [debug mode only]. |
Definition at line 122 of file push_and_pop_dynamic.hpp.
| void ecl::PushAndPop< Type, DynamicStorage >::clear | ( | ) | [inline] |
Definition at line 272 of file push_and_pop_dynamic.hpp.
| iterator ecl::PushAndPop< Type, DynamicStorage >::end | ( | ) | [inline] |
Generates an pointer (iterator) pointing to the end of the array.
| StandardException | : throws if no storage has been allocated [debug mode only]. |
Definition at line 131 of file push_and_pop_dynamic.hpp.
| const_iterator ecl::PushAndPop< Type, DynamicStorage >::end | ( | ) | const [inline] |
Generates a const pointer (iterator) pointing to the end of the array.
| StandardException | : throws if no storage has been allocated [debug mode only]. |
Definition at line 140 of file push_and_pop_dynamic.hpp.
| void ecl::PushAndPop< Type, DynamicStorage >::fill | ( | const Type & | d | ) | [inline] |
Definition at line 241 of file push_and_pop_dynamic.hpp.
| void ecl::PushAndPop< Type, DynamicStorage >::operator() | ( | const PushAndPop< Type, 0 > & | otherOne | ) | [inline] |
Definition at line 211 of file push_and_pop_dynamic.hpp.
| Type& ecl::PushAndPop< Type, DynamicStorage >::operator[] | ( | int | idx | ) | [inline] |
Definition at line 201 of file push_and_pop_dynamic.hpp.
| const Type& ecl::PushAndPop< Type, DynamicStorage >::operator[] | ( | int | idx | ) | const [inline] |
Definition at line 206 of file push_and_pop_dynamic.hpp.
| Type ecl::PushAndPop< Type, DynamicStorage >::pop_front | ( | ) | [inline] |
Definition at line 233 of file push_and_pop_dynamic.hpp.
| void ecl::PushAndPop< Type, DynamicStorage >::push_back | ( | const Type & | datum | ) | [inline] |
Definition at line 221 of file push_and_pop_dynamic.hpp.
| reverse_iterator ecl::PushAndPop< Type, DynamicStorage >::rbegin | ( | ) | [inline] |
Generates a reverse iterator pointing to the end of the array.
| StandardException | : throws if no storage has been allocated [debug mode only]. |
Definition at line 149 of file push_and_pop_dynamic.hpp.
| const_reverse_iterator ecl::PushAndPop< Type, DynamicStorage >::rbegin | ( | ) | const [inline] |
Generates a constant reverse iterator pointing to the end of the array.
| StandardException | : throws if no storage has been allocated [debug mode only]. |
Definition at line 158 of file push_and_pop_dynamic.hpp.
| reverse_iterator ecl::PushAndPop< Type, DynamicStorage >::rend | ( | ) | [inline] |
Generates a reverse iterator pointing to the beginning of the array.
| StandardException | : throws if no storage has been allocated [debug mode only]. |
Definition at line 167 of file push_and_pop_dynamic.hpp.
| const_reverse_iterator ecl::PushAndPop< Type, DynamicStorage >::rend | ( | ) | const [inline] |
Generates a constant reverse iterator pointing to the beginning of the array.
| StandardException | : throws if no storage has been allocated [debug mode only]. |
Definition at line 176 of file push_and_pop_dynamic.hpp.
| void ecl::PushAndPop< Type, DynamicStorage >::resize | ( | unsigned int | length | ) | [inline] |
Definition at line 246 of file push_and_pop_dynamic.hpp.
| unsigned int ecl::PushAndPop< Type, DynamicStorage >::size | ( | ) | const [inline] |
Definition at line 265 of file push_and_pop_dynamic.hpp.
| Stencil< PushAndPop<Type,DynamicStorage> > ecl::PushAndPop< Type, DynamicStorage >::stencil | ( | const unsigned int & | start_index, |
| const unsigned int & | n | ||
| ) | [inline] |
Open a window (stencil) onto a subset of the container.
Opens a window onto the container, providing a similar container-like class to manipulate.
| start_index | : start of the stencil window. |
| n | : number of elements to include in the window. |
| : | StandardException : throws if the indices provided are out of range [debug mode only]. |
Definition at line 195 of file push_and_pop_dynamic.hpp.
| ecl::Array<Type> ecl::PushAndPop< Type, DynamicStorage >::data |
Definition at line 279 of file push_and_pop_dynamic.hpp.
| int ecl::PushAndPop< Type, DynamicStorage >::follower |
Definition at line 282 of file push_and_pop_dynamic.hpp.
| int ecl::PushAndPop< Type, DynamicStorage >::leader |
Definition at line 281 of file push_and_pop_dynamic.hpp.
| unsigned int ecl::PushAndPop< Type, DynamicStorage >::size_fifo |
Definition at line 280 of file push_and_pop_dynamic.hpp.