mustBeInteger

R2026b

验证值为整数

全页折叠

语法

mustBeInteger(value)

描述

如果 value 不包含整数值，mustBeInteger(value) 会抛出错误。此函数测试数字是否带有小数部分。此处不考虑值的数据类型。mustBeInteger 不返回值。

mustBeInteger 调用以下函数来确定 value 是否为整数： (自 R2026a 起)

支持的类：实现 mustBeInteger 调用的函数的所有数值类、logical 和 MATLAB^® 类。

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

示例

全部折叠

验证输入仅包含整数

验证计算结果是整数值。

A = randi(9)/randi(9);
mustBeInteger(A)

Value must be integer.

如果两个随机整数相除的结果带有小数部分，mustBeInteger 会引发错误。

将属性限制为整数值

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

classdef MyClass
   properties
      Prop1 {mustBeInteger}
   end
end

创建一个对象，并向其属性赋值。将两个随机整数相除，得到的可以是整数，也可以是带有小数部分的数。

obj = MyClass;
obj.Prop1 = randi(9)/randi(9);

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

当您向属性赋值时，MATLAB 会使用赋给属性的值调用 mustBeInteger。当这些特定随机整数的除法运算的结果值不是整数时，mustBeInteger 将引发错误。

限制函数参量值

此函数声明两个输入参量。输入 A 必须为数值行向量。输入 idx 必须为整数标量。

function r = mbInteger(A,idx)
    arguments
        A (1,:) {mustBeNumeric}
        idx (1,1) {mustBeInteger}
    end
    r = A(idx).^2;
end

使用 idx 的非整数值调用该函数会导致 mustBeInteger 抛出错误。将两个随机整数相除，得到的可以是整数，也可以是带有小数部分的数。

idx = randi(9)/randi(9);
A = rand(1,10);
r = mbInteger(A,idx);

Error using mbInteger (line 4)
 r = mbInteger(A,idx);
                 ^^^
Invalid argument at position 2. Value must be integer.

输入参数

全部折叠

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

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

logical、char 或数值类
实现 eq、isfinite 和 floor 的 MATLAB 类

其他数据类型会导致错误。

提示

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

扩展功能

全部展开

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

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

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

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

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

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

版本历史记录

在 R2017a 中推出

全部展开

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

mustBeInteger 函数不再调用 isreal、isnumeric 和 islogical 函数来验证输入。因此，mustBeInteger 接受它调用的基础函数（isfinite、floor 和 eq）支持的任何数据类型，例如字符向量。

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

classdef MyClass
   properties
      Interval {mustBeInteger}
   end
end

您现在可以将该属性指定为字符向量。

s = MyClass;
s.Interval = 'abc';

在以前的版本中，将 Interval 属性指定为字符向量会返回以下错误：

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

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

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

另请参阅

arguments | mustBeNumericOrLogical | mustBeReal | mustBeNumeric | mustBePositive