参数验证简介

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

函数参数验证是声明性的，它支持MATLAB^®桌面工具，通过检查特定的代码块来提取有关函数的信息。通过声明输入参数的要求，您可以消除繁琐的参数检查代码，并提高代码的可读性、健壮性和可维护性。

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

在哪里使用参数验证

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

参数块语法

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

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

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

函数参数声明可以包括以下任何类型的限制:

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

(指数)=值

参数验证的例子

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

函数out = myFunction(A, B, C)参数A(1,1)字符串B(1，:)双C(2,2)单元格结尾%函数代码．．.结尾

在这个函数中，变量声明如下:

函数forwardSpeed (a, b, c)参数a double b char c SpeedEnum结尾%函数代码disp(类(a)) disp(类(b)) disp(类(c))结尾

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

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

双字符SpeedEnum

函数myInterp (x, v,方法)参数x (1，:) {mustBeNumeric,mustBeReal} v (1，:) {mustBeNumeric,mustBeReal,mustBeEqualSize(v,x)}方法(1，:)“线性”结尾%函数代码．．.．结尾%自定义验证函数函数mustBeEqualSize (a, b)％测试如果a和b具有相同的大小如果~ isequal(大小大小(a)、(b))错误(“第一次输入的大小必须等于第二次输入的大小”）结尾结尾

类型的参数

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

必需和可选的位置参数

位置参数必须以特定的顺序传递给函数。参数中传递的值的位置必须与参数在参数块。的所有参数名参数块必须是唯一的。

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

默认值可以是一个常量，也可以是生成满足参数声明的结果的表达式。表达式可以引用在它之前声明的参数参数块，但不包括在其后面声明的参数。

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

的所有可选参数必须位于所有必需参数之后参数块。例如，在这个参数块中，maxlen和minlen具有默认值，因此是可选的。

函数myFunction (x, y, maxval minval)参数X (1，:) double y (1，:) double maxval (1,1) double = max(max(X)，max(y)) minval (1,1) double = min(min(X)，min(y))结尾%函数代码．．.．结尾

你可以用这些参数来调用这个函数:

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

当必须在函数调用中填充其位置以标识其后面的参数时，就需要可选的位置参数。也就是说，如果您想指定的值minlen，则必须指定值maxlen．

函数c = f（〜）参数～结尾%函数代码结尾

c = f

c = f (2)

函数c = f (x ~)参数〜X.结尾%函数代码．．.结尾

c = f(2、3)

重复的参数

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

参数（重复）arg1 arg2 ...结尾

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

定义一个重复参数可以调用块中的零或多个块中所有参数的块。如果对函数的调用包括重复参数，则必须包括每个重复的块中的所有参数。

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

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

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

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

函数(伊势亚、yCell optionCell] = fRepeat (x, y,选项)参数(重复)x double y double option {mustBeMember(option，["linear"，"cubic"])}结尾%函数代码％返回单元阵列伊势亚= x;yCell = y;optionCell =选项;结尾

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

(伊势亚yCell optionCell] = fRepeat(1、2、“线性”、3、4、“立方”）

xCell = 1×2 cell array {[1]} {[3]} yCell = 1×2 cell array {[2]} {[4]} optionCell = 1×2 cell array {["linear"]} {["cubic"]}

以下函数接受重复参数x和y输入一个重复参数块。在函数体中，作为重复参数指定的值在单元格数组中可用x和y．这个例子交错的值x和y将所需的输入匹配到阴谋功能：绘图（x1，y1，...）．

函数myplotrepeating（x，y）参数(重复)x(1，:)乘以y (1，:)结尾%函数代码%交叉x和yz =重塑((x, y), 1, []);%呼叫绘图功能如果~ isempty (z)情节(z {:});结尾结尾

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

x1 = 1:10;日元=罪(x1);x2 = 0:5;y2 =罪(x2);myPlotRepeating (x1, y1, x2, y2)

函数f (a, b,变长度输入宗量)参数A uint32 b uint32结尾参数(重复)变长度输入宗量结尾%函数代码．．.结尾

名称-值参数

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

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

参数NameValueArgs。Name1NameValueArgs。Name2结尾

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

函数myfunction（namevalueargs）

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

myFunction ('姓名1'，value1，“Name2”，value2）

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

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

r = myFunction ('姓名1'3,“Name2”7)

r = 21

函数MyRectangle（宽度，高度，选项）参数双宽双高选项。LineStyle (1,1) string =“ - ”选项。LineWidth (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”）如果scale.plottype ==.“林”情节(z {:})elseifscale.plottype ==.“日志”重对数(z {:})结尾结尾结尾

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

函数myRectangle(宽度、高度、lineOptions fillOptions)参数width double height double lineOptions。LineStyle (1,1) string =“ - ”lineOptions。线宽(1,1){mustBeNumeric} = 1 fillOptions.Color string fillOptions.Pattern结尾%函数代码．．.结尾

来自类属性的名称-值参数

MATLAB中一个有用的函数语法使用类的公共属性作为名称-值参数的名称。为类定义的所有可设置属性(即所有具有public属性的属性)指定名称-值参数SetAccess），使用以下语法参数块。

structName．?类名称

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

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

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

函数propArgs myBar (x, y)参数x (:，:) double y (:，:) double proppargs .结尾propertyCell = namedargs2cell (propArgs);栏(x, y, propertyCell {:})结尾

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

x =[1、2、3、4、5、6];y = x ^ 2;myBar (x, y) myBar (x, y,'facecholor'，“红色”，“BarLayout”，'被分组'）

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

函数propArgs myBar (x, y)参数x (:，:) double y (:，:) double proppargs .propArgs.FaceColor {mustBeMember(propArgs.FaceColor,{'red','blue'})} =“蓝色”结尾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按输入参数在参数块，从上到下。在验证下一个参数之前，每个参数都完全验证。因此，对先前声明的参数的任何引用使用已验证的值。函数由于第一个验证故障而抛出错误。

当调用函数时，经过验证的值可能与作为输入传递的原始值不同。例如，该函数将输入声明为classuint32值。第三个输入声明赋值默认值等于前两个输入的乘积。

函数c = f（a，b，c）参数A uint32 b uint32 c uint32 = A .* b .* 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在输入参数验证中执行的标准转换，可以使用验证函数来代替类和大小限制。对验证函数的调用不会返回值，也不能更改输入参数的值。

例如，该函数将第一个输入限制为类double类型的任意大小的二维数组。第二个输入必须是任何类的5乘3数组。

函数f (a, b)参数A (:，:) b (5,3)结尾%函数代码．．.结尾

由于标准MATLAB类型转换和标量扩展，您可以使用以下输入调用此函数而不接收验证错误。默认情况下，MATLAB将字符向量的元素转换为它们的等效数值，并应用标量扩展以从标量值创建5×3数组144．

f ('字符矢量', 144)

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

函数fCustomValidators (a, b)参数a {mustBeA(a，'double')， mustBeDims(a,2)} b {mustBeSize(b，[5,3])}结尾%函数代码．．.结尾自定义验证器函数函数mustBeA(输入类名)%测试特定类如果〜ISA（输入，类名）错误（Input必须是类double。）结尾结尾函数sizeDims mustBeSize(输入)%测试具体尺寸如果~ isequal(尺寸(输入),sizeDims)错误(['输入必须是大小'num2str (sizeDims)])结尾结尾函数numDims mustBeDims(输入)%尺寸数测试如果〜Isequal（长度（大小（输入）），numdims）错误（['Input must have 'num2str (numDims),“维度”。]）结尾结尾

的蜜铜和mustBeDims验证函数强制输入参数的严格声明。

fCustomValidators ('字符矢量', 144)

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

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

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

位置1的输入参数无效。输入必须是二维的

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

FcustomValidators（（2,2），144）

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

输入参数个数在参数验证

的输入参数个数函数返回调用当前执行的函数时给出的函数输入参数的个数。使用函数参数验证时，返回的值输入参数个数函数内部是调用函数时提供的位置参数的数量。该值不包括函数调用中不包含的可选参数。同时,输入参数个数不计算任何名称-值参数。

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

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

函数result = fNargin(a, b, c, namedargs)参数A (1,1) = b (1,1) = c (1,1) = 1格式(:1)字符结尾%函数代码开关输入参数个数情况下2结果= A + B;情况下a^c + b^c;结尾如果isfield (namedargs“格式”）格式（namedargs.format）;结尾结尾

在这个函数调用中:

结果= Fnargin（3,4）

结果= 7

返回的值输入参数个数在函数中2．

在这个函数调用中:

结果= fnargin（3,4,7.62）

结果= 4.3021 e + 04

返回的值输入参数个数在函数中3.．

在这个函数调用中:

结果= fnargin（3,4,7.62，“格式”，“银行”）

结果= 43020.56.

返回的值输入参数个数函数值是3。

变量和函数访问限制

函数工作区中存在参数块。如果函数使用进口命令将包、类或函数添加到函数的作用域，则相同的作用域应用于参数块。

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

函数c = f (a, b, c)参数A uint32 b uint32 c uint32 = A * b结尾%函数代码．．.结尾

但是，您无法引用尚未声明的输入变量参数块。例如，使用这个声明作为参数一个在前面的函数中无效，因为b和c还没有被宣布。

参数A uint32 = b * c结尾

参数验证表达式只能引用以前声明，因此验证了参数。

名称值参数的验证函数和默认值无法访问其他名称值参数。