ctrl::Accumulator< T, S > クラステンプレート

データの蓄積器 [詳解]

#include <accumulator.h>

公開メンバ関数
	Accumulator (const T &value=T())
	コンストラクタ [詳解]
	~Accumulator ()
	デストラクタ [詳解]
void	clear (const T &value=T())
	バッファをクリアする関数 [詳解]
void	push (const T &value)
	最新のデータを追加する関数 [詳解]
const T &	operator[] (const std::size_t index) const
	直近 index 番目の値を取得するオペレータ [詳解]
const T	average (const int n=S) const
	直近 n 個の平均を取得する関数 [詳解]
std::size_t	size () const
	リングバッファのサイズを返す関数 [詳解]

詳解

template<typename T, std::size_t S>
class ctrl::Accumulator< T, S >

データの蓄積器

テンプレート引数

T	データの型
S	蓄積するデータの数

構築子と解体子

Accumulator()

template<typename T , std::size_t S>

ctrl::Accumulator< T, S >::Accumulator ( const T &  value = T() )

inline

コンストラクタ

引数

[in]

value

バッファ内の全データに代入する初期値

                                    {
    buffer = new T[S];
    head = 0;
    clear(value);
  }

呼び出し関係図:

~Accumulator()

template<typename T , std::size_t S>

ctrl::Accumulator< T, S >::~Accumulator ( )

inline

デストラクタ

{ delete[] buffer; }

関数詳解

average()

template<typename T , std::size_t S>

const T ctrl::Accumulator< T, S >::average ( const int  n = S ) const

inline

直近 n 個の平均を取得する関数

引数

[in]

n

平均個数

戻り値

平均値

                                         {
    T sum = T();
    for (int i = 0; i < n; i++) {
      sum += buffer[(S + head - i) % S];
    }
    return sum / n;
  }

clear()

template<typename T , std::size_t S>

void ctrl::Accumulator< T, S >::clear ( const T &  value = T() )

inline

バッファをクリアする関数

引数

[in]

value

代入する値

                                   {
    for (int i = 0; i < S; i++) buffer[i] = value;
  }

operator[]()

template<typename T , std::size_t S>

const T& ctrl::Accumulator< T, S >::operator[] ( const std::size_t  index ) const

inline

直近 index 番目の値を取得するオペレータ

[0] 番目が最新のデータ、[size() - 1] 番目が最古のデータ

引数

[in]

index

直近何番目のデータかを指すインデックス

戻り値

直近 index 番目のデータ

                                                   {
    return buffer[(S + head - index) % S];
  }

push()

template<typename T , std::size_t S>

void ctrl::Accumulator< T, S >::push ( const T &  value )

inline

最新のデータを追加する関数

                            {
    head = (head + 1) % S;
    buffer[head] = value;
  }

size()

template<typename T , std::size_t S>

std::size_t ctrl::Accumulator< T, S >::size ( ) const

inline

リングバッファのサイズを返す関数

{ return S; }

---

このクラス詳解は次のファイルから抽出されました:

• ctrl/accumulator.h