Main Content

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

mustBeReal

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

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

構文

mustBeReal(value)

説明

例

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

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

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

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

例

すべて折りたたむ

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

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

x = -2:2; z = x.^exp(-x.^2); mustBeReal(z)
Error using mustBeReal (line 13) values must be real.

zは複素数です。

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

classdefMyClasspropertiesProp1{mustBeReal}endend

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

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はエラーを発行します。

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

functionr = mbReal(z)argumentsz(1,1) {mustBeReal}endr = 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.

入力引数

すべて折りたたむ

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

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

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

ヒント

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

拡張機能

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

参考

||

トピック

R2017a で導入

MATLAB ドキュメンテーション

サポート

MATLABで始めるディープラーニング

MATLABで始めるディープラーニング

ebookをダウンロードする