介绍参数验证

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

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

定义的函数参数验证语法简化了过程可选的,重复的,名称参数。语法还使您能够以一致的方式定义默认值。

使用参数验证在哪里

使用函数参数在函数定义中验证是可选的。参数验证是最有用的功能,可以被任何代码之前,必须确定输入的有效性执行该函数的代码。设计供他人使用的函数可以受益于适当的水平的限制参数输入和机会返回特定错误消息基于输入功能。

参数块语法

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

您可以使用多个参数块在一个函数中,但是必须发生在任何代码块的一部分参数块。

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

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

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

(指数)=值

论点的例子验证

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

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

在这个函数中,变量必须满足这些验证需求:

函数forwardSpeed (a, b, c)参数一个双b字符cSpeedEnum结束%函数代码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)字符{mustBeMember(方法,{“线性”、“立方”、“花键”})}=“线性”结束%函数代码…。结束%定义验证函数函数mustBeEqualSize (a, b)%测试相同的大小如果~ isequal(大小大小(a)、(b))开斋节=尺寸:不等号的;味精=第一次输入的大小必须等于第二个输入的大小。”;throwAsCaller (MException(开斋节,味精))结束结束

类型的参数

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

必需和可选位置参数

位置参数必须被传递给一个函数在一个特定的顺序。的位置值传入参数列表必须对应于订单中声明的参数参数块。所有参数名称参数块必须是唯一的。

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

默认值可以是一个常量或表达式产生结果满足参数声明。表达式可以参考之前声明它的参数参数块,但不是参数声明。

MATLAB计算表达式只有当参数默认值不包括函数调用。

所有的可选参数都必须定位在所需的所有参数参数块。例如,在这个论点,maxval和minval有默认值,因此可选的。

函数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)

一个可选的位置参数成为地位必须填写时需要的函数调用来确定参数。也就是说,如果您想要指定一个值minval,您必须指定一个值maxval。

函数c = f (~)参数~结束%函数代码结束

c = f

c = f (2)

函数c = f (x ~)参数~ x结束%函数代码…结束

c = f (2、3)

重复的参数

反复重复参数位置参数,可以指定作为输入参数。在一个声明重复参数参数块,包括重复属性。

参数(重复)__arg1最长……结束

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

一个函数,定义了一个重复参数块可以被称为零个或多个事件的参数。如果调用函数包括重复参数,然后所有参数重复参数块必须包括对每一个重复。

例如,如果一个重复参数块定义参数x和y,那么每个重复必须包含两个x和y。

重复的参数不能指定默认值,因此不能选。然而,您可以调用这个函数没有包括任何重复参数。

函数必须声明重复参数位置参数和后名称参数。你不能指定名称参数内重复块。名称-值参数的信息,请参阅名称-值参数。

在函数中,每个重复论点成为细胞数组元素的个数等于重复中传递函数调用的数量。验证应用于细胞数组的每个元素。如果出现这个论点为零的函数被调用时,该单元阵列1-by-0大小。也就是说,它是空的。

例如,这个函数声明一块重复三个参数,x,y,选项。

函数(伊势亚、yCell optionCell] = fRepeat (x, y,选项)参数(重复)x双y双选项{mustBeMember(选项,[“线性”、“立方”])}结束%函数代码%返回细胞数组伊势亚= x;yCell = y;optionCell =选项;结束

你可以调用这个函数没有输入或三个输入的倍数。MATLAB为每个参数创建一个单元阵列包含所有的值传递参数。这叫fRepeat通过两组三个重复的参数。

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

伊势亚= 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和y %交错z =重塑((x, y), 1, []);%调用绘图函数如果~ isempty (z)情节(z {:});结束结束

与重复调用这个函数对输入参数。

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

函数f (a, b,变长度输入宗量)参数一个uint32buint32结束参数(重复)变长度输入宗量结束%函数代码…结束

名称-值参数

名称-值参数关联的名字和值传递给函数。名称-值参数:

在一个声明名称参数参数块使用点符号定义的字段结构。例如,名为结构NameValueArgs定义了两个名称-值参数,Name1和Name2。您可以使用任何有效的MATLAB标识符作为结构名称。

参数NameValueArgs。Name1NameValueArgs。Name2结束

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

函数myFunction (NameValueArgs)

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

myFunction (Name1 = value1, Name2 = value2)

R2021a之前,通过名称字符串或字符向量和独立的名称和值用逗号。语法都是有效的在以后的版本。

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

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

r = myFunction (Name1 = 3, Name2 = 7)

r = 21

名称-值参数支持部分名称匹配当没有歧义。金宝app例如,定义一个函数线宽和线型两个名称-值参数接受LineW和行,但使用行会导致错误。在一般情况下,推荐使用全名实践来提高代码的可读性,避免意想不到的行为。

函数myRectangle(宽度、高度、期权)参数宽度双高度双options.LineStyle(1,1)字符串=“-”options.LineWidth(1,1){mustBeNumeric}= 1结束%函数代码…结束

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

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

函数myLinLog (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) myLinLog (1:5, 1:5, 1:10, 1:100:1000) myLinLog (1:5, 1:5, 1:10, 1:100:1000 PlotType =“日志”)

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

函数myRectangle(宽度、高度、lineOptions fillOptions)参数宽度双高度双lineOptions.LineStyle(1,1)字符串=“-”lineOptions.LineWidth(1,1){mustBeNumeric}= 1 fillOptions.Color字符串fillOptions.Pattern结束%函数代码…结束

强劲的处理名称参数

最佳实践实现名称的参数在函数是通过定义一个参数块。一个参数块消除了需要编写自己的代码来解析名称-值的参数,和块也有助于实现鲁棒参数解析的“名字”,价值语法和名称=值语法在R2021a引入。

myFunction(数据、“allow-empty”,真正的)

函数mySignal(标签、单位、选择)参数标签=“0”单位=“安”opts.Magnifier{mustBeMember {opts.Magnifier,“小”,“中”,“大”]}}结束结束

mySignal (“杂志”,“库仑”)

函数mySignal(标签、单位、选择)参数标签单元=“安”opts.Magnifier{mustBeMember {opts.Magnifier,“小”,“中”,“大”]}}结束结束

从阶级属性名称参数

一个有用的功能语法在MATLAB使用一个类的公共属性名称的名称参数。为所有可设置的属性指定名称的参数定义的一个类(也就是说,所有公共属性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 =“分组”)

R2021a之前,通过名称字符串或字符向量和独立的名称和值用逗号。例如:

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文件包括在单独的文件中定义方法的原型方法,包括参数在单独的文件中定义的方法。在单独的文件中定义方法的更多信息,参见方法在单独的文件中。

子类方法不能继承函数参数验证。在子类覆盖父类方法的方法,您可以添加相同的参数验证子类方法用于超类的方法。

处理类析构函数方法不能使用参数验证。一个方法命名删除在处理包含一个子类参数块不是视为一个析构函数。(换句话说,它不是由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-by-3任何类的数组。

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

因为标准MATLAB类型转换和标量扩展,你可以用下面的输入和调用这个函数没有收到一个验证错误。

f (的特征向量,144)

默认情况下,MATLAB将特征向量的元素转换为其等效数值和标量扩展适用于创建一个5-by-3标量值的数组144年。

使用专门的验证功能可以提供更具体的输入参数验证。例如,这个函数定义了专门的验证功能,它使用的类和大小规格第一和第二参数。这些地方的功能使您能够避免输入值的转换。

函数fCustomValidators (a, b)参数一个{mustBeOfClass(“双”),mustBeDims (a, 2)}b{mustBeEqualSize (b)}结束%函数代码…结束%定制验证器功能函数mustBeOfClass(输入类名)%测试特定的类名cname =类(输入);如果开斋节= ~ strcmp (cname,类名)“类:notCorrectClass”;味精= [的输入必须是类的cname);throwAsCaller (MException(开斋节,味精))结束结束函数mustBeEqualSize (a, b)%测试相同的大小如果~ isequal(大小大小(a)、(b))开斋节=尺寸:不等号的;味精=输入大小一定相等。;throwAsCaller (MException(开斋节,味精))结束结束函数numDims mustBeDims(输入)%测试数量的维度如果~ isequal(长度(大小(输入)),numDims)开斋节=“大小:wrongDimensions”;味精= [的输入必须有尺寸:num2str (numDims)];throwAsCaller (MException(开斋节,味精))结束结束

的mustBeOfClass函数执行严格的类匹配要求与类的名称匹配。一个更一般的方法可以使用isa函数也匹配指定的类的子类。

的mustBeEqualSize和mustBeDims函数执行严格的输入参数的声明。

fCustomValidators (的特征向量,144)

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

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

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

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

的mustBeEqualSize验证器函数限制第二输入到一个特定的维度,这是提供的错误消息。

fCustomValidators((2, 2), 144年)

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

相关的预定义的验证功能,请参阅mustBeA,mustBeFloat,mustBeVector。

输入参数个数在参数验证

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

重复的参数位置参数的数量,因此重复传递到函数调用时的参数包含在返回的值输入参数个数。

的价值输入参数个数返回不包含可选参数,不包括函数调用。同时,输入参数个数不计算任何名称参数。

使用输入参数个数确定可选位置参数传递给函数时调用。例如,这个函数声明三个位置参数和一个名称-值参数。这就是函数决定了参数传递时调用。

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

这个函数调用的值输入参数个数是2:

结果= fNargin (3、4)

结果= 7

这个函数调用的值输入参数个数是3:

结果= fNargin (3、4、7.62)

结果= 4.3021 e + 04

这个函数调用的值输入参数个数是3:

结果= fNargin(3、4、7.62、格式=“银行”)

结果= 43020.56

限制变量和函数访问

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

验证器的唯一变量可见功能和默认值表达式的输入变量已经宣布。这个函数的默认值c来自一个和b。

函数c = f (a, b, c)参数一个uint32buint32cuint32= a * b结束%函数代码…结束

不过,你不能把输入变量还没有宣布的参数块。例如,使用此声明为参数一个是无效的,因为在前面的函数b和c尚未宣布。

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

参数验证表达式可以参考此前宣布,因此验证参数。验证函数名称和默认值参数不能访问其他名称参数。

调试参数块

而内部调试的参数块工作区只读。这意味着它可以检查工作区并查看分配给变量的值。然而,它是不可能创建新变量或改变的值分配给现有的变量而工作区是只读的。一旦调试器以外的参数块将再次可以创建或编辑变量。