isUnderlyingType

入力に基となるデータ型が指定されているかどうかを判別

構文

tf = isUnderlyingType(X,typename)

説明

tf = isUnderlyingType(X,typename) は、X の基となるデータ型が underlyingType(X) によって返される typename と等しい場合は、logical 1 (true) を返します。それ以外の場合、結果は logical 0 (false) です。

例

基となるデータ型のテスト

isUnderlyingType を使用して、複数の変数のデータ型をクエリします。

データ型 single をもつ数値変数を作成してから、基となるデータ型も single であるかどうかをテストします。

x = single(5);
tf = isUnderlyingType(x,"single")

tf =

  logical

   1

underlyingType(x) は 'single' を返すため、結果は true です。

次に、2 つの変数をもつ table を作成してから、基となるデータ型が string であるかどうかを判別します。

x = table([1; 2; 3],["a"; "b"; "c"]);
tf = isUnderlyingType(x,"string")

tf =

  logical

   0

この場合、underlyingType(x) は 'table' を返すため、結果は false です。

次に、distributed 配列を作成してから (Parallel Computing Toolbox™ が必要)、基となるデータ型が double であるかどうかを判別します。

x = distributed(1:10);
tf = isUnderlyingType(x,"double")

Starting parallel pool (parpool) using the 'local' profile ...
Connected to the parallel pool (number of workers: 6).

tf =

  logical

   1

underlyingType(x) は 'double' を返すため、結果は true です。この場合、class(x) は変数のクラスの名前を返しますが、underlyingType(x) は基となるデータのデータ型の名前を返します。

入力引数

X — 入力配列またはオブジェクト

変数 | 式

入力配列またはオブジェクト。変数または式として指定します。

例: isUnderlyingType(gpuArray(double(1)),"single") は、入力 gpuArray に基となるデータ型 single が含まれているかどうかテストします。

typename — テストするデータ型の名前

文字ベクトル | string スカラー

テストするデータ型の名前。文字ベクトルまたは string スカラーとして指定します。

例: isUnderlyingType(X,"double") は、X の型が基となる double 型であるかどうかテストします。

データ型: char | string

拡張機能

C/C++ コード生成

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

使用上の注意および制限:

• dlarray (Deep Learning Toolbox) 型の入力引数 X をサポートしていません。

スレッドベースの環境

MATLAB® の backgroundPool を使用してバックグラウンドでコードを実行するか、Parallel Computing Toolbox™ の ThreadPool を使用してコードを高速化します。

この関数はスレッドベースの環境を完全にサポートしています。詳細については、スレッドベースの環境での MATLAB 関数の実行を参照してください。

GPU 配列

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

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

分散配列

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

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

バージョン履歴

R2020b で導入

参考

class | underlyingType | mustBeUnderlyingType