関数sequence_residual マニュアル

(The documentation of function sequence_residual)

Last Update: 2021/12/8


◆機能・用途(Purpose)

2つの時系列データのRMS残差を計算する。
Calculate the root mean square residual of two time series data.


◆形式(Format)

#include <sequence/statistics.h>
inline double sequence_residual
(const struct sequence seq1,const struct sequence seq2, const char ∗format)


◆引数(Arguments)

seq1 計算に用いる1つ目の時系列データを表す構造体。
A structure to represent the first time series data used for the computation.
seq2 計算に用いる2つ目の時系列データを表す構造体。 サンプルサイズ、先頭時刻、時間刻みはseq1と同じでなければならない。
A structure to represent the first time series data used for the computation. The sample size, beginning time, and sampling interval of this time series data must be identical to those of seq1.
format 残差の定義を表す文字列で、以下のいずれかとする。
A string which represents the definition of the residual, which must be one of the followings.

  • "absolute"
    \[\begin{equation} E=\sqrt{\sum_{k=0}^{N-1}(f_1^k-f_2^k)^2} \label{eq.absolute} \end{equation}\]
  • "ratio_seq1"
    \[\begin{equation} E=\sqrt{\frac{\sum_{k=0}^{N-1}(f_1^k-f_2^k)^2} {\sum_{k=0}^{N-1}(f_1^k)^2}} \label{eq.ratio_seq1} \end{equation}\]
  • "ratio_seq2"
    \[\begin{equation} E=\sqrt{\frac{\sum_{k=0}^{N-1}(f_1^k-f_2^k)^2} {\sum_{k=0}^{N-1}(f_2^k)^2}} \label{eq.ratio_seq2} \end{equation}\]

ここで定義式中の記号は以下のように定義した。
Here, the symbols in these definition equations are defined as below.

記号
Symbol
意味
Meaning

Value
\(N\) 時系列データのサンプルサイズ。
The sample size of the time series data.
seq1.size (\(=\) seq2.size)
\(f_1^k\) 1つ目の時系列データの\(k\)番目のサンプルの値。
The value of \(k\)th sample of the first time series data.
seq1.value[k]
\(f_2^k\) 2つ目の時系列データの\(k\)番目のサンプルの値。
The value of \(k\)th sample of the second time series data.
seq2.value[k]


◆戻り値(Return value)

引数formatの値に応じて(\ref{eq.absolute})-(\ref{eq.ratio_seq2})で定義される 残差の値。
The residual value, defined by either of eqs. (\ref{eq.absolute})-(\ref{eq.ratio_seq2}) depending on the value of argument format.


◆使用例(Example)

struct sequence data_obs,data_syn;
double R=sequence_residual(data_obs,data_syn,"ratio_seq1");