get_incrementコマンド マニュアル

(The documentation of get_increment command)
Last Update: 2022/12/5

◆機能・用途(Purpose)

一定間隔で刻まれたデータにおける刻み間隔を取得する。
Obtain the increment of a data that has a constant interval.

◆ソースコード(Source code)

$YMAEDA_OPENTOOL_DIR/general/src/get_increment.c


◆使用方法(Usage)

コマンドライン引数でパラメータを指定する。 パラメータの一覧を下表に示す。
Specify parameters by command-line arguments. The table below shows a list of parameters.

●「-」から始まらない引数 (Arguments not beginning with “-”)

引数
Argument 		与える値
Quantity to be given
第1引数
1st argument 		入力ファイル名。 入力ファイルはタブ区切りのテキストファイルとし、 全ての行の列数が等しくなければならない。 同じ列は同じ量(独立変数または従属変数)を表すものと想定される。 なお空行やコメント(#から後ろの部分)は 自由に挿入することができる。
The input file name. The file must be a text file with an equal number of columns (separated by tabs) for all lines. Quantities in the same column are assumed to be same, either an independent or a dependent variable. Empty lines and comments (parts after #) can be inserted at arbitrary places.


●1つの「-」から始まる引数 (Arguments beginning with a single “-”)

このコマンドでは1つの「-」から始まる引数は存在しない。
This command does not have arguments beginning with a single “-”.

●「--パラメータ名=パラメータ値」の形式の引数 (Arguments of a form “--Parameter name=Parameter Value”)

「--パラメータ名=パラメータ値」の形式の引数は自由な順番で指定できる。 「-」から始まらない引数の間に挿入しても良い。 相反する指定がなされた場合には後の指定が優先される。 デフォルト値を持つパラメータは省略できる。
Arguments of a form “--Parameter name=Parameter Value” can be placed in an arbitrary order. They can even be inserted between arguments not beginning with “-”. In case of conflicting options being specified, the latter option has a higher priority. Parameters that have default values can be omitted.
パラメータ名
Parameter name 		意味
Meaning 		可能なパラメータ値
Allowed parameter values 		デフォルト値
Default value
column 刻み間隔を調べる列番号。
The index of column to survey the increment. 		1以上、入力ファイルの列数以下の整数。
An integer greater than or equal to 1 and less than or equal to the number of columns of the input file. 		1


◆動作(Behaviour)

入力ファイルにおける、パラメータcolumnで指定した番号の列の値の増分を調べて 標準出力に表示する。 増分の調査方法としては、指定した列の値を全て読み込んだ上で昇順に並べ替え、 同じ値が複数回登場する部分は無視して増分を調べる。 増分が一定でない場合はプログラムをエラー終了する。
Survey the increment of the values in the column specified by parameter column of the input file, and output the result to the standard output. The increment is surveyed by first reading all values in the column specified, then sorting the data in an ascending order, and skipping multiple same values. If the increment is not constant, the program finishes as an error.

◆使用例(Example)

●例1(Example 1)

get_increment sample.txt
(sample.txt)
1[TAB]0.1[TAB]1.1
1[TAB]0.2[TAB]1.2
1[TAB]0.3[TAB]1.3
2[TAB]0.1[TAB]2.1
2[TAB]0.2[TAB]2.2
2[TAB]0.3[TAB]2.3
3[TAB]0.1[TAB]3.1
3[TAB]0.2[TAB]3.2
3[TAB]0.3[TAB]3.3

ここで[TAB]はタブを表す。
Here, [TAB] indicates a tab.
この例では第1列の値が1→2→3と1ずつ変化するので 増分は1となる。
In this example, the increment is 1 because the values in the 1st column increases by 1 as 1→2→3.

●例2(Example 2)

get_increment sample.txt --column=2
この例では第2列の値が0.1→0.2→0.3と0.1ずつ変化するので 増分は0.1となる。 なお、プログラム内部では第2列の値を全て (0.1, 0.2, 0.3, 0.1, 0.2, 0.3, 0.1, 0.2, 0.3) 読み込んだ上で昇順に並べ替え (0.1, 0.1, 0.1, 0.2, 0.2, 0.2, 0.3, 0.3, 0.3)、 連続する同じ値を無視して(0.1, 0.2, 0.3) 増分を調べる。
In this example, the increment is 0.1 because the values in the 2nd column increases by 0.1 as 0.1→0.2→0.3. Internally, the program surveys the increments by reading all values in the 2nd column (0.1, 0.2, 0.3, 0.1, 0.2, 0.3, 0.1, 0.2, 0.3), sorting them in an ascending order (0.1, 0.1, 0.1, 0.2, 0.2, 0.2, 0.3, 0.3, 0.3), and skipping consecutive same values (0.1, 0.2, 0.3).

●例3(Example 3)

get_increment sample.txt --column=3
この例では第3列の値が 1.1→1.2→1.3→2.1→2.2→2.3→3.1→3.2→3.3 と変化するので一定刻みではない。 したがってプログラムをエラー終了する。
In this example, the values in the 3rd column do not increase at constant intervals (1.1→1.2→1.3→2.1→2.2→2.3→3.1→3.2→3.3). Therefore the program finishes as an error.