JTRIGGER::JFrame_t< JElement_t, JAllocator_t > Class Template Reference

Data frame with end marker. More...

#include <JFrame_t.hh>

Inheritance diagram for JTRIGGER::JFrame_t< JElement_t, JAllocator_t >:

Public Member Functions
	JFrame_t ()
	Default constructor. More...
	JFrame_t (const JFrame_t &frame)
	Copy constructor. More...
	JFrame_t (JFrame_t &&frame)
	Move constructor. More...
JFrame_t &	operator= (const JFrame_t &frame)
	Assignment operator. More...
JFrame_t &	operator= (JFrame_t &&frame)
	Move assignment operator. More...
bool	hasEndMarker () const
	Check presence of end marker. More...
void	putEndMarker ()
	Append end marker to data. More...
void	reset ()
	Reset. More...

Detailed Description

template<class JElement_t, class JAllocator_t = std::allocator<JElement_t>>
class JTRIGGER::JFrame_t< JElement_t, JAllocator_t >

Data frame with end marker.

The end marker is a special element that is used in JTOOLS::JMergeSort to speed up the sorting of data.
It is placed within the capacity of the container whilst its size is maintained.
Here, it is defined by an element of which the time is larger than any possible nominal value.
The end marker should manually be put using method putEndMarker() after modifications of the contents of the container.

Definition at line 27 of file JFrame_t.hh.

Constructor & Destructor Documentation

template<class JElement_t, class JAllocator_t = std::allocator<JElement_t>>

JTRIGGER::JFrame_t< JElement_t, JAllocator_t >::JFrame_t ( )

inline

Default constructor.

Empty container with end marker.

Definition at line 37 of file JFrame_t.hh.

    {
      this->putEndMarker();
    }

template<class JElement_t, class JAllocator_t = std::allocator<JElement_t>>

JTRIGGER::JFrame_t< JElement_t, JAllocator_t >::JFrame_t ( const JFrame_t< JElement_t, JAllocator_t > &  frame )

inline

Copy constructor.

Parameters

frame

frame

Definition at line 48 of file JFrame_t.hh.

                                    :
      std::vector<JElement_t, JAllocator_t>(frame.begin(), frame.end())
    {
      this->putEndMarker();
    }

template<class JElement_t, class JAllocator_t = std::allocator<JElement_t>>

JTRIGGER::JFrame_t< JElement_t, JAllocator_t >::JFrame_t ( JFrame_t< JElement_t, JAllocator_t > &&  frame )

inline

Move constructor.

Parameters

frame

frame

Definition at line 60 of file JFrame_t.hh.

    {
      this->swap(frame);
      this->putEndMarker();
    }

Member Function Documentation

template<class JElement_t, class JAllocator_t = std::allocator<JElement_t>>

JFrame_t& JTRIGGER::JFrame_t< JElement_t, JAllocator_t >::operator= ( const JFrame_t< JElement_t, JAllocator_t > &  frame )

inline

Assignment operator.

Parameters

frame

frame

Returns

this frame

Definition at line 73 of file JFrame_t.hh.

    {
      this->assign(frame.begin(), frame.end());
      this->putEndMarker();

      return *this;
    }

template<class JElement_t, class JAllocator_t = std::allocator<JElement_t>>

JFrame_t& JTRIGGER::JFrame_t< JElement_t, JAllocator_t >::operator= ( JFrame_t< JElement_t, JAllocator_t > &&  frame )

inline

Move assignment operator.

Parameters

frame

frame

Returns

this frame

Definition at line 88 of file JFrame_t.hh.

    {
      this->swap(frame);
      this->putEndMarker();

      return *this;
    }

template<class JElement_t, class JAllocator_t = std::allocator<JElement_t>>

bool JTRIGGER::JFrame_t< JElement_t, JAllocator_t >::hasEndMarker ( ) const

inline

Check presence of end marker.

Returns

true if end marker present; else false

Definition at line 102 of file JFrame_t.hh.

    {
      return (this->capacity() > this->size() && this->getT(*(this->end())) == this->getT(this->getEndMarker()));
    }

template<class JElement_t, class JAllocator_t = std::allocator<JElement_t>>

void JTRIGGER::JFrame_t< JElement_t, JAllocator_t >::putEndMarker ( )

inline

Append end marker to data.

Definition at line 111 of file JFrame_t.hh.

    {
      if (this->capacity() <= this->size()) {
        this->reserve(this->size() + 1);
      }

      *(this->end()) = this->getEndMarker();
    }

template<class JElement_t, class JAllocator_t = std::allocator<JElement_t>>

void JTRIGGER::JFrame_t< JElement_t, JAllocator_t >::reset ( )

inline

Reset.

Clear container and put end marker.

Definition at line 126 of file JFrame_t.hh.

    {
      this->clear();
      this->putEndMarker();
    }

---

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

• JFrame_t.hh