Main Content

mustBeInRange

验证值在指定范围内

自 R2020b 起

    说明

    示例

    如果 value 的任何元素都不在 lowerupper 定义的范围内,则 mustBeInRange(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
     r = inRange([2 5 100]);
                 ↑
    Invalid argument at position 1. Value must be greater than or equal to 0, and less than 100.

    输入参数

    全部折叠

    要验证的值,指定为标量或支持关系运算符 >>=<<= 的数值、逻辑值或用户定义类型的数组。

    范围的下界,指定为与 value 类型相同的值。

    范围的上界,指定为与 value 类型相同的值。

    包括或排除范围的上界或下界,指定为以下一项或两项:

    • inclusive - 在允许值的范围内包括 lowerupper 值。

    • exclusive - 从允许值的范围中排除 lowerupper 值。

    • exclude-lower - 从允许值的范围中排除 lower 值。

    • exclude-upper - 从允许值的范围中排除 upper 值。

    使用不超过两个以上标志来指示下界和上界是应从范围中排除还是包含在范围中。这些标志的唯一有效组合是 exclude-lowerexclude-upper。此组合等效于只使用 exclusive

    数据类型: char | string

    提示

    • mustBeInRange 用于属性和函数参数验证。

    扩展功能

    C/C++ 代码生成
    使用 MATLAB® Coder™ 生成 C 代码和 C++ 代码。

    版本历史记录

    在 R2020b 中推出