论证验证简介

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

函数参数验证是声明性的，这使得matlab启用^®桌面工具通过检查特定代码块来提取有关功能的信息。通过声明输入参数的要求，您可以消除繁琐的参数检查代码并提高代码的可读性，稳健性和可维护性。

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

在哪里使用参数验证

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

参数块语法

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

你可以使用多个参数函数中的块，但所有块必须在任何不属于一个代码之前发生的参数块。

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

函数参数声明可以包括这些限制中的任何一个：

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

(指数)=值

论证验证的例子

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

功能OUT = myFunction（a，b，c）参数一种（1,1）字符串B.（1，:)双C（2,2）细胞结尾%函数代码．..结尾

在此功能中，变量必须满足这些验证要求：

功能forwardspeed（a，b，c）参数一种双倍的B.charCSpeedenum.结尾%函数代码DISP（类（a））disp（类（b））disp（类（c））结尾

classdefspeedenum 枚举全（100）半（50）停止（0）结尾结尾

转发（Int8（4），“一个字符串”那'满的'）

双Char Speedenum.

功能myInterp（x，v，方法）参数X（1，:) {mustbenumeric，mustbereal}V.（1，:) {MustBenumeric，Mustbereal，MustBeequalsize（v，x）}方法（1，:) char {mustbemmber（方法，{'linear'，'cubic'，'spline'}）}=“线性”结尾%函数代码．..．结尾％自定义验证功能功能Mustbeequalsize（a，b）％测试相同的大小如果~ isequal(大小大小(a)、(b))开斋节='尺寸：不等';msg =.'第一个输入的大小必须等于第二输入的大小。;BrontcAller（MEXception（EID，MSG））结尾结尾

各种论点

函数参数验证可以声明四种参数。函数可以定义这些参数中的任何一个，但必须按以下顺序定义参数：

必需和可选的位置论点

位置参数必须按照特定的顺序传递给函数。参数列表中传递的值的位置必须与参数在参数块。所有参数名称都在参数块必须是唯一的。

位置论点参数如果参数定义默认值，否则请在调用函数时需要块。在参数声明中指定默认值使得一个位置参数是可选的，因为MATLAB可以在函数调用中传递任何值时使用默认值。

默认值可以是生成满足参数声明的结果的常量或表达式。表达式可以指在它之前声明的参数参数块，但不是在它之后声明的参数。

只有当函数调用中没有包含参数时，MATLAB才计算默认值表达式。

类中的所有必需参数之后，所有可选参数都必须被放置参数块。例如，在此参数块中，maxval.和迷你瓦尔有默认值，因此是可选的。

功能myFunction (x, y, maxval minval)参数X（1，:)双y（1，:)双maxval.(1,1)的两倍= max（max（x），max（y））minval(1,1)的两倍= min（min（x），min（y））结尾%函数代码．..．结尾

您可以使用任何这些语法调用此函数：

myFunction（x，y，maxval，minval）myfunction（x，y，maxval）myfunction（x，y）

当必须在函数调用中填写其位置时，需要一个可选的位置参数，以识别在其之后的参数。也就是说，如果要指定值迷你瓦尔，您必须指定一个值maxval.．

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

C = F.

c = f（2）

功能c = f（〜，x）参数〜X.结尾%函数代码．..结尾

c = f（2,3）

重复参数

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

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

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

定义一个函数重复参数可以调用块中的零或多个块中所有参数的块。如果对函数的调用包括重复参数，那么它的所有参数都包含在内重复参数必须包括每个重复的块。

例如，如果是重复参数块定义参数X和y，那么每个重复必须包含这两个X和y．

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

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

在该函数中，每个重复参数都成为一个单元数组，元素数等于函数调用中传递的重复数量。验证应用于单元格阵列的每个元素。如果使用此参数的零突出函数，则单元格数组的大小为1-0。也就是说，它是空的。

例如，此函数声明了一块三个重复参数，X那y， 和选项．

功能[Xcell，Ycell，OptionCell] = Frepeat（X，Y，选项）参数(重复)x双倍的y双倍的选项{MustBemember（选项，[“线性”，“立方”））}}结尾%函数代码％返回单元阵列xcell = x;Ycell = Y;optionCell =选项;结尾

您可以使用无输入或三个输入的函数调用该函数。MATLAB为每个参数创建一个单元格数组，其中包含所有值为该参数的所有值。这个电话免费传递三个重复参数中的两组。

[Xcell，Ycell，OptionCell] = Frepeat（1,2，“线性”、3、4、“立方”）

Xcell = 1×2单元阵列{[1]} {[3]} Ycell = 1×2单元阵列{[2]} {[4]} optionCell = 1×2单元阵列{[“线性”]} {[“立方体”]}

以下函数接受重复参数X和y输入中的输入重复参数块。在函数体中，作为重复参数指定的值可以在单元格数组中使用X和y．的值之间插入X和y将所需的输入匹配到阴谋功能：绘图（x1，y1，...）．

功能myplotrepeating（x，y）参数(重复)x（1，:)双y（1，:)双结尾%函数代码%交错x和yz =重塑（[x; y]，1，[]）;%调用plot函数如果~ isempty (z)情节(z {:});结尾结尾

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

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

功能F（a，b，varargin）参数一种uint32B.uint32结尾参数（重复）varargin结尾%函数代码．..结尾

名称 - 值参数

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

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

参数namevalueargs.name1 namevalueargs.name2.结尾

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

功能myfunction（namevalueargs）

使用名称值结构中的字段名称调用函数。

myFunction（name1 = value1，name2 = value2）

在R2021a之前，传递名称时使用字符串或字符向量，名称和值之间用逗号分隔。两个语法都在稍后的版本中有效。

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

功能结果= myfunction（namevalueargs）参数namevalueargs.name1 namevalueargs.name2.结尾%函数代码结果= NameValueArgs。Name1* NameValueArgs.Name2;结尾

r = myfunction（name1 = 3，name2 = 7）

r = 21.

当没有歧义时，名称-值参数支持部分名称匹配金宝app。例如，一个函数定义线宽和线型由于其两个名称值参数接受LineW和线，但使用线导致错误。通常，使用全名是建议的做法，以提高代码可读性并避免意外行为。

功能MyRectangle（宽度，高度，选项）参数宽度双倍的高度双倍的选项.LINESTYLE.（1,1）字符串=“ - ”选项.LineWidth.（1,1）{mustbenumeric}= 1结尾%函数代码．..结尾

MyRectangle（4,5）MyRectangle（4,5，Linestyle ="："，LineWidth = 2）MyRectangle（4,5，LineWidth = 2，Linestyle ="："）MyRectangle（4,5，Linestyle ="："）MyRectangle（4,5，LineWidth = 2）

MyRectangle（4,5，“linestyle”那"："那“行宽”，2）MyRectangle（4,5，“行宽”2，“linestyle”那"："）

功能linLog (x, y,规模)参数(重复)x（1，:)双y（1，:)双结尾参数scale.plottype.（1,1）字符串结尾z =重塑（[x; y]，1，[]）;如果Isfield（比例，“plottype”）如果scale.plottype ==.“林”绘图（z {：}）elseifscale.plottype ==.“日志”重对数(z {:})结尾结尾结尾

MyLinlog（1：5,1：5,1：10,1：100：1000）MyLinlog（1：5,1：5,1：10,1：100：1000，plottype =“日志”）

MYLINLOG（1：5,1：5,1：10,1：100：1000，“plottype”那“日志”）

功能myRectangle(宽度、高度、lineOptions fillOptions)参数宽度双倍的高度双倍的lineOptions。线型（1,1）字符串=“ - ”lineOptions。线宽（1,1）{mustbenumeric}= 1 fillOptions.Color.字符串fillOptions。模式结尾%函数代码．..结尾

来自类属性的名称值参数

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

structName.。？班级名称

函数可以使用“structName.。？班级名称“只有一次语法。因此，即使使用不同的类和结构名称，函数也可以仅定义从类中获取其字段名称的一个名称 - 值结构。

如果类别限制了通过使用属性验证可以分配给属性的值的限制，则该函数将验证应用于单个名称值参数。有关物业验证的信息，请参阅验证属性值．

例如，此函数有两个必需的参数，X和y并接受任何公共属性名称和价值matlab.graphics.chart.primitive.Bar.Bar.类。

功能mybar（x，y，propargs）参数X（：，：） 双倍的y（：，：） 双倍的propargs.?matlab.graphics.chart.primitive.Bar.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 =“分组”）

在R2021a之前，传递名称时使用字符串或字符向量，名称和值之间用逗号分隔。例如:

mybar（x，y，“facecholor”那“红色”那“BarLayout”那“分组”）

structName.。？班级名称structName.．propertyname.（dim1，dim2，...）类名{fcn1，fcn2，...}

功能mybar（x，y，propargs）参数X（：，：） 双倍的y（：，：） 双倍的propargs.?matlab.graphics.chart.primitive.bar Propargs.faceColor.{mustbemmber（propargs.facecolor，{'红色'，'blue'}）}=“蓝色的”结尾propertyCell = namedargs2cell (propArgs);栏(x, y, propertyCell {:})结尾

x =[1、2、3、4、5、6];y = x ^ 2;mybar（x，y）mybar（x，y，facecholor =“红色”，barlayout =“被分组”）

类方法中的参数验证

验证方法输入参数在公共方法中很有用，因为对方法的调用可能不会源于类代码。您可以使用混凝土类方法中的函数参数验证，包括在抽象类中定义的具体方法。但是，抽象方法（类别不实现的方法）无法定义参数块。有关类方法的信息，请参见方法和抽象班级和班级成员．

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

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

句柄类析构函数方法不能使用参数验证。一种命名的方法删除在包括一个包含一个的句柄子类中参数块未被视为析构函数。（换句话说，当对象被销毁时，Matlab不调用它）。有关类析构函数方法的更多信息，请参阅处理类析构函数．

论证验证的顺序

调用函数时，MATLAB按照它们所示的顺序验证输入参数参数块，从上到下。在验证下一个参数之前，每个参数都完全验证。因此，对先前声明的参数的任何引用都使用已验证的值。函数由于第一个验证故障而抛出错误。

验证值可以与调用函数传递的原始值不同。例如，此功能将输入称为类uint32价值观。第三个输入声明分配等于前两个输入的乘积的默认值。

功能c = f（a，b，c）参数一种uint32B.uint32Cuint32= 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)参数一种{mustBeOfClass(“双”),mustBeDims (a, 2)}B.{MustBeequalsize（B，A）}结尾%函数代码．..结尾%自定义验证器函数功能mustBeOfClass(输入类名)特定类名称的％测试cname = class（输入）;如果〜Strcmp（CNAME，CLASSNAME）EID ='类：NotCorrectClass';msg = [“输入必须是类”cname);BrontcAller（MEXception（EID，MSG））结尾结尾功能Mustbeequalsize（a，b）％测试相同的大小如果~ isequal(大小大小(a)、(b))开斋节='尺寸：不等';msg =.'输入必须具有相同的大小。;BrontcAller（MEXception（EID，MSG））结尾结尾功能Masebedims（输入，NumDims）%测试尺寸的数量如果〜Isequal（长度（尺寸（输入）），numdims）EID =“大小:wrongDimensions”;msg = [输入必须有维度，num2str（numdims）];BrontcAller（MEXception（EID，MSG））结尾结尾

这Mustbeofclass.函数通过要求与类名称匹配来强制匹配的严格类匹配。更普遍的方法可以使用isa.函数也匹配指定类的子类。

这Mustbeequalsize.和mandbedims.函数强制对输入参数进行严格声明。

FcustomValidators（'字符矢量'，144）

位置的输入参数无效1.输入必须是类双

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

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

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

这Mustbeequalsize.验证器函数将第二个输入限制为一个特定的维度，该维度在错误消息中提供。

FcustomValidators（（2,2），144）

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

对于相关的预定义验证函数，请参阅甘蔗那MustBefloat.， 和mustBeVector．

纳在论证验证中

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

重复参数是位置参数，因此调用时传递给函数的重复参数的数量包含在纳．

价值纳返回不包括函数调用中不包含的可选参数。还，纳不计算任何名称值参数。

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

功能结果= fnargin（a，b，c，namedargs）参数一种(1,1)的两倍B.(1,1)的两倍C(1,1)的两倍= 1 namedargs.format.（1，:) char结尾%函数代码转变纳案件2结果= A + B;案件3结果= a ^ c + b ^ c;结尾如果Isfield（Namedargs，“格式”）格式（namedargs.format）;结尾结尾

在这个函数调用中，值纳是2：

结果= fnargin（3,4）

结果= 7.

在这个函数调用中，值纳是3.：

结果= Fnargin（3,4,7.62）

结果= 4.3021E + 04

在这个函数调用中，值纳是3：

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

结果= 43020.56.

变量和函数访问限制

参数函数的工作空间中存在块。使用函数范围的任何包，类或函数使用进口命令被添加到范围内参数块。

验证器函数和默认值表达式唯一可见的变量是已经声明的输入变量。在此函数中，的默认值C来自一种和B.．

功能c = f（a，b，c）参数一种uint32B.uint32Cuint32= a * b结尾%函数代码．..结尾

但是，您无法引用尚未声明的输入变量参数块。例如，使用此声明作为参数一种在以前的函数中无效，因为B.和C还没有宣布。

参数UINT32 = B * C B UINT32 C UINT32结尾

参数验证表达式只能引用以前声明，因此验证了参数。名称值参数的验证函数和默认值无法访问其他名称值参数。

调试参数块

在调试参数块中，否则工作空间是只读．这意味着可以检查工作空间并查看分配给变量的值。但是，不可能创建新的变量或将分配给现有变量的值更改为仅在读取工作空间时。一旦调试器位于参数块之外，它将再次创建或编辑变量。