ymaeda_opentoolsのヘッダファイル

(Header files of ymaeda_opentools)

目次(Table of contents)


1. 概要 (Overview)

ymaeda_opentoolsのヘッダファイルはincludeディレクトリに入っており、 以下の構造になっている。
Header files of ymaeda_opentools are stored in include directory, which has a structure as below.
  • inc.h
  • macro.h
  • grobal.h
  • structure.h
  • prototype.h

  • 普通のヘッダファイル1 (Normal header file 1)
  • 普通のヘッダファイル2 (Normal header file 2)
  • …

  • サブディレクトリ1(Subdirectory 1)
    • index.h
    • macro.h
    • grobal.h
    • structure.h
    • prototype.h
    • 普通のヘッダファイル1 (Normal header file 1)
    • 普通のヘッダファイル2 (Normal header file 2)
    • …
  • サブディレクトリ2(Subdirectory 2)
    • index.h
    • macro.h
    • grobal.h
    • structure.h
    • prototype.h
    • 普通のヘッダファイル1 (Normal header file 1)
    • 普通のヘッダファイル2 (Normal header file 2)
    • …
  • …

サブディレクトリには特定の用途を持つヘッダファイルをまとめてある。 例えば行列計算のためのヘッダファイル群、時系列データ処理のためのヘッダファイル群、 といった具合である。 以下ではこれらをヘッダファイルパッケージ と呼ぶ。 一方、そのようにグルーピングできないものは includeディレクトリの下に直接置いてある。
Header files for specific purposes are grouped in subdirectories; for example, a group of header files for matrix calculations, that for time series data processings, etc. Below, these subdirectories are called header file packages. Header files which are not grouped are directly placed under the include directory.
inc.h, index.h, macro.h, grobal.h, structure.h, prototype.h は特殊な役割のヘッダファイルであり、 他のヘッダファイルとは分けて考えた方が良い。 これらの特殊なヘッダファイルの役割は以下の通りである。 これらの役割は全てのヘッダファイルパッケージ(サブディレクトリ) およびincludeディレクトリに直接置いてあるもので共通である。
The files inc.h, index.h, macro.h, grobal.h, structure.h, and prototype.h have special roles as below. These roles are common to all the header file packages (subdirectories) and to those directly placed under the include directory.

◆inc.h, index.h

他のヘッダファイル一式をインクルードするためのヘッダファイルである。
A header file to include all the other header files.

◆macro.h

マクロ定義が書かれている。
Macros are defined in these header files.

◆grobal.h

グローバル変数の定義が書かれている。
Grobal variables are defined in these header files.

◆structure.h

構造体(および共用体)の定義が書かれている。
Definitions of structures (and unions) are defined in these header files.

◆prototype.h

関数のプロトタイプが書かれている。 関数自体の定義とは分けてこれらを先に読み込むことで、 関数間の相互利用(定義の順番を気にせず1つの関数内で別の関数を呼ぶこと) が可能になる。
Prototypes of functions are given in these header files. The prototypes need to be read first, separately from the definitions of functions, to enable mutual use of the functions (i.e., calling one function from another without caring the order of definitions of them).

◆その他のヘッダファイル (The other header files)

上記以外のヘッダファイルには関数の定義が書かれている。
Functions are defined in all the remaining header files.

2. includeディレクトリに直接置かれているヘッダファイル (Header files which are directly placed under the include directory)

リンクをクリックすると各ヘッダファイルのマニュアルを閲覧できる。
The documentations of individual header files are available from the links.

◆特殊なヘッダファイル (Special header files)

ヘッダファイル名
Header file name 		機能・用途
Purpose
inc.h 他のヘッダファイル一式をインクルードするためのヘッダファイル。
A header file to include all the other header files.
macro.h マクロの定義。
Definitions of macros.
grobal.h グローバル変数の定義。
Definitions of grobal variables.
structure.h 構造体の定義。
Definitions of structures.
prototype.h 関数のプロトタイプ。
Prototypes of functions.

◆通常のヘッダファイル (Normal header files)

ヘッダファイル名
Header file name 		機能・用途
Purpose
argument.h コマンドライン引数の処理を補助する関数。
Functions to assist processings for command-line arguments.
compress.h データを圧縮・解凍する関数。
Functions to compress and uncompress data.
coordinate.h 座標を扱う関数。
Functions to treat coordinates.
doublemath.h double型変数に対する様々な数学処理を行う関数。
Functions to conduct verious mathematical operations for double-type variables.
equation.h 方程式の解を求める関数。
Functions to solve equations.
file.h ファイルの状態のチェックやファイルに対する各種処理を行う関数。
Functions to check the status and perform various processings for files.
fitting.h 直線などの簡単な数式でデータをフィッティングする関数。
Functions to fit data by simple equations (e.g., a straight line).
formula.h 数式を表す文字列を処理する関数。
Functions to treat a string that represents a mathematical formula.
fortran.h Fortranで書かれたプログラムをC言語で扱うための関数。
Functions to treat Fortran programs by a C language.
functions_with_errcheck.h C言語組み込み関数をエラーチェック付きで呼び出す関数。
Functions to call a built-in C function with error checks.
gaussian.h ガウス分布に対する様々な処理を行う関数。
Functions to perform various operations for Gaussian distributions.
geometry.h 幾何学の問題を扱う関数。
Functions to treat problems of geometries.
im.h 複素数に対する様々な数学処理を行う関数。
Functions to conduct various mathematical operations for complex numbers.
interpolate.h データの補間を行う関数。
Functions to interpolate data.
intmath.h int型変数に対する様々な数学処理を行う関数。
Functions to conduct verious mathematical operations for int-type variables.
mathfunc.h 特殊関数をはじめとする様々な数学関数の計算を行う関数。
Functions to conduct computations for various mathematical functions, including special functions.
msg.h メッセージの出力経路を設定・表示する関数。
Functions to display message output routes.
myendian.h リトルエンディアンとビッグエンディアンの間の変換を行う関数。
Functions to make conversion between little- and big-endians.
mymemory.h 配列の動的メモリの確保と解放を行う関数。
Functions to allocate and release dynamic memories for arrays.
mystring.h 文字列に対する様々な処理を行う関数。
Functions to perform various processings for strings.
mytime.h 日付・時刻を扱う関数。
Functions to deal with date and time.
random.h 乱数を用いて様々な処理を行う関数。
Functions to conduct various processings using random values.
sort.h 変数や配列の並べ替え(ソート)を行う関数。
Functions to change the order of variables and arrays (i.e., sort them).
sourcemec.h 地震のソースメカニズムを表現する関数。
Functions to represent source mechanisms of earthquakes.
statistics.h 様々な統計量を計算する関数。
Functions to compute various statistical quantities.

3. サブディレクトリ(ヘッダファイルパッケージ) (Subdirectories (header file packages))

リンクをクリックすると各ヘッダファイルパッケージのマニュアルを閲覧できる。
The documentations of individual header file packages are available from the links.
パッケージ名
Package name 		機能・用途
Purpose
3d_data 3次元データに対して様々な処理を行うヘッダファイル。
Header files to perform various operations for 3-D data.
IAPWS95 IAPWS-95に基づいてH2Oの物性値を計算するヘッダファイル。
Header files to compute the H2O properties based on IAPWS-95.
array 地震波のアレイ解析に用いるヘッダファイル。
Header files used for array analyses of seismic waves.
machine_learning 機械学習に用いるヘッダファイル。
Header files used for machine learnings.
matrix 行列に対して様々な処理を行うヘッダファイル。
Header files to perform various operations for matrices.
ray 地震の波線の計算に用いるヘッダファイル。
Header files used to compute the ray of the seismic wave.
sac Seismic Analysis Code (SAC) 形式のデータの読み書きや処理に用いるヘッダファイル。
Header files used to read, write, and perform operations for data in Seismic Analysis Code (SAC) format.
sequence 時系列データやフーリエスペクトルに対して 様々な処理を行うヘッダファイル。
Header files to perform various operations for treat time series and Fourier spectral data.
traveltime 地震波の走時を扱うヘッダファイル。
Header files to treat the travel times of seismic waves.
tws 地震波や地殻変動の理論計算に用いるヘッダファイル。
Header files used to calculate synthetic seismic waves and crustal deformations.
win WINファイルの読み書きやデータ処理を行うヘッダファイル。
Header files to read, write, and perform data processings for WIN files.
xml Extensible Markup Language (XML)形式のデータに対して 様々な処理を行うヘッダファイル。
Header files to perform various operations for data in Extensible Markup Language (XML) format.

4. 索引 (Indices)