ev::CircularBuffer_< T > Class Template Reference

This class extends boost::circular_buffer to implement event circular buffers. For more information, please refer here. More...

#include <circular.hpp>

Inheritance diagram for ev::CircularBuffer_< T >:

Public Member Functions
template<typename... Args>
void	emplace_back (Args &&...args)
	Construct an Event_<T> in-place at the back of the buffer.
template<typename... Args>
void	emplace_front (Args &&...args)
	Construct an Event_<T> in-place at the front of the buffer.
ResultType	duration () const
	Time difference between the last and the first event.
ResultType	rate () const
	Compute event rate as the ratio between the number of events and the time difference between the last and the first event.
Event_< ResultType >	mean () const
	Compute the mean of the events.
cv::Point_< ResultType >	meanPoint () const
	Compute the mean x,y point of the events.
ResultType	meanTime () const
	Compute the mean time of the events.
ResultType	midTime () const
	Calculate the midpoint time between the oldest and the newest event.

Detailed Description

template<typename T>
class ev::CircularBuffer_< T >

This class extends boost::circular_buffer to implement event circular buffers. For more information, please refer here.

Event circular buffers inherit all the properties from boost circular buffers. Circular buffers are fixed-size data structures in a circular fashion (i.e, the end of the buffer is reached, it wraps around to the beginning).

Member Function Documentation

duration()

template<typename T>

ResultType ev::CircularBuffer_< T >::duration ( ) const

inlinenodiscard

Time difference between the last and the first event.

Returns

Time difference

emplace_back()

template<typename T>

template<typename... Args>

void ev::CircularBuffer_< T >::emplace_back ( Args &&... args )

inline

Construct an Event_<T> in-place at the back of the buffer.

Arguments are forwarded to the Event_<T> constructor. If the buffer is full, the oldest element at the front is overwritten.

emplace_front()

template<typename T>

template<typename... Args>

void ev::CircularBuffer_< T >::emplace_front ( Args &&... args )

inline

Construct an Event_<T> in-place at the front of the buffer.

Arguments are forwarded to the Event_<T> constructor. If the buffer is full, the oldest element at the back is overwritten.

mean()

template<typename T>

Event_< ResultType > ev::CircularBuffer_< T >::mean ( ) const

inlinenodiscard

Compute the mean of the events.

Returns

An Eventd object containing the mean values of x, y, t, and p attributes.

meanPoint()

template<typename T>

cv::Point_< ResultType > ev::CircularBuffer_< T >::meanPoint ( ) const

inlinenodiscard

Compute the mean x,y point of the events.

Returns

Mean point

meanTime()

template<typename T>

ResultType ev::CircularBuffer_< T >::meanTime ( ) const

inlinenodiscard

Compute the mean time of the events.

Returns

Mean time

midTime()

template<typename T>

ResultType ev::CircularBuffer_< T >::midTime ( ) const

inlinenodiscard

Calculate the midpoint time between the oldest and the newest event.

Returns

Midpoint time.

rate()

template<typename T>

ResultType ev::CircularBuffer_< T >::rate ( ) const

inlinenodiscard

Compute event rate as the ratio between the number of events and the time difference between the last and the first event.

Returns

Event rate

---

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

• modules/containers/include/openev/containers/circular.hpp