varargin和varargout函数的妙用

森之张卫东

下面是一个简单函数例子，这个函数拥有不同的参数数目。函数plotline任意数目的1×2行向量，每一个向量包含一个点(x,y)。函数把这些点连成线。注意这个函数也接受直线类型字符串，并把这些字符串转递给plot的函数。

1. <blockquote><font size="4">function plotline(varargin)</font>

复制代码

我们用下面的参数调用这个函数，产生的图象如图7.5所示。用相同的数目的参数调用函数，看它产生的结果为什么？

也有专门的输出参数，vargout，它支持不同数目的输出参数。这个参数显示在输出参数列表的最后一项。它返回一个单无阵列，所示单个输出实参支持任意数目的实参。每一个实参都是这个单无阵列的元素，存储在varargout。

如果它被应用，varargout必须是输出参数列表中最后一项，在其它输入参数之后。存储在varargout中的变量数由函数nargout确定，这个函数用指定于任何一个已知函数的输出实参。例如，我们要编写一函数，它返回任意数目的随机数。我们的函数可以用函数nargout指定输出函数的数目，并把这些数目存储在单元阵列varargout中。

图7.5 函数plotline产生的图象

function [nvals, varargout] = test2(mult)

%   nvals is the number ofrandom values returned

%   varargout contains therandom values returned

nvals = nargout - 1;

for ii = 1:nargout-1

    varargout{ii} =randn *mult;

end

当这个函数被执行时，产生的结果如下

>> test2(4)

ans =

    -1

>> [a b c d] = test2(4)

a =

     3

b =

   -1.7303

c =

   -6.6623

d =

    0.5013

好的编程习惯

应用单元阵列varargin和varargout创建函数，这个函数支持不同数目的输入或输出参数。

森之张卫东

2. function plotline(varargin)
   
3. %PLOTLINE Plot points specified by [x,y] pairs.
   
4. % Function PLOTLINE accepts an arbitrary number of
   
5. % [x,y] points and plots a line connecting them.
   
6. % In addition, it can accept a line specification
   
7. % string, and pass that string on to function plot.
   
8. % Define variables:
   
9. % ii                                        --Index variable
   
10. % jj                                        --Index variable
    
11. % linespec                  --String defining plot characteristics
    
12. % msg                     --Error message
    
13. % varargin                  --Cell array containing input arguments
    
14. % x                        --x values to plot
    
15. % y                        --y values to plot
    
16. % Record of revisions:
    
17. % Date       Programmer    Description of change
    
18. % ====      =========    =====================
    
19. % 10/20/98 S. J. Chapman     Original code
    
20. % Check for a legal number of input arguments.
    
21. % We need at least 2 points to plot a line...
    
22. msg = nargchk(2,Inf,nargin);
    
23. error(msg);
    
24. % Initialize values
    
25. jj = 0;
    
26. linespec = '';
    
27. % Get the x and y values, making sure to save the line
    
28. % specification string, if one exists.
    
29. for ii = 1:nargin
    
30.     % Is this argument an [x,y] pair or the line
    
31.     % specification?
    
32.     if ischar(varargin{ii})
    
33.         % Save line specification
    
34.         linespec = varargin{ii};
    
35.     else
    
36.         % This is an [x,y] pair. Recover the values.
    
37.         jj = jj + 1;
    
38.         x(jj) = varargin{ii}(1);
    
39.         y(jj) = varargin{ii}(2);
    
40.     end
    
41. end
    
42. % Plot function.
    
43. if isempty(linespec)
    
44.     plot(x,y);
    
45. else
    
46.     plot(x,y,linespec);
    
47. end
    

function plotline(varargin)<br /> %PLOTLINE Plot points specified by [x,y] pairs.<br /> % Function PLOTLINE accepts an arbitrary number of<br /> % [x,y] points and plots a line connecting them.<br /> % In addition, it can accept a line specification<br /> % string, and pass that string on to function plot.<br /> % Define variables:<br /> % ii                                        --Index variable<br /> % jj                                        --Index variable<br /> % linespec                  --String defining plot characteristics<br /> % msg                     --Error message<br /> % varargin                  --Cell array containing input arguments<br /> % x                        --x values to plot<br /> % y                        --y values to plot<br /> % Record of revisions:<br /> % Date       Programmer    Description of change<br /> % ====      =========    =====================<br /> % 10/20/98 S. J. Chapman     Original code<br /> % Check for a legal number of input arguments.<br /> % We need at least 2 points to plot a line...<br /> msg = nargchk(2,Inf,nargin);<br /> error(msg);<br /> % Initialize values<br /> jj = 0;<br /> linespec = '';<br /> % Get the x and y values, making sure to save the line<br /> % specification string, if one exists.<br /> for ii = 1:nargin<br />     % Is this argument an [x,y] pair or the line<br />     % specification?<br />     if ischar(varargin{ii})<br />         % Save line specification<br />         linespec = varargin{ii};<br />     else<br />         % This is an [x,y] pair. Recover the values.<br />         jj = jj + 1;<br />         x(jj) = varargin{ii}(1);<br />         y(jj) = varargin{ii}(2);<br />     end<br /> end<br /> % Plot function.<br /> if isempty(linespec)<br />     plot(x,y);<br /> else<br />     plot(x,y,linespec);<br /> end<br />