Like a Queue but with a restricted interface and a setTail function which, when the queue is empty, just takes a reference to the pushed item as the single element. More...
#include <buffers.hh>
Public Member Functions | |
| InputBuffer (const std::string &name, const std::string &data_name, unsigned int capacity_) | |
| void | setTail (ElemType &new_element) |
| Set the tail of the queue, this is like push but needs to be followed by pushTail for the new tail to make its way into the queue proper. More... | |
| bool | empty () const |
| No single element or queue entries. More... | |
| const ElemType & | front () const |
| Return the element, or the front of the queue. More... | |
| ElemType & | front () |
| void | pop () |
| Pop either the head, or if none, the head of the queue. More... | |
| void | pushTail () const |
| Push the single element (if any) into the queue proper. More... | |
| void | minorTrace () const |
| Report elements. More... | |
| bool | canReserve () const |
| Reservable interface, passed on to queue. More... | |
| void | reserve () |
| Reserve a slot in whatever structure this is attached to. More... | |
| void | freeReservation () |
| Free a reserved slot. More... | |
| unsigned int | unreservedRemainingSpace () |
| Like remainingSpace but does not count reserved spaces. More... | |
 Public Member Functions inherited from Minor::Reservable | |
| virtual | ~Reservable () |
Protected Attributes | |
| Queue< ElemType, ReportTraits, BubbleTraits > | queue |
| Underlying queue. More... | |
| ElemType * | elementPtr |
| Pointer to the single element (if not NULL) More... | |
Detailed Description
template<typename ElemType, typename ReportTraits = ReportTraitsAdaptor<ElemType>, typename BubbleTraits = BubbleTraitsAdaptor<ElemType>>
class Minor::InputBuffer< ElemType, ReportTraits, BubbleTraits >
Like a Queue but with a restricted interface and a setTail function which, when the queue is empty, just takes a reference to the pushed item as the single element.
Calling pushTail will push that element onto the queue.
The purpose of this class is to allow the faster operation of queues of items which usually don't get deeper than one item and for which the copy associated with a push is expensive enough to want to avoid
The intended use case is the input buffer for pipeline stages, hence the class name
Definition at line 565 of file buffers.hh.
Constructor & Destructor Documentation
◆ InputBuffer()
|
inline |
Definition at line 575 of file buffers.hh.
Member Function Documentation
◆ canReserve()
|
inlinevirtual |
Reservable interface, passed on to queue.
Implements Minor::Reservable.
Definition at line 641 of file buffers.hh.
◆ empty()
|
inline |
No single element or queue entries.
Definition at line 598 of file buffers.hh.
◆ freeReservation()
|
inlinevirtual |
◆ front() [1/2]
|
inline |
Definition at line 604 of file buffers.hh.
◆ front() [2/2]
|
inline |
Return the element, or the front of the queue.
Definition at line 601 of file buffers.hh.
◆ minorTrace()
|
inline |
Report elements.
Definition at line 634 of file buffers.hh.
◆ pop()
|
inline |
Pop either the head, or if none, the head of the queue.
Definition at line 609 of file buffers.hh.
◆ pushTail()
|
inline |
Push the single element (if any) into the queue proper.
If the element's reference points to a transient object, remember to always do this before the end of that object's life
Definition at line 625 of file buffers.hh.
Referenced by Minor::InputBuffer< Minor::ForwardInstData >::minorTrace(), and Minor::InputBuffer< Minor::ForwardInstData >::unreservedRemainingSpace().
◆ reserve()
|
inlinevirtual |
Reserve a slot in whatever structure this is attached to.
Implements Minor::Reservable.
Definition at line 642 of file buffers.hh.
◆ setTail()
|
inline |
Set the tail of the queue, this is like push but needs to be followed by pushTail for the new tail to make its way into the queue proper.
Definition at line 586 of file buffers.hh.
◆ unreservedRemainingSpace()
|
inline |
Like remainingSpace but does not count reserved spaces.
Definition at line 647 of file buffers.hh.
Member Data Documentation
◆ elementPtr
|
mutableprotected |
Pointer to the single element (if not NULL)
Definition at line 572 of file buffers.hh.
Referenced by Minor::InputBuffer< Minor::ForwardInstData >::empty(), Minor::InputBuffer< Minor::ForwardInstData >::front(), Minor::InputBuffer< Minor::ForwardInstData >::pop(), Minor::InputBuffer< Minor::ForwardInstData >::pushTail(), and Minor::InputBuffer< Minor::ForwardInstData >::setTail().
◆ queue
|
mutableprotected |
Underlying queue.
Definition at line 569 of file buffers.hh.
Referenced by Minor::InputBuffer< Minor::ForwardInstData >::canReserve(), Minor::InputBuffer< Minor::ForwardInstData >::empty(), Minor::InputBuffer< Minor::ForwardInstData >::freeReservation(), Minor::InputBuffer< Minor::ForwardInstData >::front(), Minor::InputBuffer< Minor::ForwardInstData >::minorTrace(), Minor::InputBuffer< Minor::ForwardInstData >::pop(), Minor::InputBuffer< Minor::ForwardInstData >::pushTail(), Minor::InputBuffer< Minor::ForwardInstData >::reserve(), Minor::InputBuffer< Minor::ForwardInstData >::setTail(), and Minor::InputBuffer< Minor::ForwardInstData >::unreservedRemainingSpace().
The documentation for this class was generated from the following file:
- cpu/minor/buffers.hh