Matlab中的函数约定
1. 脚本与函数与文件
前面讲的所有内容,都可以在Matlab的命令行中间完成,但是我们的某一段计算,可能会希望能够多次运行,这个时候Matlab提供的基于文件约定的脚本和函数基本单元就派上了用场。
当然,脚本和函数区分的约定就在于文件头。一个文件的第一个有效行是一个function
定义,那么这个文件就是一个函数,否则就是一个脚本。
在Matlab命令行中输入edit filename
,就可以编辑一个文件,如果这个文件在搜索目标中不存在,那么Matlab会提示创建一个新文件。
1.1 搜索目录
上面提到的第一个概念就是搜索目录,Matlab在搜索目录中查找文件。如果使用过任何shell,那么这个概念就很熟悉了。
Matlab的搜索目录是一个cell数组,可以通过path
函数查看搜索目录,通过addpath
和rmpath
函数添加和删除搜索目录。
跟搜索路径相关的函数addpath
, matlabroot
, restoredefaultpath
, pathtool
, rehash
, rmpath
。利用Matalb的帮助系统查看这些函数的用法。
1.2 脚本
脚本的后缀是.m
,脚本文件的第一个有效行不是function
定义。
在Matlab命令行中输入文件名(去掉.m后缀),就可以运行这个脚本文件。Matlab解释器会从前到后执行文件中的所有语句。
1.3 函数
函数的后缀是.m
,函数文件的第一个有效行是function
定义。函数定义的语法是:
function [out1, out2, ...] = myfun(in1, in2, ...)
其中,myfun
是函数名,out1, out2, ...
是输出参数,in1, in2, ...
是输入参数。
函数文件的文件名是函数名,如果函数名和文件名不一致,那么Matlab解释器会根据文件名来调用函数,并且在编辑函数代码时,会提醒修改函数名称。
2. 函数
除了上面给出的函数方式,还有另外几种函数定义方式。
2.1 匿名函数
匿名函数是一种简单的函数定义方式,语法是:
f = @(x) x^2
这个语句定义了一个函数f
,这个函数接受一个参数x
,返回x^2
。
2.2 函数句柄
函数句柄是一种函数的引用方式,可以用来传递函数,或者在函数中调用函数。函数句柄的定义方式是:
f = @myfun
这个语句定义了一个函数句柄f
,指向函数myfun
。
在某些时候,还能通过字符串来定义函数句柄,这个时候就需要用到str2func
函数。
f = str2func('myfun')
在某些场合,这个函数会自动被调用,当需要得到函数句柄时,传递同名的字符串,就会自动转换为函数句柄。
f = 'myfun'
2.3 函数调用
函数调用的方式跟定义函数的语句差不多,去掉function
关键字。
[out1, out2, ...] = myfun(in1, in2, ...)
这个约定非常好玩,因为这个时候函数调用就跟变量一样。实际上,这可以用来定义常量。
function y = mypi() % 这个括号也可以省略
y = 3.14;
end
这个函数可以这样调用:
mypi
也可以在计算式中直接使用mypi
, 实际计算按照其返回值进行。
在举个例子,逻辑变量true
和false
就是这样类似的函数。
可以直接使用true
和false
,也可以用true()
和false()
,还可以输入参数true(n1, n2)
和false(n1, n2)
。
调用函数句柄的方式跟调用普通的函数一样,在函数句柄后面加上参数列表。
值得注意的的是,当把函数作为参数传递给另外一个函数的时候,可以使用函数句柄,也可以用@
符号来访问搜索目标中的函数,还可以直接传递匿名函数,例如@(x) x^2
,或者代表函数的字符串。
3. 函数的输入输出
3.1 显式的输入和输出
在利用上面的function
定义函数的时候,可以指定函数的输入和输出参数。函数的输入和输出参数是通过参数列表来指定的。
function [out1, out2, ...] = myfun(in1, in2, ...)
函数的输入和输出个数可以通过nargin
和nargout
函数来获取。
nargin('myfun')
nargout('myfun')
% or
nargin(@myfun) % 这个函数的输入参数个数
nargout(@myfun) % 这个函数的输出参数个数
当在一个函数的内部(就是在函数定义语句之后、对应的end
之前)调用不带参数的nargin
和nargout
函数时,会返回当前函数的输入和输出参数个数。
3.2 隐式的输入和输出
函数的输入和输出可以通过参数列表来指定,也可以通过varargin
和varargout
来实现。组合使用这两个函数和nargin
和nargout
函数,可以实现函数的输入和输出参数的灵活控制。
function varargout = arg_copy(varargin)
fprintf('%d --> %d \n', nargin, nargout);
if nargout == 0
return;
else
varargout = cell(1, nargout);
end
if nargin == 0 && nargout ~= 0
varargout{1:nargout} = "Not defined";
return;
end
if nargout <= nargin
varargout(1:nargout) = varargin(1:nargout);
else
varargout(1:nargin) = varargin(1:nargin);
varargout{nargin+1:nargout} = "Not defined";
end
这个函数能够处理任意数量的输入和输出,并把输入逐一拷贝到输出。如果输入不够,那么输出就用"Not defined"
来填充。
后面还要讲专门到cell
数组,目前我们只需要知道cell
数组是一种特殊的数组,可以存放任意类型的数据,也可以存放不同类型的数据。
而函数的输入和输出,都是采取跟cell
数组类似的方式来处理的。
关于这个还值得专门写一个帖子,还有挺多好玩的东西。
4. 结论
- Matlab用文件来组织代码,一个文件就是一个可以运行的命令或者可以调用的函数。
- 函数用
function
或者@
的方式来定义。 - 函数的输入和输出参数可以通过显式的参数列表来指定,也可以通过
varargin
和varargout
来实现。 - 建议遵守Matlab的函数命名约定,即函数文件的文件名和函数名一致,并且把函数的输入和输出参数都写在函数定义的第一行。