designlab::AverageCalculator< T, typename > クラステンプレート

平均値，分散，標準偏差を求めるテンプレートクラス． [詳解]

#include <average_calculator.h>

公開メンバ関数
	AverageCalculator ()
void	AddData (const T &data, const bool do_calc=true)
	データを追加する． この関数を呼び出すたびに，平均値，分散，標準偏差が再計算される．
void	Clear ()
	データをクリアする．
void	Calculate ()
	平均値，分散，標準偏差を計算する．
std::optional< T >	GetAverage () const
	平均値を取得する．
std::optional< T >	GetVariance () const
	分散を取得する．
std::optional< T >	GetStandardDeviation () const
	標準偏差を取得する．
size_t	GetDataNum () const
	データ数を取得する．
std::optional< T >	GetSum () const
	データの合計を取得する．

詳解

template<typename T, typename = std::enable_if_t<std::is_arithmetic<T>::value>>
class designlab::AverageCalculator< T, typename >

平均値，分散，標準偏差を求めるテンプレートクラス．

テンプレート引数

T	平均値，分散，標準偏差を求める型．

average_calculator.h の 23 行目に定義があります。

構築子と解体子

AverageCalculator()

template<typename T , typename = std::enable_if_t<std::is_arithmetic<T>::value>>

designlab::AverageCalculator< T, typename >::AverageCalculator ( )

inline

average_calculator.h の 26 行目に定義があります。

関数詳解

AddData()

template<typename T , typename = std::enable_if_t<std::is_arithmetic<T>::value>>

void designlab::AverageCalculator< T, typename >::AddData ( const T &  data, const bool  do_calc = true  )

inline

データを追加する．
この関数を呼び出すたびに，平均値，分散，標準偏差が再計算される．

引数

[in]	data	追加するデータ．
[in]	do_calc	平均値，分散，標準偏差を再計算するかどうか．デフォルトでは再計算する．

average_calculator.h の 39 行目に定義があります。

呼び出し関係図:

Calculate()

template<typename T , typename = std::enable_if_t<std::is_arithmetic<T>::value>>

void designlab::AverageCalculator< T, typename >::Calculate ( )

inline

平均値，分散，標準偏差を計算する．

average_calculator.h の 70 行目に定義があります。

被呼び出し関係図:

Clear()

template<typename T , typename = std::enable_if_t<std::is_arithmetic<T>::value>>

void designlab::AverageCalculator< T, typename >::Clear ( )

inline

データをクリアする．

覚え書き

平均値，分散，標準偏差は nullopt になる．

average_calculator.h の 60 行目に定義があります。

GetAverage()

template<typename T , typename = std::enable_if_t<std::is_arithmetic<T>::value>>

std::optional< T > designlab::AverageCalculator< T, typename >::GetAverage ( ) const

inline

平均値を取得する．

戻り値

平均値．データが空の場合は nullopt．

average_calculator.h の 99 行目に定義があります。

GetDataNum()

template<typename T , typename = std::enable_if_t<std::is_arithmetic<T>::value>>

size_t designlab::AverageCalculator< T, typename >::GetDataNum ( ) const

inline

データ数を取得する．

戻り値

データ数．

average_calculator.h の 120 行目に定義があります。

GetStandardDeviation()

template<typename T , typename = std::enable_if_t<std::is_arithmetic<T>::value>>

std::optional< T > designlab::AverageCalculator< T, typename >::GetStandardDeviation ( ) const

inline

標準偏差を取得する．

戻り値

標準偏差．データが空の場合は nullopt．

average_calculator.h の 113 行目に定義があります。

GetSum()

template<typename T , typename = std::enable_if_t<std::is_arithmetic<T>::value>>

std::optional< T > designlab::AverageCalculator< T, typename >::GetSum ( ) const

inline

データの合計を取得する．

戻り値

データの合計．データが空の場合は nullopt．

average_calculator.h の 127 行目に定義があります。

GetVariance()

template<typename T , typename = std::enable_if_t<std::is_arithmetic<T>::value>>

std::optional< T > designlab::AverageCalculator< T, typename >::GetVariance ( ) const

inline

分散を取得する．

戻り値

分散．データが空の場合は nullopt．

average_calculator.h の 106 行目に定義があります。

---

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

• DesignLab/average_calculator.h