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

mustBeNumericOrLogical

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

構文

mustBeNumericOrLogical(value)

説明

mustBeNumericOrLogical(value) は value が数値と logical のいずれでもない場合にエラーを発行します。この関数は値を返しません。

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

• isnumeric または islogical

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

例

入力が数値または論理値であることを検証

オブジェクト プロパティの値が数値または論理値であることを検証します。

a = axes;
mustBeNumericOrLogical(a.Visible)

Error using mustBeNumericOrLogical (line 11)
Values must be numeric or logical.

この場合、Visible プロパティの値は char ベクトルなので、エラーが発生します。

プロパティ値の制限

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

classdef MyClass
   properties
      Prop1 {mustBeNumericOrLogical}
   end
end

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

obj = MyClass;
obj.Prop1 = get(gca,'Visible');

Error setting 'Prop1' property of 'MyClass' class:
Values must be numeric or logical.

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

関数の引数値の制限

この関数は、入力引数を数値ベクトルまたは logical ベクトルに制限します。

function r = mbNumericOrLogical(x)
    arguments
        x (1,:) {mustBeNumericOrLogical}
    end
    p = [3 2 1];
    r = polyval(p,x);
end

文字ベクトルを指定してこの関数を呼び出すと、mustBeNumericOrLogical によってエラーがスローされます。

x = '4 3 2';
r = mbNumericOrLogical(x);

Error using mbNumericOrLogical
Invalid input argument at position 1. Value must be numeric or logical.

入力引数

value — 検証する値

スカラー | 配列

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

• logical または数値クラス

• isnumeric または islogical を実装する MATLAB クラス

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

拡張機能

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

参考

arguments | mustBeNumeric

トピック

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

R2017a で導入