mustBeLessThanOrEqual

验证值小于等于另一个值

全页折叠

语法

mustBeLessThanOrEqual(value,c)

说明

示例

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

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

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

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

示例

全部折叠

验证第一个输入小于等于第二个输入

使用 mustBeLessThanOrEqual 验证第一个输入中的值小于等于第二个输入中的值。

mustBeLessThanOrEqual([3 4 5],2)

Error using mustBeLessThanOrEqual (line 18)
Values must be less than or equal to 2.

限制属性值

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

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

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

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

obj = MyClass;
obj.Prop1 = 3;

Error setting 'Prop1' property of 'MyClass' class:
Values must be less than or equal to 2.

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

限制函数参数值

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

function r = mbLessThanOrEqual(x)
    arguments
        x {mustBeLessThanOrEqual(x,5)}
    end
    r = x + 5;
end

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

x = [1.27, 4.54, 3.9, 5.1, .531];
r = mbLessThanOrEqual(x);

Error using mbLessThanOrEqual
 r = mbLessThanOrEqual(x);
                       ↑
Invalid input argument at position 1. Value must be less than or equal to 5.

输入参数

全部折叠

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

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

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

`c` - 常量值，`value` 参数必须小于或等于该值
标量

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

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

提示

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

扩展功能

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

版本历史记录

在 R2017a 中推出

另请参阅

mustBeLessThan | mustBeGreaterThanOrEqual | arguments