MATLAB assert Function

MATLABassert函数的作用是：Throw error if condition false。在定义MATLAB函数时，我们可以使用这个函数自定义一些错误。

assert函数完整的语法是：

1
assert(cond,errID,msg,A1,...,An)

其中：

• cond是逻辑判断语句，当cond的结果是false（即逻辑零）时，该函数将抛出错误信息；

• errID是assertion failure的identifier，它的命名需要满足一定的规则：

  

  这个Identifier是存在于MExpection对象中的，在后文中会详细地讨论这一点。

• msg是报错信息，A1,...,An用于替换变量msg中的conversion specifiers；

例如，我们规定：当变量a的数值小于b时程序抛出指定错误：

1
2
3
4
a = 1;
b = 2;

assert(a>=b, 'MYError:aleb', "a=%d, b=%d. a is less than b", a, b)

此时程序会将错误信息打印在命令行窗口中：

assert函数的使用是比较简单的，但是我们仍然需要说明两点。

首先，assert函数抛出的是一个error，当抛出了这个error后，程序就中断了，后面的程序语句就不会再执行。

其次，在上面的信息中，尽管我们在assert中定义了该error的identifier为'MYError:aleb'，但是在脚本文件中看不出它的意义，因为在正常情况下该报错并不会返回一个MException对象。想要了解它所代表的含义，我们需要在函数文件中使用assert函数，并在脚本文件中使用try, catch块调用函数文件。

注：这里表述不是特别得严谨。实际上，虽然此时的工作空间中并没有MException对象，但是我们可以使用MException.last语句得到关于这个报错的报错信息：

matlab

1
2
3
4
5
6
7
8
9
>> MException.last
ans = 
  MException with properties:

    identifier: 'MYError:aleb'
       message: 'a=1, b=2. a is less than b'
         cause: {}
         stack: [1×1 struct]
    Correction: []

但需要注意的是，这条语句只能在程序运行报错后，在命令行窗口中使用，不能直接跟在脚本文件中assert函数的后面，因为如前文所述，当程序抛出error后程序就中断了。

例如定义一个函数helperFcn，当函数的输入a大于b的值时报一种错误；当函数的输入a大于c值时报另一种错误；若函数不报错，则将a的值输出：

1
2
3
4
5
function out = helperFcn(a,b,c)
assert(a<=b, "MYError:agtb", "a=%d, b=%d, c=%d. a is greater than b", a, b, c)
assert(a<=c, "MYError:agtb", "a=%d, b=%d, c=%d. a is greater than c", a, b, c)
out = a;
end

之后使用try, catch来模拟三种情形：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
try
    out1 = helperFcn(2,1,4);
catch ME1
end

try
    out2 = helperFcn(2,4,1);
catch ME2
end

try
    out3 = helperFcn(2,3,4);
catch ME3
end

运行脚本文件后，工作空间中得三个变量：

1
2
3
4
5
>> whos
  Name      Size            Bytes  Class         Attributes
  ME1       1x1              3616  MException              
  ME2       1x1              3616  MException              
  out3      1x1                 8  double                  

说明前两个try, catch块捕捉到了错误，第三个try, catch块并没有捕捉到错误，而是成功执行了try块中的语句。

对比ME1和ME2：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
ME1 = 
  MException with properties:
    identifier: 'MYError:agtb'
       message: 'a=2, b=1, c=4. a is greater than b'
         cause: {}
         stack: [2×1 struct]
    Correction: []

ME2 = 
  MException with properties:
    identifier: 'MYError:agtb'
       message: 'a=2, b=4, c=1. a is greater than c'
         cause: {}
         stack: [2×1 struct]
    Correction: []

就可以看到我们在函数helperFcn中使用assert函数定义error时设定identifier的意义。

注：关于try, catch代码块以及MException对象identifier属性的使用，可以参考博客：MATLAB try,catch Block。