Main Content

本页翻译不是最新的。点击此处可查看最新英文版本。

verifyNumElements

类: matlab.unittest.qualifications.Verifiable
包: matlab.unittest.qualifications

确认值具有指定的元素计数

说明

示例

verifyNumElements(testCase,actual,expectedNumElements) 验证 actual 是包含预期元素数的 MATLAB® 数组。

示例

verifyNumElements(testCase,actual,expectedNumElements,diagnostic) 还将 diagnostic 中的诊断信息与验证相关联。

输入参数

全部展开

测试用例对象,指定为 matlab.unittest.qualifications.Verifiable 类的实例。由于 matlab.unittest.TestCase 类会子类化 matlab.unittest.qualifications.Verifiable 并继承其方法,因此 testCase 通常是 matlab.unittest.TestCase 实例。

要测试的值,指定为任何数据类型的数组。

数组中预期的元素数,指定为非负整数标量。

当验证通过或失败时显示的诊断信息,指定为字符串数组、字符数组、函数句柄或 matlab.unittest.diagnostics.Diagnostic 对象数组。

根据测试运行程序的配置,测试框架可能会在验证通过或失败时显示诊断信息。默认情况下,框架仅在验证失败时显示诊断信息。您可以通过自定义测试运行程序来覆盖默认行为。例如,使用 DiagnosticsOutputPlugin 实例来显示失败和通过事件诊断信息。

示例: "My Custom Diagnostic"

示例: @dir

属性

Sealedtrue

要了解方法的属性,请参阅方法属性

示例

全部展开

测试 actual 值是否具有指定数量的元素。

创建一个供交互测试的测试用例。

testCase = matlab.unittest.TestCase.forInteractiveUse;

验证标量的元素数是否为一个。

verifyNumElements(testCase,3,1)
Verification passed.

测试矩阵 [1 2 3; 4 5 6] 的元素计数。测试失败是因为矩阵有六个元素。

verifyNumElements(testCase,[1 2 3; 4 5 6],5)
Verification failed.
    ---------------------
    Framework Diagnostic:
    ---------------------
    verifyNumElements failed.
    --> The value did not have the correct number of elements.
        
        Actual Number of Elements:
             6
        Expected Number of Elements:
             5
    
    Actual Value:
         1     2     3
         4     5     6
    ------------------
    Stack Information:
    ------------------
    In C:\work\TestForNumberOfElementsExample.m (TestForNumberOfElementsExample) at 18

验证单位矩阵是否具有预期的元素数。

n = 7;
verifyNumElements(testCase,eye(n),n^2)
Verification passed.

测试字符向量元胞数组的元素数目。

actual = {'Mercury','Gemini','Apollo'};
verifyNumElements(testCase,actual,3)
Verification passed.

测试一个具有两个字段的标量结构体的元素计数。测试失败,因为该结构体只有一个元素。

s.field1 = 1;
s.field2 = zeros(1,10);
verifyNumElements(testCase,s,2,"Value must have two elements.")
Verification failed.
    ----------------
    Test Diagnostic:
    ----------------
    Value must have two elements.
    ---------------------
    Framework Diagnostic:
    ---------------------
    verifyNumElements failed.
    --> The value did not have the correct number of elements.
        
        Actual Number of Elements:
             1
        Expected Number of Elements:
             2
    
    Actual Value:
      struct with fields:
    
        field1: 1
        field2: [0 0 0 0 0 0 0 0 0 0]
    ------------------
    Stack Information:
    ------------------
    In C:\work\TestForNumberOfElementsExample.m (TestForNumberOfElementsExample) at 35

提示

  • verifyNumElements 方法非常方便。例如,verifyNumElements(testCase,actual,expectedNumElements) 在功能上等效于以下代码。

    import matlab.unittest.constraints.HasElementCount
    testCase.verifyThat(actual,HasElementCount(expectedNumElements))
  • 使用此确认在不引发异常的条件下生成和记录失败。由于确认不会引发异常,因此即使出现确认失败的情形,依然会完成所有的测试内容。通常,确认指的是对单元测试的主要验证,因为这些确认一般不要求提前从测试中退出。使用其他验证类型来测试是否违反先决条件或测试安装是否正确:

    • 使用断言验证确保测试环境满足无论如何都不会导致测试失败的先决条件。假设失败会生成已筛选的测试,且测试框架会将测试设为 Incomplete。有关详细信息,请参阅 matlab.unittest.qualifications.Assumable

    • 当失败条件导致当前测试内容的剩余部分都失效,但不会阻止后续测试正确执行时,使用断言验证。断言点处的失败会将当前测试展现为 FailedIncomplete。有关详细信息,请参阅 matlab.unittest.qualifications.Assertable

    • 使用致命断言验证在失败时中止测试会话。当失败涉及根本以致继续测试已经没有意义时,这些验证非常有用。当脚手架拆解不能正确还原环境状态,适合中止测试并启动一个新会话时,致命断言也很有用。有关详细信息,请参阅 matlab.unittest.qualifications.FatalAssertable

版本历史记录

在 R2013a 中推出