sequence/structure.h マニュアル

(The documentation of sequence/structure.h)
Last Update: 2021/12/7


sequence/structure.hでは sequenceヘッダファイルパッケージで主に用いる構造体が定義されている。 各構造体の定義を以下に示す。
Structures mainly used in sequence header file package are defined in sequence/structure.h. Definitions of individual structures are shown below.

◆目次(Table of contents)


◆struct sequence型構造体 (A struct sequence-type structure)

時系列データを表現するための構造体である。以下のメンバから成る。
A structure to represent a time series data. This structure is composed of the following members.
型
Type 		メンバ名
Name of member 		メンバの意味
Meaning of member
int size データサンプル数。
The number of data samples.
double t0 最初のサンプルの時刻。
The time of the first sample.
double dt データサンプルの時間刻み。
The time step of the data samples.
double tmax 最後のサンプルの時刻。
The time of the last sample.
double length データのウインドウ長。
The window length of the data.
double ∗ value 各時刻での値を並べた配列。
An array composed of the values at individual sample times.
char checked[1] 構造体が正しい構造になっていることをチェック済みか否かを示すフラグ。 正しい構造とは例えばデータ点数が正である、 メンバvalueが配列として動的メモリが確保されている(NULLではない)、 など構造体が時系列データを表すと見なせるように 各メンバの値が適切に設定されていることを指す。
  • チェック済みの場合: checked[0]=′y′
  • 未チェックの場合: checked[0]=′n′
である。 1文字だけであるが関数内での値の変更が関数外にも反映されるように、 またNULLにならないように固定長配列としている。
A flag indicating whether the structure has been checked that the members are properly set to represent a time series data; for example, whether the number of data points is positive, and whether the dynamic memory has been allocated for member value (i.e., it is not NULL). The value of this member is:
  • checked[0]=′y′ if the structure has been checked,
  • checked[0]=′n′ otherwise.
Although this is a single character, a fixed size array is used to reflect changes of the value in a function to outside of it, and to avoid NULL.
struct humanTime startDateTime データの先頭日時。 絶対時刻を用いない場合は未設定でも良い。
The beginning time of the data; setting this member can be skipped if the absolute time is not used.

◆struct imsequence型構造体 (A struct imsequence-type structure)

フーリエスペクトルや複素数値の時系列データを表現するための構造体である。 以下のメンバからなる。
A structure to represent a Fourier spectrum and a time series data of complex numbers. This structure is composed of the following members.
型
Type 		メンバ名
Name of member 		メンバの意味
Meaning of member
int size データサンプル数。
The number of data samples.
double t0 最初のサンプルの周波数(あるいは時刻)。 できるだけstruct sequence型構造体と同じ構造になるように あえてf0ではなくt0という名前にしている。
The frequency (or time) of the first sample. The name t0 is used, not f0, to make the format as similar as that of a struct sequence-type structure.
double dt データサンプルの周波数(あるいは時間)刻み。
The frequency (or time) step of the data samples.
double tmax 最後のサンプルの周波数(あるいは時刻)。
The frequency (or time) of the last sample.
double length データのウインドウ長。
The window length of the data.
struct im ∗ value 各周波数(あるいは時刻)での値を並べた配列。
An array composed of the values at individual sample frequencies (or times).
char checked[1] 構造体が正しい構造になっていることをチェック済みか否かを示すフラグ。
  • チェック済みの場合: checked[0]=′y′
  • 未チェックの場合: checked[0]=′n′
である。詳しくはstruct sequence型構造体の説明参照。
A flag indicating whether the structure has been checked. The value of this member is:
  • checked[0]=′y′ if the structure has been checked,
  • checked[0]=′n′ otherwise.
For more detail, see the description of a struct sequence-type structure.

◆struct imsequence2型構造体 (A struct imsequence2-type structure)

フーリエスペクトルや複素数値の時系列データを表現するための構造体(改良版)である。 以下のメンバからなる。
A structure (improved version) to represent a Fourier spectrum and a time series data of complex numbers. This structure is composed of the following members.
型
Type 		メンバ名
Name of member 		メンバの意味
Meaning of member
int size データサンプル数。
The number of data samples.
double t0 最初のサンプルの周波数(あるいは時刻)。 できるだけstruct sequence型構造体と同じ構造になるように あえてf0ではなくt0という名前にしている。
The frequency (or time) of the first sample. The name t0 is used, not f0, to make the format as similar as that of a struct sequence-type structure.
double dt データサンプルの周波数(あるいは時間)刻み。
The frequency (or time) step of the data samples.
double tmax 最後のサンプルの周波数(あるいは時刻)。
The frequency (or time) of the last sample.
double length データのウインドウ長。
The window length of the data.
double complex ∗ value 各周波数(あるいは時刻)での値を並べた配列。
An array composed of the values at individual sample frequencies (or times).
char checked[1] 構造体が正しい構造になっていることをチェック済みか否かを示すフラグ。
  • チェック済みの場合: checked[0]=′y′
  • 未チェックの場合: checked[0]=′n′
である。詳しくはstruct sequence型構造体の説明参照。
A flag indicating whether the structure has been checked. The value of this member is:
  • checked[0]=′y′ if the structure has been checked,
  • checked[0]=′n′ otherwise.
For more detail, see the description of a struct sequence-type structure.