mustBeMember

验证值是指定集的成员

全页折叠

语法

mustBeMember(value,S)

说明

如果 value 不是 S 指定的值集合的成员，mustBeMember(value,S) 将抛出错误。value 指定的值集合必须是区分大小写的精确匹配。mustBeMember 不返回值。

将 mustBeMember 用作属性或函数参量验证函数时，请确保属性的默认值是集合的成员。

mustBeMember 调用以下函数来确定 value 是否为 S 指定的值集合的成员。

ismember

支持的类：重载 ismember 的所有数值类、logical、char 和 MATLAB^® 类。

示例

全部折叠

验证第一个输入是集合的成员

使用 mustBeMember 验证第一个输入是第二个输入指定的值集合的成员。

验证字符向量 'red' 是字符向量 'yellow'、'green' 和 'blue' 集合的成员。

A = 'red';
B = {'yellow','green','blue'};
mustBeMember(A,B)

Value must be a member of this set:
    'yellow'
    'green'
    'blue'

验证失败，因为 'red' 不是集合的成员。MATLAB 返回列出允许值的错误消息。

限制属性值

此类将属性的值限制为一组特定的值。

Prop1 的值必须为 'yellow'、'green' 或 'blue'。

classdef MyClass
   properties
      Prop1 {mustBeMember(Prop1,{'yellow','green','blue'})} = 'yellow'
   end
end

默认属性值必须符合验证函数所施加的限制。因此，必须为其显式指定一个属于集合成员的默认值。

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

obj = MyClass
obj.Prop1 = 'red';

Error setting property 'Prop1' of class 'MyClass'. Value must be a member of this set:
    'yellow'
    'green'
    'blue'

验证失败，因为 'red' 不是集合的成员。MATLAB 返回列出允许值的错误消息。

限制函数参量值

此函数声明两个输入参量。输入 n 必须为标量数值，输入 typename 必须为字符向量 single 或 double。

function r = mbMember(n,typename)
    arguments
        n (1,1) {mustBeNumeric}
        typename {mustBeMember(typename,{'single','double'})} = 'single'
    end
    r = rand(n,typename);
end

此函数调用使用的 typename 值不满足 mustBeMember 定义的要求，并会引发错误。

r = mbMember(5,'int32');

Error using mbMember (line 4)
 r = mbMember(5,'int32');
                ^^^^^^^
Invalid argument at position 2. Value must be a member of this set:
    'single'
    'double'

输入参数

全部折叠

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

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

logical、string、char 或任何数值类
逻辑值数组，字符串数组、cellstr 或数值数组
实现 ismember 的 MATLAB 类

将 mustBeMember 用作属性验证器时，此参量必须是属性名称，且不带引号。

示例: PropName {mustBeMember(PropName,{'High','Medium','Low'})} = 'Low'

`S` — `value` 必须属于的值集合
标量 | 数组

value 必须属于的值集合，指定为以下任一值：

logical、string、char 或任何数值类
逻辑值数组，字符串数组、cellstr 或数值数组
实现 ismember 的 MATLAB 类

示例: 值为 char 向量元胞数组的属性：PropName {mustBeMember(PropName,{'yellow','green','blue'})} = 'blue'

示例: 值为字符串数组的属性：PropName {mustBeMember(PropName,["yellow","green","blue"])} = "blue"

提示

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

扩展功能

全部展开

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

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

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

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

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

版本历史记录

在 R2017a 中推出

另请参阅

arguments | ismember | mustBeNonempty | mustBeInRange