mustBeFloat

値が浮動小数点配列であることを検証

構文

mustBeFloat(value)

説明

mustBeFloat(value) は、value が浮動小数点配列でない場合にエラーをスローします。浮動小数点型は single と double、および single と double のサブクラスです。この関数は値を返しません。

mustBeFloat は以下の関数を呼び出して、入力が浮動小数点数であるかどうかを判別します。

• isfloat

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

例

入力が浮動小数点配列であることを検証

mustBeFloat を使用して、関数への入力が浮動小数点値であることを確認します。

関数 myCalc は、入力を浮動小数点配列に制限します。

function r = myCalc(a)
    arguments
        a {mustBeFloat}
    end
    r = a .* pi/180;
end

int8 値の配列を渡すとエラーになります。

a = int8([2 4 8 16]);
r = myCalc(a);

Error using myCalc (line 3)
 r = myCalc(a);
            ^
Invalid argument at position 1. Value must be a floating-point array.

入力引数

value — 検証する値

浮動小数点配列

検証する値。浮動小数点配列として指定します。

データ型: single | double

ヒント

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

拡張機能

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

GPU 配列

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

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

分散配列

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

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

バージョン履歴

R2020b で導入

参考

arguments | isfloat | mustBeNumeric

トピック

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