[原创教程] Matlab内嵌函数varargin使用教程

    • @Copyright HUST-悟空实验室 2013

    • Matlab有非常多的内嵌函数和工具箱函数用到了varargin。

      • 比如最常见的plot函数，除了x,y是数据意外，剩下的都需指定 属性名称(PropertyName) 及其 属性值(PropertyValue) 。
      • 例如：
        1. x = -pi:pi/10:pi;
        2. y = tan(sin(x)) - sin(tan(x));
        3. plot(x,y,'--rs','LineWidth',2, 'MarkerEdgeColor','k',…
        4. 'MarkerFaceColor','g', 'MarkerSize',10);

    • 当函数形参过多的时候，使用varargin定义函数形参的形式是非常必要的。

      • 但是帮助文件言之不详，而且普通的调用方法无法实现报错功能。
      • 在查阅众多内嵌函数后，这里给大家以一个例子说明各种数据类型：字符串、数值、变量的用法。
    • 本文最有价值的在于两个内嵌函数（help都help不到哦）的使用：
      • internal.stats.parseArgs
      • internal.stats.getParamVal
        • 对每个属性赋值，若调用lrh函数时没有添加某个属性，则自动为默认值。
        • 这个函数的意义就在于不需要对着varargin元胞一个一个对比、赋值了。
    • 报错功能
      • 凡是属性值包含字符串的属性，都需要用此函数检查用户输入的属性值是否包含在属性的全部属性值中

    函数调用脚本

    1. x=1:20;
    2. y=60:-1:41;
    3. result=lrh(x,y,'Algorithm','+','U',4,'Sqornot','false');
    5. function result=lrh(x,y,varargin)
    6. %% varargin示例函数
    7. % x,y为长度为l的两个数值向量
    8. % 用于计算result=f(x,y)
    9. % Algorithm包含加、减、乘、除四种运算
    10. % a为x前系数，b为y前系数，如result=ax+by默认为1.
    11. % u为截距项，默认为长度为l的零向量
    12. % sqornot为是否开方，属性值为true 或者 false
    13. %% 设置默认属性、属性值
    14. paramNames = {'Algorithm','A','B','U','Sqornot'};
    15. vU=zeros(length(x),1);
    16. defaultsValue = {'+',1,1,vU,'false'};
    17. %% 对每个属性赋值，若调用lrh函数时没有添加某个属性，则自动为默认值
    18. [vAlgorithm, vA, vB, vUU,vSqornot]...
    19.     =internal.stats.parseArgs(paramNames,defaultsValue,varargin{:});
    20. %% 报错功能：凡是属性值包含字符串的属性，都需要用internal.stats.getParamVal检查是否用户输入的属性值不包含在属性全部属性值中
    21. AlgorithmNames = {'+','-','*','/'};
    22. vAlgorithm =internal.stats.getParamVal(vAlgorithm,AlgorithmNames,...
    23.     '''Algorithm''');
    24. SqornotNames = {'true','false'};
    25. vSqornot =internal.stats.getParamVal(vSqornot,SqornotNames,...
    26.     '''Sqornot''');
    27. %% 主函数
    28. vUU=zeros(length(x),1)+vUU;
    29. switch vAlgorithm
    30.     case '+'
    31.         switch vSqornot
    32.             case 'true'
    33.                 result=sqrt(vA*x+vB*y+vUU);
    34.             case 'false'
    35.                 result=vA*x+vB*y+vUU;
    36.         end
    37.     case '-'
    38.         switch vSqornot
    39.             case 'true'
    40.                 result=sqrt(vA*x-vB*y-vUU);
    41.             case 'false'
    42.                 result=vA*x-vB*y-vUU;
    43.         end
    44.     case '*'
    45.         switch vSqornot
    46.             case 'true'
    47.                result=sqrt((vA*x).*(vB*y).*vUU);
    48.             case 'false'
    49.                 result=(vA*x).*(vB*y).*vUU;
    50.         end
    51.     case '/'
    52.         switch vSqornot
    53.             case 'true'
    54.                result=sqrt((vA*x)./(vB*y)./vUU);
    55.             case 'false'
    56.                 result=(vA*x)./(vB*y)./vUU;
    57.         end
    58. end
    60. end