このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。

mustBeUnderlyingType

値に基となる型が指定されていることを検証

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

構文

mustBeUnderlyingType(value,typenames)

説明

mustBeUnderlyingType(value,typenames) は、value が typenames で指定されたいずれの基となるデータ型ももたない場合にエラーをスローします。この関数は値を返しません。

mustBeUnderlyingType は以下の関数を呼び出して、入力が指定された基となる型をもつかどうかを判別します。

クラス サポート: すべての MATLAB® クラス

例

例

すべて折りたたむ

mustBeUnderlyingType を使用して、入力が基となる型 double をもっていることを検証します。

distributed 配列を作成してから (Parallel Computing Toolbox™ が必要)、基となるデータ型が double であることを検証します。

x = distributed(single(1:10));
mustBeUnderlyingType(x,"double")
Starting parallel pool (parpool) using the 'local' profile ...
Connected to the parallel pool (number of workers: 6).
Value must have underlying type 'double'.

分散配列の基となる型が single であるため、mustBeUnderlyingType はエラーをスローします。

チェックするデータ型は複数指定できます。 (R2024a 以降) double 型の 2 つ目の分散配列を定義します。

y = distributed(double(1:10));

double と single の両方が指定されている場合、mustBeUnderlyingType は x または y に対してエラーをスローしません。

mustBeUnderlyingType(x,["double","single"])
mustBeUnderlyingType(y,["double","single"])

mustBeUnderlyingType を使用して、関数によって受け入れられる入力引数値を制限します。これを行うには、入力引数を検証する関数に arguments ブロックを追加します。

この関数は 1 つの入力引数を宣言します。arguments ブロックでは、入力は基となるデータ型 single をもたなければなりません。

function y = mbSingle(input)
    arguments
        input {mustBeUnderlyingType(input,"single")}
    end

    disp("Input is class " + class(input) + ...
        " with underlying type " + underlyingType(input) + ".")
end

基となるデータ型 single をもつ distributed ベクトル (Parallel Computing Toolbox が必要) を使用して関数を呼び出します。入力が引数の検証に渡されるため、関数 mbSingle はクラスおよび基となる型に関する情報を出力します。

x = distributed(single(1:10));
mbSingle(x)
Starting parallel pool (parpool) using the 'local' profile ...
Connected to the parallel pool (number of workers: 6).
Input is class distributed with underlying type single.

入力引数

すべて折りたたむ

検証する値。スカラー、配列、またはオブジェクトとして指定します。

例: mustBeUnderlyingType(magic(4),"single")

テストする 1 つ以上のデータ型の名前。string 配列、文字ベクトル、または文字ベクトルの cell 配列として指定します。

例: mustBeUnderlyingType(X,["double","single"]) は、X が基となる型 double または single をもたない場合にエラーをスローします。

データ型: char | string

ヒント

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

拡張機能

すべて展開する

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

バージョン履歴

R2020b で導入

すべて展開する

参考

| | |

トピック