SlidingWindow< T > Class Template Reference

#include <data_structures.hpp>

Public Member Functions
	SlidingWindow (size_t size)
T	average () const
bool	empty () const
void	push (const T &value)
size_t	size () const
T	sum () const
const std::deque< T > &	window () const

Private Attributes
size_t	max_size_
T	sum_ = T()
std::deque< T >	window_

Detailed Description

template<typename T>
class SlidingWindow< T >

Definition at line 138 of file data_structures.hpp.

Constructor & Destructor Documentation

SlidingWindow()

template<typename T >

SlidingWindow< T >::SlidingWindow ( size_t  size )

inlineexplicit

Definition at line 145 of file data_structures.hpp.

                                        : max_size_(size) {
        if (size == 0)
            throw std::invalid_argument("Window size must be positive");
    }

References SlidingWindow< T >::size().

Member Function Documentation

average()

template<typename T >

T SlidingWindow< T >::average ( ) const

inline

Definition at line 160 of file data_structures.hpp.

                      {
        if (window_.empty())
            throw std::runtime_error("Window is empty");
        return sum_ / static_cast<T>(window_.size());
    }

References SlidingWindow< T >::sum_, and SlidingWindow< T >::window_.

Referenced by TEST().

empty()

template<typename T >

bool SlidingWindow< T >::empty ( ) const

inline

Definition at line 172 of file data_structures.hpp.

                       {
        return window_.empty();
    }

References SlidingWindow< T >::window_.

push()

template<typename T >

void SlidingWindow< T >::push ( const T &  value )

inline

Definition at line 150 of file data_structures.hpp.

                              {
        window_.push_back(value);
        sum_ += value;
 
        if (window_.size() > max_size_) {
            sum_ -= window_.front();
            window_.pop_front();
        }
    }

References SlidingWindow< T >::max_size_, SlidingWindow< T >::sum_, and SlidingWindow< T >::window_.

Referenced by TEST().

size()

template<typename T >

size_t SlidingWindow< T >::size ( ) const

inline

Definition at line 169 of file data_structures.hpp.

                        {
        return window_.size();
    }

References SlidingWindow< T >::window_.

Referenced by SlidingWindow< T >::SlidingWindow().

sum()

template<typename T >

T SlidingWindow< T >::sum ( ) const

inline

Definition at line 175 of file data_structures.hpp.

                  {
        return sum_;
    }

References SlidingWindow< T >::sum_.

window()

template<typename T >

const std::deque< T > & SlidingWindow< T >::window ( ) const

inline

Definition at line 166 of file data_structures.hpp.

                                      {
        return window_;
    }

References SlidingWindow< T >::window_.

Member Data Documentation

max_size_

template<typename T >

size_t SlidingWindow< T >::max_size_

private

Definition at line 141 of file data_structures.hpp.

Referenced by SlidingWindow< T >::push().

sum_

template<typename T >

T SlidingWindow< T >::sum_ = T()

private

Definition at line 142 of file data_structures.hpp.

Referenced by SlidingWindow< T >::average(), SlidingWindow< T >::push(), and SlidingWindow< T >::sum().

window_

template<typename T >

std::deque<T> SlidingWindow< T >::window_

private

Definition at line 140 of file data_structures.hpp.

Referenced by SlidingWindow< T >::average(), SlidingWindow< T >::empty(), SlidingWindow< T >::push(), SlidingWindow< T >::size(), and SlidingWindow< T >::window().

---

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

• data_structures.hpp