関数create_timefunc マニュアル

(The documentation of function create_timefunc)
Last Update: 2021/12/8


◆機能・用途(Purpose)

指定した時間関数を表す時系列データを作成する。
Create a time series data which represents a specified time function.

◆形式(Format)

#include <sequence/timefunc.h>
inline struct sequence create_timefunc
(const char ∗timefunc_name,const double tp,const double ts,
 const int size,const double t0,const double dt,const int Nintegral)


◆引数(Arguments)

timefunc_name 時間関数名。 sequence/timefunc.hのマニュアル の冒頭に列挙してある時間関数名のうちのいずれか1つを選択する。
The name of the time function, which must be chosen from the list of the names at the top of the documentation of sequence/timefunc.h.
tp 時間関数の定義式における\(\tau_p\)の値。
The value of \(\tau_p\) in the definition equation of the time function.
ts 時間関数の定義式における\(\tau_s\)の値。 \(\tau_s\)を用いない時間関数の場合には ダミーの値を適当に与えれば良い。
The value of \(\tau_s\) in the definition equation of the time function. For a time function which does not consist of \(\tau_s\), specify an arbitrary dammy value.
size 作成する時系列データのサンプル数。
The number of samples of the time series data to create.
t0 作成する時系列データの先頭時刻。
The beginning time of the time series data to create.
dt 作成する時系列データのサンプリング間隔。
The sampling interval of the time series data to create.
Nintegral 積分回数。以下の4つの値のいずれかを指定する。
The number of integrals, which must be one of the followings.
\(-1\) 時間関数の微分形を作成する。
Create the differential form of the time function.
0 時間関数そのものを作成する。
Create the time function itself.
1 時間関数の1階積分形を作成する。
Create the 1st order integral form of the time function.
2 時間関数の2階積分形を作成する。
Create the 2nd order integral form of the time function.


◆戻り値(Return value)

引数Nintegralの値に応じて 時間関数の微分形、時間関数そのもの、 時間関数の1階積分形、2階積分形のいずれかを表す 時系列データ。
A time series data which represents either of the differential, original, 1st order integral, or 2nd order integral forms of the time function depending on argument Nintegral.

◆使用例(Example)

struct sequence timefunc=create_timefunc ("gaussian",5.0,2.5,10001,-2.0,0.01,1);

この例では\(\tau_p=5\) s, \(\tau_s=2.5\) sの関数gaussianの1階積分形が \(t\in [-2,98]\)の時間範囲において0.01 sのサンプリング間隔で作成される。
In this example, the first order integral form of function gaussian with \(\tau_p=5\) s and \(\tau_s=2.5\) s is created in a time range \(t\in [-2,98]\) at 0.01 s sampling intervals.