関数realParameterOutOfRange_en マニュアル

(The documentation of function realParameterOutOfRange_en)
Last Update: 2023/7/10


◆機能・用途(Purpose)

実数パラメータの値が特定の値の範囲内 (下端を含むが上端を含まない)になければならない旨の エラーメッセージを出力してプログラムを終了する。
Display a message to inform that the value of a real-number parameter must be within a certain range (including the lower bound and not including the upper bound), and finish the program as an error.

◆形式(Format)

#include <argument.h>
inline void realParameterOutOfRange_en
(const char ∗parameterName,const double parameterValue,
 const double minimumValue,const char ∗minimum_parameterName,
 const double maximumValue,const char ∗maximum_parameterName)


◆引数(Arguments)

parameterName パラメータ名。
A parameter name.
parameterValue パラメータ値。
The value of the parameter.
minimumValue パラメータ値の許容範囲の下限。
The lower bound of the allowed parameter range.
minimum_parameterName 下限に対応するパラメータ名。 これを""とすれば パラメータ値ではなく定数での下限指定となる。
The parameter name corresponding to the lower bound. Using "" results in specifying the lower bound not as a parameter but as a constant.
maximumValue パラメータ値の許容範囲の上限。
The upper bound of the allowed parameter range.
maximum_parameterName 上限に対応するパラメータ名。 これを""とすれば パラメータ値ではなく定数での上限指定となる。
The parameter name corresponding to the upper bound. Using "" results in specifying the upper bound not as a parameter but as a constant.


◆表示するメッセージ (The message displayed)


◆使用例(Example)

double d,dmin,dmax;

if(d<1.0 || d>=2.0){
     realParameterOutOfRange_en ("d", d, 1.0, "", 2.0, "");
}

if(d<dmin || d>=dmax){
     realParameterOutOfRange_en ("d", d, dmin, "dmin", dmax, "dmax");
}