sequence/macro.h マニュアル
(The documentation of sequence/macro.h)
Last Update: 2021/12/7
sequence/macro.hでは
sequenceヘッダファイルパッケージで主に用いるマクロが定義されている。
各マクロの定義を以下に示す。
Macros mainly used in sequence header file package
are defined in sequence/macro.h.
Definitions of individual macros are shown below.
◆共通事項
(Notes common to all macros)
- C言語組み込みヘッダファイル内に同名のマクロが存在する場合であっても
ymaeda_opentoolsのマクロ定義が優先される。
そのために#undefしてから#defineするようにしている。
The definitions of macros in ymaeda_opentools
are used with a higher priority than
macros with the same name in built-in header files of the C language.
To realize this, each macro is defined
after canceling existing definitions by #undef.
- 特定のプログラムにおいてmacro.hの設定と異なるマクロの値を使用したい場合、
inc.hのインクルードよりも前に
#define USER_DEFINED_マクロ名
#define マクロ名 値
と書く。例えば特定のプログラムにおいて
マクロZERO_THRESHOLDの値を1.0e-06にしたい場合、
#define USER_DEFINED_ZERO_THRESHOLD
#define ZERO_THRESHOLD 1.0e-06
#include <inc.h>
のように書けば良い。
To use the value of a macro different from that in macro.h
in a certain program, write as
#define USER_DEFINED_macro name
#define macro name value
before including inc.h.
For example, to use 1.0e-06 for a macro ZERO_THRESHOLD
in a certain program, write as
#define USER_DEFINED_ZERO_THRESHOLD
#define ZERO_THRESHOLD 1.0e-06
#include <inc.h>
at the head of the program.
◆目次(Table of contents)
マクロ名(Macro name):
read_sequence_file(inputfile)
値(Value):
read_sequence_file_(inputfile,"strict")
関数read_sequence_file_の第2引数"strict"を省いて
コーディングを簡潔にするためのマクロである。
関数read_sequence_file_ (sequence/readwrite.h)は
時系列データファイルを読み込む関数であり、第2引数によって
- "strict" : フォーマットチェック付きでの読み込み(安全)
- "fast" : フォーマットチェック無しでの読み込み(高速)
を切り替えられるようになっている。
しかしほとんどの場合、読み込みの速度は問題にならず、
ヒューマンエラーを防ぐために"strict"モードで読み込む場合が多い。
そこで第2引数を省いてコードを簡潔にするためにこのマクロが用いられる。
A macro to realize a brief coding
by omitting the 2nd argument "strict"
during a function call of read_sequence_file_.
The function read_sequence_file_ (sequence/readwrite.h)
can read a time series data file with two different modes,
which are switched using the 2nd argument as follows:
- "strict" : reading a file with format checks (safer), and
- "fast" reading a file without format checks (faster).
However, the "strict" mode is used in most cases,
as the speed of the reading is rarely a bottleneck
to the total processing time
and the format checks are important to detect human errors.
In these cases, this macro is used to omit the 2nd argument
to make the code brief.
マクロ名(Macro name):
read_sequence_file_fast(inputfile)
値(Value):
read_sequence_file_(inputfile,"fast")
関数read_sequence_file_の第2引数"fast"を省いて
コーディングを簡潔にするためのマクロである。
詳しくはマクロread_sequence_fileの解説参照。
A macro to realize a brief coding
by omitting the 2nd argument "strict"
during a function call of read_sequence_file_.
For detail, see the description for macro read_sequence_file.
マクロ名(Macro name):
read_imsequence_file(inputfile)
値(Value):
read_imsequence_file_(inputfile,"strict")
関数read_imsequence_file_の第2引数"strict"を省いて
コーディングを簡潔にするためのマクロである。
このマクロと関数read_imsequence_file_ (sequence/readwrite.h)の関係は、
マクロread_sequence_fileと関数read_sequence_file_の関係と同等であるので、
詳しくはマクロread_sequence_fileの解説参照。
A macro to realize a brief coding
by omitting the 2nd argument "strict"
during a function call of read_imsequence_file_.
The relation between this macro
and function read_imsequence_file_ (sequence/readwrite.h)
is equivalent to the relation between
macro read_sequence_file
and function read_sequence_file_;
for more detail, see the description for macro read_sequence_file.
マクロ名(Macro name):
read_imsequence_file_fast(inputfile)
値(Value):
read_imsequence_file_(inputfile,"fast")
関数read_imsequence_file_の第2引数"fast"を省いて
コーディングを簡潔にするためのマクロである。
詳しくはマクロread_imsequence_fileおよびread_sequence_fileの解説参照。
A macro to realize a brief coding
by omitting the 2nd argument "fast"
during a function call of read_imsequence_file_.
For detail, see the descriptions for macros
read_imsequence_file and read_sequence_file.
マクロ名(Macro name):
read_imsequence2_file(inputfile)
値(Value):
read_imsequence2_file_(inputfile,"strict")
関数read_imsequence2_file_の第2引数"strict"を省いて
コーディングを簡潔にするためのマクロである。
このマクロと関数read_imsequence2_file_ (sequence/readwrite.h)の関係は、
マクロread_sequence_fileと関数read_sequence_file_の関係と同等であるので、
詳しくはマクロread_sequence_fileの解説参照。
A macro to realize a brief coding
by omitting the 2nd argument "strict"
during a function call of read_imsequence2_file_.
The relation between this macro
and function read_imsequence2_file_ (sequence/readwrite.h)
is equivalent to the relation between
macro read_sequence_file
and function read_sequence_file_;
for more detail, see the description for macro read_sequence_file.
マクロ名(Macro name):
read_imsequence2_file_fast(inputfile)
値(Value):
read_imsequence2_file_(inputfile,"fast")
関数read_imsequence2_file_の第2引数"fast"を省いて
コーディングを簡潔にするためのマクロである。
詳しくはマクロread_imsequence2_fileおよびread_sequence_fileの解説参照。
A macro to realize a brief coding
by omitting the 2nd argument "fast"
during a function call of read_imsequence2_file_.
For detail, see the descriptions for macros
read_imsequence2_file and read_sequence_file.