mustBeGreaterThanOrEqual

验证值大于等于另一个值

全页折叠

语法

mustBeGreaterThanOrEqual(value,c)

说明

如果 value 中有任何元素小于标量 c，mustBeGreaterThanOrEqual(value,c) 将抛出错误。此函数不返回值。

mustBeGreaterThanOrEqual 调用以下函数来确定 value 是否大于或等于 c：

支持的类：重载 mustBeGreaterThanOrEqual 调用的函数的所有数值类、logical 和 MATLAB® 类。

此函数忽略第一个输入参量中的空值。因此，当属性或函数参量值为空时，不会抛出错误。

示例

示例

全部折叠

使用 mustBeGreaterThanOrEqual 验证数组中的值大于或等于 3。

mustBeGreaterThanOrEqual([2,3,4],3)
Value must be greater than or equal to 3.

将属性值限制为大于或等于指定的值。

该类将 Prop1 的值限制为大于等于 3。

classdef MyClass
   properties
      Prop1 {mustBeGreaterThanOrEqual(Prop1,3)}
   end
end

创建一个对象，并向其属性赋值。

obj = MyClass;
obj.Prop1 = 2;
Error setting property 'Prop1' of class 'MyClass'. Value must be greater than or equal to 3.

当您向属性赋值时，MATLAB 会使用赋给属性的值调用 mustBeGreaterThanOrEqual。mustBeGreaterThanOrEqual 将引发错误，因为值 2 不大于等于 3。

此函数将输入参量限制为大于或等于 5 的值。 

function r = mbGreaterThanOrEqual(x)
    arguments
        x {mustBeGreaterThanOrEqual(x,5)}
    end
    r = x - 5;
end

使用包含小于 5 的值的向量调用该函数不满足 mustBeGreaterThanOrEqual 定义的要求，并会引发错误。

x = [12.7, 45.4, 4.9, 77.1, 53.1];
r = mbGreaterThanOrEqual(x);
Error using mbGreaterThanOrEqual (line 3)
 r = mbGreaterThanOrEqual(x);
                          ^
Invalid argument at position 1. Value must be greater than or equal to 5.

输入参数

全部折叠

要验证的值，指定为标量或由以下任一类型的值组成的数组：

常量值，value 参量必须大于或等于该值，指定为以下标量之一：

提示

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

扩展功能

全部展开

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

版本历史记录

在 R2017a 中推出

另请参阅

| | | |

主题