iptcheckinput

配列の有効性をチェック

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

iptcheckinput は将来のリリースで削除される予定です。代わりに validateattributes を使用してください。

構文

iptcheckinput(A,valid_classes,valid_attributes, func_name,var_name,arg_pos)

説明

iptcheckinput(A,valid_classes,valid_attributes, func_name,var_name,arg_pos) は、入力配列 A の有効性をチェックし、配列が有効でない場合、形式を整えたエラー メッセージを発行します。

  • 配列が valid_classes と valid_attributes で指定された有効なクラスと属性を持っている場合、iptcheckinput は何も返しません。

  • クラスまたは属性が無効の場合、iptcheckinput は、関数名 (func_name)、変数名 (var_name) および引数位置 (arg_pos) に関する情報を含む形式を整えたエラー メッセージを発行します。これらの値はエラー メッセージを作成するためにのみ使用され、配列が有効かどうかのチェックには使用されません。

次の図では、エラー メッセージの形式と、iptcheckinput 引数を使用してカスタマイズ可能な箇所を示します。

Formatted error message that includes a function name, argument position, variable name, and attributes of a valid array.

例

例

すべて折りたたむ

このエラー メッセージをトリガーするために、3 次元配列を作成し、属性 '2d' をチェックします。C は 2 次元ではないため、iptcheckinput はエラー メッセージを返します。

A = [ 1 2 3; 4 5 6 ];
B = [ 7 8 9; 10 11 12];
C = cat(3,A,B);
iptcheckinput(C,{'numeric'},{'2d'},'func_name','var_name',2)
Function FUNC_NAME expected its second input, var_name, to be two-dimensional.

入力引数

すべて折りたたむ

入力配列。配列として指定します。

配列 A の有効なクラス。文字ベクトルの cell 配列として指定します。以下の表は、イメージ処理アプリケーションの一般的なクラスを示しています。

数値クラス

int8uint8single
int16uint16double
int32uint32 
int64uint64 

その他の一般的なクラス

categoricalcharcell
function_handlelogicalstring
structtable 

uint8、uint16、uint32、int8、int16、int32、single および double のクラスのセットの省略形として 'numeric' を使用できます。

例: {'logical' 'cell'} は、有効な配列が logical 配列または cell 配列でなければならないことを指定します。

配列 A の有効な属性。文字ベクトルの cell 配列として指定します。次の表は、サポートされている属性をアルファベット順に示しています。

2dcolumnevenfinite
integernonemptynonnannonnegative
nonsparsenonzerooddpositive
realrowscalar

twod

vector

   

valid_attributes を空の cell 配列 {} として指定した場合、iptcheckinput は A の属性をチェックしません。

例: {'real' 'nonempty' 'finite'} は、有効な配列が空でない実数で、有限値のみを含まなければならないことを指定します。

A が無効な配列の場合にエラー メッセージに含まれる関数名。文字ベクトルまたは string スカラーとして指定します。

データ型: char | string

A が無効な配列の場合にエラー メッセージに含まれる変数名。文字ベクトルまたは string スカラーとして指定します。

データ型: char | string

A が無効な配列の場合にエラー メッセージに含まれる引数位置。正の整数として指定します。

バージョン履歴

R2006a より前に導入

参考

| | | | |