関数realParameterTooLarge マニュアル

(The documentation of function realParameterTooLarge)

Last Update: 2022/9/2

◆機能・用途(Purpose)

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

◆形式(Format)

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

◆引数(Arguments)

parameterName	パラメータ名。 A parameter name.
parameterValue	パラメータ値。 The value of the parameter.
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)

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

エラー : パラメータparameterNameの値として parameterValueが指定されましたが、この値はmaximumValueよりも小さくなければなりません。
ERROR : parameterValue was specified for parameter "parameterName", which must be less than maximumValue.

それ以外の場合
In other cases

エラー : パラメータparameterNameの値として parameterValueが指定されましたが、この値はパラメータmaximum_parameterNameの値 (maximumValue)よりも小さくなければなりません。
ERROR : parameterValue was specified for parameter "parameterName", which must be less than the value of parameter "maximum_parameterName" (maximumValue).

◆使用例(Example)

if(d>=2.0){
realParameterTooLarge("d", d, 2.0, "");
}

if(c>=d){
realParameterTooLarge("c", c, d, "d");
}