Main Content

このページの翻訳は最新ではありません。ここをクリックして、英語の最新版を参照してください。

mustBeNonnegative

値が非負であることを検証

ページ内をすべて折りたたむ

構文

mustBeNonnegative(value)

説明

例

mustBeNonnegative(value)は、valueが負である場合にエラーをスローします。この関数は値を返しません。

mustBeNonnegativeは以下の関数を呼び出して、入力が負でないかどうかを判別します。

クラス サポート: すべての数値クラス、logical、およびmustBeNonnegativeによって呼び出される関数をオーバーロードする MATLAB®クラス。

例

すべて折りたたむ

mustBeNonnegativeを使用して、入力に非負の値しか含まれていないことを検証します。

関数randnは正規分布した乱数を作成します。

A = randn(1,5);

これらの乱数が非負であることを検証します。

mustBeNonnegative(A)
Error using mustBeNonnegative (line 14) Value must be nonnegative.

このクラスはProp1の値を非負の値に制限します。

classdefMyClasspropertiesProp1{mustBeNonnegative}endend

オブジェクトを作成して、プロパティに値を割り当てます。

obj = MyClass; obj.Prop1 = -10;
Error using mustBeNonnegative (line 14) Value must be nonnegative.

プロパティに値を割り当てると、MATLAB はプロパティに割り当てた値を使用してmustBeNonnegativeを呼び出します。値-10は負であるため、mustBeNonnegativeはエラーを発行します。

この関数は、2 つの入力引数を宣言します。入力lowerは非負でなければならず、入力上は正でなければなりません。

functionr = mbNonnegative(lower,upper)argumentslower{mustBeNonpositive}上{mustBeNonnegative}endx = lower*pi:upper*pi; r = sin(x);end

mustBeNonnegativeの要件を満たさない上の値を指定して関数を呼び出すと、エラーになります。

r = mbNonnegative(-12,-4);
Error using mbNonnegative r = mbNonnegative(-12,-4); ↑ Invalid input argument at position 2. Value must be nonnegative.

入力引数

すべて折りたたむ

検証する値。スカラーまたは次のいずれかの配列として指定します。

例:value = 1はエラーを生成しません。

ヒント

  • mustBeNonnegativeは、プロパティと関数の引数の検証で使用されるように設計されています。

拡張機能

C/C++ コード生成
MATLAB® Coder™ を使用して C および C++ コードを生成します。

バージョン履歴

R2017a で導入

参考

||

トピック