Main Content

mustBeVector

値がベクトルであることを検証

    説明

    mustBeVector(value) は、value がベクトルでない場合にエラーをスローします。ベクトルの次元は 1 行 n 列または n 行 1 列です。この関数は値を返しません。

    mustBeVector(value,"allow-all-empties") は、value がベクトルでない場合、あるいは空の配列でない場合にエラーをスローします。

    mustBeVector は以下の関数を呼び出して、入力がベクトルかどうかを判別します。

    クラス サポート: すべての数値クラス、logical、および isvector をオーバーロードする MATLAB® クラス。

    すべて折りたたむ

    値が行ベクトルまたは列ベクトルかどうかを判別します。

    a = rand(2);
    mustBeVector(a)
    Value must be a 1-by-n vector or an n-by-1 vector.

    入力が 2 行 2 列の配列であるため、mustBeVector はエラーをスローします。

    値を行ベクトルに形状変更します。

    b = reshape(a,[1,numel(a)])
    mustBeVector(b)

    mustBeVector が実行されます。エラーをスローしたり、値が返されることはありません。

    引数ブロックを使用して、関数の入力を mustBeVector および mustBeNumeric を使用して数値ベクトルに制限します。mustBeVectorallow-all-empties オプションを使用して、空の値を許可します。

    関数 WeeklyTotals は、入力ベクトルの要素を合計します。入力が空 ([]) である場合、合計はゼロとして返されます。

    function r = WeeklyTotals(DailyTotals)
        arguments
            DailyTotals {mustBeVector(DailyTotals,'allow-all-empties'), mustBeNumeric}
        end
        if isempty(DailyTotals)
            r = 0;
        else
            r = sum(DailyTotals);
        end
    end

    空の値を関数に渡すことが許可されています。

    r = WeeklyTotals([])
    r = 
        0

    入力引数

    すべて折りたたむ

    検証する値。行ベクトルまたは列ベクトルとして指定します。

    ヒント

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

    拡張機能

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

    バージョン履歴

    R2020b で導入