mustBeReal

値が実数であることを検証

構文

mustBeReal(value)

説明

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

mustBeReal は以下の関数を呼び出して、入力が実数であるかどうかを判別します。

• isreal

クラス サポート: すべての数値クラス、logical、および isreal をオーバーロードする MATLAB^® クラス。

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

例

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

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

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

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

Value 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 property 'Prop1' of class 'MyClass'. Value 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 (line 3)
 r = mbReal(z);
            ^
Invalid 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
複素数のサポート: あり

ヒント

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

拡張機能

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

GPU 配列

Parallel Computing Toolbox™ を使用してグラフィックス処理装置 (GPU) 上で実行することにより、コードを高速化します。

mustBeReal 関数は、GPU 配列を完全にサポートします。GPU 上で関数を実行するには、入力データを gpuArray (Parallel Computing Toolbox) として指定します。詳細については、GPU での MATLAB 関数の実行 (Parallel Computing Toolbox)を参照してください。

分散配列

Parallel Computing Toolbox™ を使用して、クラスターの結合メモリ上で大きなアレイを分割します。

この関数は分散配列を完全にサポートしています。詳細については、分散配列を使用した MATLAB 関数の実行 (Parallel Computing Toolbox)を参照してください。

バージョン履歴

R2017a で導入

参考

arguments | isreal | mustBeFinite | mustBeNonNan | mustBeSparse

トピック

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