MATLAB中的帮助指令的使用

xueyi

MATLAB中的帮助指令的使用<br><br>MALTAB的各个函数，不管是内建函数、M文件函数、还是MEX文件函数等，一般它们都有M文件的使用帮助和函数功能说明，各个工具箱通常情况下也具有一个与工具箱名相同的M文件用来说明工具箱的构成内容等。在MATLAB命令窗口中，可以通过指令来获取这些纯文本的帮助信息。<br>通常能够起到帮助作用、获取帮助信息的指令有help、lookfor、which、doc、get、type等。<br><br>help指令<br>可以说help指令是MATLAB中最有用的指令之一；也可以说，如果一个MATLAB编程人员不能够熟练的使用help指令，那么他（她）就不能够称之为一个熟练的MATLAB使用者。下面介绍一下help的几种常见使用情况。<br>1） 直接使用help指令，可以获取当前电脑上MATLAB的分类列表，即当前安装的工具箱名称以及其简要描述。例如，在命令窗口种输入help，可以得到如下信息：<br>help <br>HELP topics<br>matlab\general - General purpose commands.<br>matlab\ops - Operators and special characters.<br>matlab\lang - Programming language constructs.<br>matlab\elmat - Elementary matrices and matrix manipulation.<br>matlab\graphics - Handle Graphics.<br>matlab\uitools - Graphical user interface tools.<br>matlab\codetools - Commands for creating and debugging code.<br>matlab\helptools - Help commands.<br>simulink\simulink - Simulink<br>simulink\blocks - Simulink block library.<br>simulink\components - Simulink components.<br>... ...<br>xpc\xpcdemos - xPC Target -- demos and sample script files.<br>xpc\xpcmngr - (No table of contents file)<br>kernel\embedded - xPC Target Embedded Option<br>MATLAB7\work - (No table of contents file)<br>(上面的省略号为笔者所加)<br>2）使用 help 工具箱名 ，可以获取该工具箱的相关的函数、图形用户工具以及演示文件名等。由前面的help的使用方法1），我们可以在毫不知道我们要查找的函数具体名称，也不清除它所在工具箱的具体名称，仅仅知道其大概所属类别的情况下，查找出其所在工具箱的具体名称。然后，再用help 工具箱名 就可以得到该工具箱的函数列表，每个函数后面有简要的说明，可以根据其说明来确定可能需要的是哪个函数。例如，在命令窗口中，输入 help optim 就可以获得该工具箱基本信息和分类函数列表：<br>help optim <br>Optimization Toolbox<br>Version 3.0 (R14) 05-May-2004 <br><br>Nonlinear minimization of functions.<br>fminbnd - Scalar bounded nonlinear function minimization.<br>... ...<br>Nonlinear minimization of multi-objective functions.<br>fgoalattain - Multidimensional goal attainment optimization <br>... ...<br>Linear least squares (of matrix problems).<br>lsqlin - Linear least squares with linear constraints.<br>... ...<br>Demonstrations of medium-scale methods.<br>tutdemo - Tutorial walk-through.<br>goaldemo - Goal attainment.<br>datdemo - Fitting data to a curve.<br>... ...<br>Medium-scale examples from User's Guide<br>objfun - nonlinear objective<br>confun - nonlinear constraints<br>... ...<br>Large-scale examples from User's Guide<br>nlsf1 - nonlinear equations objective with Jacobian<br>... ...<br>densecolumns - MAT-file of linear programming example<br>(上面的省略号为笔者所加)<br>3）使用help 函数名 可以获得该函数的纯文本的帮助信息，通常也带有少量的例子。通过上面的使用方法2），应该已经找到了需要的函数的具体名称，然后就可以在MATLAB命令窗口中用help指令获取该函数的具体信息了。例如，help fminbnd可以得到如下信息：<br>help fminbnd <br>FMINBND Scalar bounded nonlinear function minimization.<br>X = FMINBND(FUN,x1,x2) attempts to find a local minimizer X of the function. FUN in the interval x1 &lt;= X &lt;= x2. FUN accepts scalar input X and returns a scalar function value F evaluated at X.<br>X = FMINBND(FUN,x1,x2,OPTIONS) <br>  ... ... %通常这里都是该函数的使用的语法及其各个输入输出参数意义描述&lt;笔者注&gt;<br>Examples<br>... ... % 这里是一些该函数的使用举例&lt;笔者注&gt;<br>See also OPTIMSET, FMINSEARCH, FZERO, FUNCTION_HANDLE.% 给出一些相关命令<br>Reference page in Help browser<br>doc fminbnd <br>在采用这种方法得到该函数帮助信息的时候，一个值得注意的是最后面的See also给出了该函数有相关的一些指令，有时候通过这些相关指令，可以查找到更广泛的有用信息。<br><br>lookfor指令<br>lookfor指令是在MATLAB的搜索路径所有M文件的第一个注释行搜索特定关键字。通常在我们不确定需要搜索的函数，知道该函数的功能的时候，也可以通过lookfor 搜索该功能的关键字。例如，想查找一个画椭圆的命令，我们可以lookfor ellipse（如果不知道椭圆怎么写，可以先用汉英字典查找），得到如下信息，然后再选取函数查找具体的信息：<br>lookfor ellipse <br>ELLIPSEDRAW can draw an arbitrary ellipse with given parameters.<br>ELLIPSE Ellipse Grapics Object Using Line or Patch.<br>RECTANGLE Create rectangle, rounded-rectangle, or ellipse.<br>ECC2FLAT Computes the flattening of an ellipse given an eccentricity<br>ECC2N Computes the parameter n of an ellipse given an eccentricity<br>FLAT2ECC Computes the eccentricity of an ellipse given a flattening<br>N2ECC Computes the eccentricity of an ellipse given the parameter n<br>PDEELLIP Draw ellipse, update Geometry Description matrix.<br>FITMODEL Fit an ellipse to data. <br><br>which 指令<br>which指令可以用来定位该函数的位置，通过这个位置信息，可以获取该函数所属的类别。通常，编程人家再自己创建一个M文件或者保存一个M文件的时候，为了避免与系统函数等同名，就应该先用which 文件(函数)名 –all 搜索查找是否存在你想要保存的文件名或者函数名。<br>另外，很好的利用得到的位置信息可以进行一些相关联的文件的帮助信息。例如，在编程过程中，需要一个保存文件对话框，但想不起该函数名，也不确定是否确实有此函数，但是我们很清楚的是有个与此类似打开文件对话框，函数名为 uigetfile，因此，采用which定位uigetfile：<br>which uigetfile -all <br>d:\programs\matlab7\toolbox\matlab\uitools\uigetfile.bi<br>d:\programs\matlab7\toolbox\matlab\uitools\uigetfile.m % Shadowed <br>从给出的地址可以看出，该函数属于uitools类，于是用help uitools查找该类别信息，在该类别的Dialog boxes子类别中找到这么一条：<br>uiputfile - Standard save file dialog box.<br>然后，在通过用 help uiputfile获取该函数的详细的帮助信息和使用方法。<br><br>set/get 指令<br>set 指令可以获取图形对象的属性列表和被选属性值。在GUI编程和数据可视化的时候，有时想改变某些对象的属性，让它按照自己的想法实现，但是又想不起这些对象的属性名，更不知道如何设置它们。这时，可以用 get（objecthandles）得到此对象的所有的属性及其当前值，用set(handles)可以得到对象所有可以设置的属性及其可能的取值。找到需要的属性名和可能的取值之后，就用set(handles,propertyname,values)设置此对象此属性的值。<br><br>其他帮助指令<br>doc 函数名可以在MATLAB的帮助文档浏览器中调出该函数的文档；type M文件函数名或者edit M文件函数名可以分别在命令窗口中打印出该M文件源代码 和 在M文件编辑器中打开该M文件函数源代码，以便查看该函数源文件；helpwin 函数名 与 help 函数名获得的帮助信息一样，只是将其在帮助文件浏览器中打开。 <br>

[此贴子已经被作者于2006-1-1 17:59:32编辑过]

wulan

很有用，谢谢！

Crespo97

<P>good!!</P>

pomato

xinku!<BR>hehe[em07]

刘贤超

<P>good!!!!!!</P>

ljcjeans

非常感谢，又学到不少

laim

very good!

sprine

谢谢，还应该好好学学。

chen840

太好了，谢谢

zhangchuan

<P>谢谢哦</P>

redapple

<P>收藏了，非常感谢！</P>

handcart

you yong  

weision

<P>非常好，学习了。</P>

牛仔裤

太谢谢了

lana2000

非常感谢，呵呵！！