関数realParameterTooSmall0 マニュアル

(The documentation of function realParameterTooSmall0)

Last Update: 2022/9/2

◆機能・用途(Purpose)

実数パラメータの値が特定の値以上でなければならない旨のエラーメッセージを出力してプログラムを終了する。
Display a message to inform that the value of a real-number parameter must be greater than or equal to a certain value, and finish the program as an error.

◆形式(Format)

#include <argument.h>
inline void realParameterTooSmall0
(const char ∗parameterName,const double parameterValue,
const double minimumValue,const char ∗minimum_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.

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

minimum_parameterName=""の場合
In cases where minimum_parameterName=""

エラー : パラメータparameterNameの値として parameterValueが指定されましたが、この値はminimumValue以上でなければなりません。
ERROR : parameterValue was specified for parameter "parameterName", which must be greater than or equal to minimumValue.

それ以外の場合
In other cases

エラー : パラメータparameterNameの値として parameterValueが指定されましたが、この値はパラメータminimum_parameterNameの値 (minimumValue)以上でなければなりません。
ERROR : parameterValue was specified for parameter "parameterName", which must be greater than or equal to the value of parameter "minimum_parameterName" (minimumValue).

◆使用例(Example)

if(d<2.0){
realParameterTooSmall0("d", d, 2.0, "");
}

if(c<d){
realParameterTooSmall0("c", c, d, "d");
}