mustBeNegative

验证值为负值

语法

mustBeNegative(value)

说明

如果 value 不为负值，mustBeNegative(value) 将引发错误。小于零的值即为负值。此函数不返回值。

mustBeNegative 调用以下函数来确定输入是否为负值：

• lt

• isreal

• isnumeric

• islogical

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

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

示例

验证值为负

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

rand 函数在区间 (0,1) 内创建均匀分布的随机数。在减法运算后测试数组以验证所有值均为负。否则，mustBeNegative 将引发错误。

A = rand(1,5) - 0.75;
mustBeNegative(A)

Value must be negative.

将属性限制为负值

此类将 Prop1 的值限制为负值。

classdef MyClass
   properties
      Prop1 {mustBeNegative}
   end
end

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

obj = MyClass;
obj.Prop1 = rand(1,5) - 0.75;

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

当您向属性赋值时，MATLAB 会使用赋给属性的值调用 mustBeNegative。mustBeNegative 将引发错误，因为数组中任何元素的值均不为负。

将函数参量限制为负值

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

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

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

mbNegative(0,4)

Error using mbNegative
 mbNegative(0,4)
            ↑
Invalid input argument at position 1. Value must be negative.

输入参数

value — 要验证的值

标量 | 数组

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

• logical 或数值类

• 实现 lt、isreal 以及 isnumeric 或 islogical 的 MATLAB 类

提示

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

扩展功能

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

GPU 数组

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

此函数完全支持 GPU 数组。有关详细信息，请参阅Run MATLAB Functions on a GPU (Parallel Computing Toolbox)。

分布式数组

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

此函数完全支持分布式数组。有关详细信息，请参阅Run MATLAB Functions with Distributed Arrays (Parallel Computing Toolbox)。

版本历史记录

在 R2017a 中推出

另请参阅

mustBeNonnegative | mustBePositive | arguments

主题

• 函数参量验证
• 属性验证函数