FiniteHistory< T > Class Template Reference

#include <FiniteHistory.h>

Collaboration diagram for FiniteHistory< T >:

Public Member Functions
	FiniteHistory (size_t n)
	FiniteHistory ()
	FiniteHistory (const FiniteHistory &fh)
	FiniteHistory (FiniteHistory &&fh)
void	operator= (const FiniteHistory &fh)
void	operator= (FiniteHistory &&fh)
void	reset ()
void	add (T x)
	Add x to this history. More...
void	operator<< (T x)
	Convenient adding. More...
double	mean ()
	Compute the average. More...

Public Attributes
std::vector< T >	history
std::atomic< size_t >	history_size
std::atomic< size_t >	history_index
std::atomic< unsigned long >	N
OrderedLock	mutex

Detailed Description

template<typename T>
class FiniteHistory< T >

Author

steven piantadosi

Date

03/02/20

Constructor & Destructor Documentation

FiniteHistory() [1/4]

template<typename T>

FiniteHistory< T >::FiniteHistory ( size_t  n )

inline

FiniteHistory() [2/4]

template<typename T>

FiniteHistory< T >::FiniteHistory ( )

inline

FiniteHistory() [3/4]

template<typename T>

FiniteHistory< T >::FiniteHistory ( const FiniteHistory< T > &  fh )

inline

FiniteHistory() [4/4]

template<typename T>

FiniteHistory< T >::FiniteHistory ( FiniteHistory< T > &&  fh )

inline

Member Function Documentation

add()

template<typename T>

void FiniteHistory< T >::add ( T  x )

inline

Add x to this history.

Parameters

x

mean()

template<typename T>

double FiniteHistory< T >::mean ( )

inline

Compute the average.

Returns

operator<<()

template<typename T>

void FiniteHistory< T >::operator<< ( T  x )

inline

Convenient adding.

Parameters

x

operator=() [1/2]

template<typename T>

void FiniteHistory< T >::operator= ( const FiniteHistory< T > &  fh )

inline

operator=() [2/2]

template<typename T>

void FiniteHistory< T >::operator= ( FiniteHistory< T > &&  fh )

inline

reset()

template<typename T>

void FiniteHistory< T >::reset ( )

inline

Member Data Documentation

history

template<typename T>

std::vector<T> FiniteHistory< T >::history

history_index

template<typename T>

std::atomic<size_t> FiniteHistory< T >::history_index

history_size

template<typename T>

std::atomic<size_t> FiniteHistory< T >::history_size

mutex

template<typename T>

OrderedLock FiniteHistory< T >::mutex

N

template<typename T>

std::atomic<unsigned long> FiniteHistory< T >::N

---

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

• src/Statistics/FiniteHistory.h