最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

mustBeReal

値が実数であることを検証し、そうでない場合はエラーを発行

構文

mustBeReal(value)

説明

value が実数でない場合、mustBeReal(value) はエラーを発行します。この関数は値を返しません。

オブジェクトのクラスが次のメソッドを実装する場合、mustBeReal はユーザー定義オブジェクトを受け入れます。

• isreal

この関数は空の値である入力引数を無視します。このため、プロパティ値または関数の引数値が空の場合、エラーはスローされません。

例

入力が実数であることを検証

mustBeReal を使用して、入力が実数であることを検証します。

計算結果が実数であることを検証します。

x = -2:2;
z = x.^exp(-x.^2);
mustBeReal(z)

Error using mustBeReal (line 13)
values must be real.

z は複素数です。

プロパティ値の制限

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

classdef MyClass
   properties
      Prop1 {mustBeReal}
   end
end

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

x = -2:0.1:2;
obj = MyClass;
obj.Prop1 = x.^exp(-x.^2);

Error setting 'Prop1' property of 'MyClass' class:
values must be real.

プロパティに値を割り当てると、MATLAB^® はプロパティに割り当てた値を使用して mustBeReal を呼び出します。Prop1 に割り当てられた値が複素数であるため、mustBeReal はエラーを発行します。

関数の引数値の制限

この関数は、入力引数を実数値のスカラーに制限します。

function r = mbReal(z)
    arguments
        z (1,1) {mustBeReal}
    end
    r = randi(9,z);
end

複素数値を指定してこの関数を呼び出すと、mustBeReal によってエラーがスローされます。

x = -1;
z = x.^exp(-x.^2);
r = mbReal(z);

Error using mbReal
Invalid input argument at position 1. Value must be real.

入力引数

value — 検証する値

スカラー | 配列

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

• logical、char または数値クラス

• isreal を実装する MATLAB クラス

他のデータ型の場合、エラーが発生します。

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical | char
複素数のサポート: あり

拡張機能

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

参考

arguments | mustBeFinite | mustBeNonNan

トピック

• プロパティの検証関数
• 関数の引数の検証

R2017a で導入