参数验证简介

函数实参验证是对函数输入实参声明特定限制的一种方法。使用参数验证可以约束函数输入值的类、大小和其他方面，而无需在函数体中编写代码来执行这些测试。

函数参数验证是声明式的，这使MATLAB成为可能^®通过检查特定代码块提取函数信息的桌面工具。通过声明输入参数的需求，可以消除繁琐的参数检查代码，并提高代码的可读性、健壮性和可维护性。

函数参数验证语法简化了定义可选参数、重复参数和名称-值参数的过程。该语法还允许您以一致的方式定义默认值。

在哪里使用参数验证

在函数定义中，函数参数验证的使用是可选的。参数验证在可以被任何代码调用的函数中最有用，并且在执行函数代码之前必须确定输入的有效性。为供他人使用而设计的函数可以从参数输入的适当限制级别和根据函数的输入返回特定错误消息的机会中受益。

参数块语法

函数在由关键字分隔的代码块中定义参数验证参数而且结束．如果使用，参数块必须在函数的第一个可执行行之前开始。

你可以使用多个参数函数中的块，但所有块必须出现在不属于参数块。

下面代码中突出显示的区域显示了参数验证的语法。

函数参数声明可以包含以下任何一种限制:

也可以在函数验证声明中为输入参数定义默认值。默认值必须满足为该参数声明的限制。

A(indexes) = value

参数验证的例子

这参数Block指定三个输入的大小和类。

函数out = myFunction(A, B, C)参数一个(1,1)字符串B(: 1)增加一倍C(2, 2)细胞结束%功能代码.．.结束

在这个函数中，变量必须满足以下验证要求:

函数forwardSpeed (a, b, c)参数一个双b字符cSpeedEnum结束%功能代码第(a)类)第(b)类)第(c)类结束

classdefSpeedEnum < int32枚举满(100)半(50)停(0)结束结束

forwardSpeed (int8 (4),“字符串”，“全部”）

双char SpeedEnum

函数myInterp (x, v,方法)参数x(: 1) {mustBeNumeric, mustBeReal}v(: 1) {mustBeNumeric、mustBeReal mustBeEqualSize (v, x)}方法(: 1)字符{mustBeMember(方法,{“线性”、“立方”、“花键”})}＝“线性”结束%功能代码.．.．结束%自定义验证函数函数mustBeEqualSize (a, b)测试a和b的大小是否相等如果~ isequal(大小大小(a)、(b))错误(第一个输入的大小必须等于第二个输入的大小）结束结束

争论的种类

函数实参验证可以声明四种实参。函数可以定义任何这些类型的实参，但实参必须按照以下顺序定义:

必需的和可选的位置参数

位置参数必须以特定顺序传递给函数。参数列表中传递的值的位置必须与参数在中声明的顺序对应参数块。中的所有参数名参数Block必须唯一。

中的位置参数参数块是调用函数时必需的，除非实参定义了默认值。在参数声明中指定默认值使位置参数成为可选的，因为MATLAB可以在函数调用中没有传递值时使用默认值。

默认值可以是一个常量，也可以是产生满足参数声明的结果的表达式。方法中在表达式之前声明的实参参数块，但不包括在它之后声明的参数。

MATLAB只在函数调用中不包含实参时计算默认值表达式。

中的所有可选参数必须定位在所有必选参数之后参数块。例如，在这个参数块中，maxval而且minval具有默认值，因此是可选的。

函数myFunction (x, y, maxval minval)参数x(: 1)增加一倍y(: 1)增加一倍maxval(1,1)的两倍= max(max(x)，max(y)(1,1)的两倍= min (min (x) min (y))结束%功能代码.．.．结束

你可以使用以下语法调用这个函数:

myFunction(x,y,maxval,minval) (x,y,maxval)

当必须在函数调用中填充可选位置实参以标识后面的实参时，可选位置实参就成为必需的。也就是说，如果您想为minval时，必须指定一个值maxval．

函数C = f(~)参数～结束%功能代码结束

C = f

C = f(2)

函数C = f(~，x)参数~ X结束%功能代码.．.结束

C = f(2,3)

重复的参数

重复参数是可以作为输入参数重复指定的位置参数。类中声明重复实参参数块，其中包含重复属性。

参数(重复)arg1 arg2…结束

函数只能有一个重复参数块，它可以包含一个或多个重复的参数。

定义A的函数重复参数Block可以在所有参数出现0次或多次时调用。如果对函数的调用包含重复实参，则重复参数Block必须包含在每次重复中。

例如，如果a重复参数块定义参数x而且y，那么每次重复都必须包含两者x而且y．

重复参数不能指定默认值，因此不能为可选参数。但是，您可以在不包含任何重复参数的情况下调用该函数。

函数必须在位置参数之后和名值参数之前声明重复参数。类中不能指定名称-值参数重复块。有关名称-值参数的信息，请参见名称-值参数．

在函数中，每个重复参数变成一个单元格数组，其元素数量等于函数调用中传递的重复次数。验证应用于单元格数组的每个元素。如果函数调用时该参数没有出现，则单元格数组的大小为1 × 0。也就是说，它是空的。

例如，这个函数声明了一个由三个重复参数组成的块，x，y,选项．

函数[xCell,yCell,optionCell] = fRepeat(x,y,option)参数(重复)x双y双选项{mustBeMember(选项,[“线性”、“立方”])}结束%功能代码返回单元格数组xCell = x;yCell = y;optionCell = option;结束

可以在没有输入或三个输入的倍数的情况下调用函数。MATLAB为每个参数创建一个单元格数组，其中包含传递给该参数的所有值。这个调用fRepeat传递三个重复参数中的两组。

[xCell,yCell,optionCell] = fRepeat(1,2，“线性”、3、4、“立方”）

xCell = 1×2单元格阵列{[1]}{[3]}yCell = 1×2单元格阵列{[2]}{[4]}optionCell = 1×2单元格阵列{["linear"]} {["cubic"]}

下面的函数接受重复的参数x而且y的输入重复参数块。在函数体中，作为重复参数指定的值可在单元格数组中使用x而且y．的值交织在一起x而且y属性匹配所需的输入情节功能:情节(x1, y1,…)．

函数myPlotRepeating (x, y)参数(重复)x(: 1)增加一倍y(: 1)增加一倍结束%功能代码x和y交叉Z =重塑([x;y]，1，[]);调用绘图函数如果~ isempty (z)情节(z {:});结束结束

使用重复的输入参数对调用此函数。

X1 = 1:10;Y1 = sinx1;X2 = 0:5;Y2 = sinx2;myPlotRepeating (x1, y1, x2, y2)

函数F (a, b, varargin)参数一个uint32buint32结束参数(重复)变长度输入宗量结束%功能代码.．.结束

名称-值参数

名称-值参数将名称与传递给函数的值关联起来。名称-值参数:

类中声明名称-值参数参数块使用点表示法来定义结构的字段。例如，命名的结构NameValueArgs定义两个名称-值参数，Name1而且Name2．可以使用任何有效的MATLAB标识符作为结构名。

参数NameValueArgs。Name1NameValueArgs。Name2结束

结构名必须出现在函数签名中。

函数myFunction (NameValueArgs)

使用名称-值结构中的字段名称(作为字符串或字符向量传递)调用函数。

myFunction (“Name1”value1,“Name2”value2)

函数签名中使用的结构的名称是函数工作区中结构的名称，该结构包含传递给函数的名称和值。

函数结果= myFunction(NameValueArgs)参数NameValueArgs。Name1NameValueArgs。Name2结束%功能代码result = NameValueArgs。Name1* NameValueArgs.Name2;结束

r = myFunction(“Name1”3,“Name2”，7)

R = 21

函数myRectangle(宽度、高度、期权)参数宽度双高度双选项。线型(1,1)字符串＝“-”选项。线宽(1,1) {mustBeNumeric}= 1结束%功能代码.．.结束

myRectangle(4、5)myRectangle(4、5、“线型”，”:“，“线宽”2) myRectangle(4、5、“线宽”,2，“线型”，”:“) myRectangle(4、5、“线型”，”:“) myRectangle(4、5、“线宽”, 2)

函数linLog (x, y,规模)参数(重复)x(: 1)增加一倍y(: 1)增加一倍结束参数规模。PlotType(1,1)字符串结束Z =重塑([x;y]，1，[]);如果isfield(规模、“PlotType”）如果规模。PlotType = =“林”情节(z {:})elseif规模。PlotType = =“日志”重对数(z {:})结束结束结束

myLinLog(1:5,1:5,1:10,1:10:100:1000)“PlotType”，“日志”）

函数myRectangle(宽度、高度、lineOptions fillOptions)参数宽度双高度双lineOptions。线型(1,1)字符串＝“-”lineOptions。线宽(1,1) {mustBeNumeric}= 1 fillOptions。颜色字符串fillOptions。模式结束%功能码.．.结束

类属性中的名称-值参数

MATLAB中一个有用的函数语法使用类的公共属性作为名称-值参数的名称。为类定义的所有可设置属性指定名称-值参数(即所有带有public的属性)SetAccess)，使用此语法参数布洛克:

structName．?类名称

函数可以使用“structName．?类名称语法只有一次。因此，一个函数只能定义一个从类中获取字段名的名称-值结构，即使使用不同的类名和结构名。

如果类对可以通过使用属性验证分配给属性的值施加了限制，则该函数将验证应用于各个名称-值参数。有关属性验证的信息，请参见验证属性值．

例如，这个函数有两个必需的参数，x而且y类的任何公共属性名和值matlab.graphics.chart.primitive.Bar类。

函数propArgs myBar (x, y)参数x(::)翻倍y(::)翻倍propArgs ? matlab.graphics.chart.primitive.Bar结束propertyCell = namedargs2cell(propArgs);栏(x, y, propertyCell {:})结束

使用所需的输入和任何可设置的属性名称-值对调用函数。

X = [1,2,3;4,5,6];Y = x.^2;myBar (x, y) myBar (x, y,“FaceColor”，“红色”，“BarLayout”，“分组”）

structName．?类名称structName．PropertyName(dim2 dim1…)ClassName {fcn1, fcn2,…}

函数propArgs myBar (x, y)参数x(::)翻倍y(::)翻倍propArgs ? matlab.graphics.chart.primitive.BarpropArgs.FaceColor{mustBeMember (propArgs.FaceColor{‘红’,‘蓝色’})}＝“蓝色”结束propertyCell = namedargs2cell(propArgs);栏(x, y, propertyCell {:})结束

X = [1,2,3;4,5,6];Y = x.^2;myBar (x, y) myBar (x, y,‘FaceColor’,‘红’,‘BarLayout’,“分组”)

类方法中的参数验证

在公共方法中验证方法输入参数很有用，因为对方法的调用可能不是起源于类代码。可以在具体的类方法中使用函数参数验证，包括在抽象类中定义的具体方法。但是，抽象方法(不是由类实现的方法)不能定义参数块。有关类方法的信息，请参见方法而且抽象类和类成员．

如果一个classdef文件包含在单独文件中定义的方法的方法原型，包括参数块中定义方法的单独文件。有关在单独文件中定义方法的详细信息，请参见单独文件中的方法．

子类方法不继承函数参数验证。在覆盖超类方法的子类方法中，可以向子类方法添加与在超类方法中使用的相同的参数验证。

句柄类析构函数方法不能使用参数验证。一个名为删除类的句柄子类中参数Block不作为析构函数处理。(换句话说，当对象被销毁时，MATLAB不会调用它)。有关类析构函数方法的更多信息，请参见句柄类析构函数．

参数验证顺序

函数调用时，MATLAB将按输入参数在中声明的顺序验证它们参数块，从上到下。在验证下一个参数之前，对每个参数进行完全验证。因此，任何对先前声明的参数的引用都使用已验证的值。函数在第一次验证失败时抛出错误。

在调用函数时，验证值可能与作为输入传递的原始值不同。例如，这个函数将输入声明为类uint32值。第三个输入声明指定了一个默认值，等于前两个输入的乘积。

函数C = f(a, b, C)参数一个uint32buint32cuint32= a .* b结束%功能代码.．.结束

调用带有不同数值类输入的函数(例如，双)导致转换为uint32．

C = f(1.8,1.5)

因为可选的输入参数c没有在函数调用中指定，MATLAB计算默认值并将其赋给c转换后一个而且b来uint32值。在本例中，转换的结果是两个输入的值都为2。因此，的乘积一个次b是四个。

C = uint32 4

如果为第三个输入指定值，则函数将值赋给c并且不计算默认值表达式。

C = f(1.8,1.5,25)

C = uint32 25

避免类和大小转换

在验证过程中，MATLAB在调用任何验证函数之前先应用类验证，然后应用大小验证。如果函数调用中省略的可选输入使用默认值，则在应用验证过程之前将此值赋给实参。

当传递给函数的实参值与验证所需的类和大小不匹配时，MATLAB会在可能的转换下将该值转换为声明的类和大小。然而，转换可能不是理想的行为。

下面是MATLAB可以执行的一些转换示例。

满足数字类限制:

满足尺寸限制:

为了消除MATLAB从输入参数验证中执行的标准转换，请使用验证函数而不是类和大小限制。对验证函数的调用不会返回值，也不能更改输入参数的值。

例如，这个函数将第一个输入限制为类中任意大小的二维数组双．第二个输入必须是任意类的5 × 3数组。

函数f (a, b)参数一个(::)翻倍b(5,3)结束%功能代码.．.结束

由于标准的MATLAB类型转换和标量展开，您可以使用以下输入调用此函数，并且不会收到验证错误。

f (的特征向量, 144)

默认情况下，MATLAB将字符向量的元素转换为它们的等效数值，并应用标量展开从标量值创建一个5 × 3数组144．

使用专门的验证函数可以提供更具体的输入参数验证。例如，这个函数定义了两个专门的验证函数，用来代替第一个和第二个参数的类和大小规范。这些局部函数使您能够避免输入值转换。

函数fCustomValidators (a, b)参数一个{mustBeA(“双”),mustBeDims (a, 2)}b{mustBeSize (b [5 3])}结束%功能代码.．.结束%自定义验证器函数函数mustBeA(输入类名)%针对特定类别进行测试如果~ isa(输入类名)错误('输入必须是类double '）结束结束函数sizeDims mustBeSize(输入)测试特定的尺寸如果~ isequal(尺寸(输入),sizeDims)错误(['输入必须大小'num2str (sizeDims)])结束结束函数numDims mustBeDims(输入)测试维数如果~ isequal(长度(大小(输入)),numDims)错误([“输入必须有”num2str (numDims),“维度”。])结束结束

的mustBeSize而且mustBeDims验证函数强制严格声明输入参数。

fCustomValidators (的特征向量, 144)

位置1的输入参数无效。输入必须是double类

在此调用中，第一个输入的维数是错误的，因此验证函数返回一个自定义错误消息。

fCustomValidators ((2, 2, 4), 144)

位置1的输入参数无效。输入必须有2个维度

的mustBeSizeValidator函数将第二个输入限制为特定的维度，该维度在错误消息中提供。

fCustomValidators((2, 2), 144年)

位置2的输入参数无效。输入必须是大小[5 3]

输入参数个数参数验证

的输入参数个数函数返回在当前执行函数的调用中给出的函数输入参数的数量。使用函数参数验证时，返回的值输入参数个数在函数中，是调用函数时提供的位置参数的数量。

重复实参是位置实参，因此调用时传递给函数的重复实参数量包含在返回的值中输入参数个数．

价值是输入参数个数Returns不包括函数调用中不包括的可选参数。同时,输入参数个数不计算任何名称-值参数。

使用输入参数个数确定在调用函数时是否将可选位置参数传递给函数。例如，这个函数声明了三个位置参数和一个名称-值参数。下面是函数如何确定调用时传递的参数。

函数result = fNargin(a, b, c, namedargs)参数一个(1,1)的两倍b(1,1)的两倍c(1,1)的两倍= 1 namedargs。格式(: 1)字符结束%功能代码开关输入参数个数情况下2 result = a + b;情况下3 result = a^c + b^c;结束如果isfield (namedargs“格式”)格式(namedargs.Format);结束结束

在此函数调用中，的值输入参数个数是2：

result = fNargin(3,4)

结果= 7

在此函数调用中，的值输入参数个数是3.：

result = fNargin(3,4,7.62)

结果= 4.3021e+04

在此函数调用中，的值输入参数个数是3:

result = fNargin(3,4,7.62，“格式”，“银行”）

Result = 43020.56

变量和函数访问限制

参数块存在于函数的工作区中。类添加到函数作用域的任何包、类或函数进口命令添加到参数块。

唯一对验证器函数和默认值表达式可见的变量是已经声明的输入变量。在此函数中，默认值为c是从一个而且b．

函数C = f(a,b, C)参数一个uint32buint32cuint32= a * b结束%功能代码.．.结束

类型中尚未声明的输入变量不能被引用参数块。例如，使用此声明作为参数一个在前面的函数无效的原因b而且c还没有宣布。

参数A uint32 = b * c b uint32 c uint32结束

参数验证表达式只能引用先前声明并因此验证过的参数。名称-值参数的验证函数和默认值不能访问其他名称-值参数。