mustBeGreaterThan

验证值大于另一个值

全页折叠

语法

mustBeGreaterThan(value,c)

说明

示例

如果 value 中有任何元素小于或等于标量 c，mustBeGreaterThan(value,c) 将引发错误。此函数不返回值。

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

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

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

示例

全部折叠

验证第一个输入大于第二个输入

使用 mustBeGreaterThan 验证第一个输入中的值大于第二个输入中的值。

mustBeGreaterThan([2 3 4],2)

Error using mustBeGreaterThan (line 19)
Value must be greater than 2.

限制属性值

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

classdef MyClass
   properties
      Prop1 {mustBeGreaterThan(Prop1,2)}
   end
end

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

obj = MyClass;
Obj.Prop1 = 2;

Error setting property 'Prop1' of class 'MyClass':
Value must be greater than 2.

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

限制函数参数值

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

function r = mbGreaterThan(x)
    arguments
        x {mustBeGreaterThan(x,5)}
    end
    r = x - 5;
end

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

x = [12.7, 45.4, 5.0, 77.1, 53.1];
r = mbGreaterThan(x);

Error using mbGreaterThan
 r = mbGreaterThan(x);
                   ↑
Invalid input argument at position 1. Value must be greater than 5.

输入参数

全部折叠

`value` - 要验证的值
标量 | 数组

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

logical、char、string 或数值类
实现 gt、isreal 以及 isnumeric 或 islogical 的 MATLAB 类

`c` - 常量值，`value` 参数必须大于该值
标量

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

logical、char、string 和数值类
实现 gt、isreal 以及 isnumeric 或 islogical 的 MATLAB 类

提示

mustBeGreaterThan 用于属性和函数参数验证。

扩展功能

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

版本历史记录

在 R2017a 中推出

另请参阅

mustBeGreaterThanOrEqual | mustBeLessThan | arguments