mustBeNonnegative

验证值为非负值

全页折叠

语法

mustBeNonnegative(value)

说明

如果 value 是负值，mustBeNonnegative(value) 将抛出错误。小于零的值即为负值。此函数不返回值。

mustBeNonnegative 调用 ge 函数来确定输入是否不为负值。 (自 R2026a 起)

支持的类：实现 ge 的所有数值类、logical 和 MATLAB^® 类。

示例

全部折叠

验证值不为负

使用 mustBeNonnegative 验证输入只包含非负值。

randn 函数用于创建正态分布的随机数。

A = randn(1,5);

验证随机数为非负值。

mustBeNonnegative(A)

Value must be nonnegative.

将属性限制为非负值

该类将 Prop1 的值限制为非负值。

classdef MyClass
   properties
      Prop1 {mustBeNonnegative}
   end
end

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

obj = MyClass;
obj.Prop1 = -10;

Error setting property 'Prop1' of class 'MyClass'. Value must be nonnegative.

当您向属性赋值时，MATLAB 会使用赋给属性的值调用 mustBeNonnegative。mustBeNonnegative 将引发错误，因为值 -10 为负。

限制函数参量值

此函数声明两个输入参量。输入 lower 不能为正数，输入 upper 必须为正数。

function r = mbNonnegative(lower,upper)
    arguments
        lower {mustBeNonpositive}
        upper {mustBeNonnegative}
    end
    x = lower*pi:upper*pi;
    r = sin(x);
end

使用不满足 mustBeNonnegative 要求的 upper 值调用该函数会引发错误。

r = mbNonnegative(-12,-4);

Error using mbNonnegative (line 4)
 r = mbNonnegative(-12,-4);
                       ^^
Invalid argument at position 2. Value must be nonnegative.

输入参数

全部折叠

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

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

logical 或数值类
实现 ge 的 MATLAB 类

示例: value = 1 不会生成错误。

提示

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

扩展功能

全部展开

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

GPU 代码生成
使用 GPU Coder™ 为 NVIDIA® GPU 生成 CUDA® 代码。

GPU 数组
通过使用 Parallel Computing Toolbox™ 在图形处理单元 (GPU) 上运行来加快代码执行。

mustBeNonnegative 函数完全支持 GPU 数组。要在 GPU 上运行该函数，请将输入数据指定为 gpuArray (Parallel Computing Toolbox)。有关详细信息，请参阅在 GPU 上运行 MATLAB 函数 (Parallel Computing Toolbox)。

分布式数组
使用 Parallel Computing Toolbox™ 在集群的组合内存中对大型数组进行分区。

mustBeNonnegative 函数完全支持分布式数组。有关详细信息，请参阅使用分布式数组运行 MATLAB 函数 (Parallel Computing Toolbox)。

版本历史记录

在 R2017a 中推出

全部展开

R2026a: `mustBeNonnegative` 不再限制输入数据必须为实数值或逻辑值

mustBeNonnegative 函数不再调用 isreal、isnumeric 和 islogical 函数来验证输入。因此，mustBeNonnegative 接受基础比较运算符 ge（或 >=）支持的任何数据类型，例如字符向量、字符串以及日期和时间类型。

例如，MyClass 中的 Interval 属性定义使用 mustBeNonnegative 验证函数来限制属性值。

classdef MyClass
   properties
      Interval {mustBeNonnegative}
   end
end

您现在可以将该属性指定为类型为 duration 的值。

A = datetime("yesterday");
B = datetime("today");
s = MyClass;
s.Interval = B - A;

在以前的版本中，将 Interval 属性指定为 duration 值会返回以下错误：

Error setting property 'Interval' of class 'MyClass'. Value must be numeric or logical.

要保留以前版本的行为，请在您的验证检查中显式使用 mustBeReal 和 mustBeNumericOrLogical。例如，以下代码保留 mustBeNonnegative 属性定义中 Interval 的先前行为。

classdef MyClass
   properties
      Interval {mustBeReal,mustBeNumericOrLogical, ...
                mustBeNonnegative}
   end
end

另请参阅

arguments | mustBeNumericOrLogical | mustBeReal | mustBePositive | mustBeNonzero