Main Content

mustBeInRange

値が指定した範囲にあることを検証

R2020b 以降

    説明

    mustBeInRange(value,lower,upper) は、value の要素が lower および upper により定義された範囲内にない場合にエラーをスローします。値が lower 以上および upper 以下である場合、その値は範囲内にあります。この関数は値を返しません。

    mustBeInRange は以下の関数を呼び出して、value が指定した範囲にあるかどうかを判別します。

    クラス サポート: すべての数値クラスと logical

    mustBeInRange(value,lower,upper,boundflag1,boundflag2) オプションのフラグ boundflag1boundflag2 を使用して、上限または下限が範囲に含まれているかどうかを示します。

    すべて折りたたむ

    関数 mustBeInRange を使用して、許容される値の範囲を制限します。

    mustBeInRange(255,0,1)
    Value must be greater than or equal to 0, and less than or equal to 1.

    範囲外の値はエラーになります。

    関数 mustBeInRange を使用して、関数に渡すことができる値の範囲を制限します。

    関数 inRange は、入力を 0 ~ 100 未満の範囲の値に制限します。

    function r = inRange(a)
        arguments
            a {mustBeInRange(a,0,100,"exclude-upper")}
        end
        r = a;
    end

    配列 [2 5 100] を渡すとエラーがスローされます。

    r = inRange([2 5 100])
    Error using inRange (line 3)
     r = inRange([2 5 100])
                 ^^^^^^^^^
    Invalid argument at position 1. Value must be greater than or equal to 0, and less than 100.

    入力引数

    すべて折りたたむ

    検証する値。スカラー、または数値、logical、あるいは関係演算子 >>=<、および <= をサポートするユーザー定義型の配列として指定します。

    範囲の下限。value と同じ型の値として指定します。

    範囲の上限。value と同じ型の値として指定します。

    上限または下限を範囲に含めるか、除外します。次のうち 1 つまたは 2 つを指定します。

    • inclusivelower 値および upper 値を許容される値の範囲に含めます。

    • exclusivelower 値および upper 値を許容される値の範囲から除外します。

    • exclude-lowerlower 値を許容される値の範囲から除外します。

    • exclude-upperupper 値を許容される値の範囲から除外します。

    これらのフラグを 2 つまで使用して、下限および上限を範囲から除外するかどうか、あるいは範囲に含めるかどうか示します。こうしたフラグの有効な組み合わせは exclude-lower および exclude-upper のみです。この組み合わせは、exclusive のみを使用するのと同じです。

    データ型: char | string

    ヒント

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

    拡張機能

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

    バージョン履歴

    R2020b で導入