関数imsequence_check マニュアル
(The documentation of function
imsequence_check
)
Last Update: 2021/12/7
◆機能・用途
(Purpose)
struct imsequence型構造体のメンバが適切に設定されているかチェックする。
Check if the members of a
struct imsequence
-type structure are properly set.
◆形式
(Format)
#include <sequence/check.h>
inline void imsequence_check(struct imsequence seq)
◆引数
(Arguments)
seq
チェックしたい構造体。
The structure to check.
◆使用例
(Example)
struct imsequence seq;
imsequence_check(seq);
◆チェック項目
(Checks conducted)
メンバsize>0になっているか
Whether the value of member
size
is greater than 0.
メンバdt>0.0になっているか
Whether the value of member
dt
is greater than 0.0.
メンバtmaxが他のメンバから期待される値(t0+(size-1)×dt)になっているか
Whether the value of member
tmax
is consistent with that expected from the other members (
t0+(size-1)×dt
)
メンバlengthが他のメンバから期待される値(tmax-t0)になっているか
Whether the value of member
length
is consistent with that expected from the other members (
tmax-t0
)
メンバvalueがNULLでないか
Whether the value of member
value
is not NULL
◆補足
(Additional remarks)
メンバchecked=’y’のときはチェックは行われない。
Checks are skipped if the value of member
checked
is equal to ’y’.
チェック項目を1つでも満たしていない場合はエラー終了する。
If one of the requirements is not met, the program finishes as an error.
チェックをパスしたらメンバcheckedの値が’y’に変更される。
After the checks are passed, the value of member
checked
is changed to ’y’.