mustBeNumeric

验证值为数值

全页折叠

语法

mustBeNumeric(value)

说明

示例

如果 value 包含非数值，则 mustBeNumeric(value) 会引发错误。此函数不返回值。

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

isnumeric

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

示例

全部折叠

验证输入为数值

验证运算结果为数值。

mustBeNumeric(5 < 10)

Values must be numeric.

小于关系运算符返回的是一个逻辑值。

限制属性值

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

classdef MyClass
   properties
      Prop1 {mustBeNumeric}
   end
end

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

obj = MyClass;
obj.Prop1 = isprime(29);

Error setting 'Prop1' property of 'MyClass' class:
Values must be numeric.

当您向属性赋值时，MATLAB^® 会使用赋给属性的值调用 mustBeNumeric。mustBeNumeric 将引发错误，因为赋给 Prop1 的值为逻辑值。

限制函数值

此函数将输入参量限制为数值向量。

function r = mbNumeric(x)
    arguments
        x (1,:) {mustBeNumeric}
    end
    p = [3 2 1];
    r = polyval(p,x);
end

使用字符向量调用该函数会导致 mustBeNumeric 引发错误。

x = '4 3 2';
r = mbNumeric(x);

Error using mbNumeric
 r = mbNumeric(x);
               ↑
Invalid input argument at position 1. Value must be numeric.

输入参数

全部折叠

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

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

任意 MATLAB 数值类
从 MATLAB 数值类型派生的或重载 isnumeric 的 MATLAB 类

提示

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

扩展功能

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 中推出

另请参阅

mustBeNumericOrLogical | arguments