Для чего служит команда help matlab

Для чего служит команда help matlab

Например, команда help magic выведет в командное окно следующую информацию на английском языке

help magic
MAGIC Magic square.
MAGIC(N) is an N-by-N matrix constructed from the integers
1 through N^2 with equal row, column, and diagonal sums.
Produces valid magic squares for N = 1,3,4,5.

Следует обратить внимание, что текст интерактивной справки использует верхний регистр написания имен функций и переменных,чтобы выделить их из остальной части текста. Однако при вводе имен функций в командной строке всегда используются символы нижнего регистра, а поскольку система MATLAB чувствительна к выбору регистра, а действительные имена функций записываются строчными буквами.

Все функции системы MATLAB, а их более 800, организованы в логические группы, и структура каталогов основана на этой организации. Например, все функции линейной алгебры находятся в каталоге matfun. Можно распечатать все функции этого каталога с короткими пояснениями, если использовать команду help matfun:

Команда help сама по себе выводит на экран список каталогов

help
HELP topics:

Команда lookfor

Однако команда lookfor inverse найдет не менее дюжины совпадений, и это будет зависеть от того, какие ППП подключены к системе MATLAB.

lookfor inverse
INVHILB Inverse Hilbert matrix.
ACOS Inverse cosine.
ACOSH Inverse hyperbolic cosine.

IFFTN N-dimensional inverse discrete Fourier transform.
IPERMUTE Inverse permute array dimensions.
ICCEPS Inverse complex cepstrum.
IDCT Inverse discrete cosine transform.
idctold.m: %IDCT Inverse discrete cosine transform.

Меню Help

Это меню командного окна системы MATLAB показано на рис. 1.9 и позволяет активизировать следующие окна:

Ниспадающий список See also в этом случае не активен. Кнопки Back, Forward, Home позволяют переходить от одного активизированного окна к другому, либо возвратиться к начальному окну.

В правом верхнем углу окна расположены 3 кнопки Go to Help Desk, Tips, Close.

Кнопка Tips выводит окно подсказок (рис. 1.11). В этом окне ниспадающее меню активизировано и позволяет выполнить ряд дополнительных справочных команд More help info help (HTML), lokfor, which, demo, general.

Опция Help Desk. Эта опция позволяет получить доступ к большому объему справочной информации и к документации по системе, размещаемой либо на жестких дисках, либо на диске CD-ROM в рамках используемого персонального компьютера.

Многие из документов используют язык гипертекстовых ссылок HTML (HyperText Markup Language) и доступны для просмотра с помощью таких средств как Netscape Navigator eли Microsoft Explorer.

Эта опция может быть также инициирована с помощью команды helpdesk.

Опция About MATLAB. Эта опция выводит на экран заставку системы с указанием версии и принадлежности пользователю (рис. 1.12)

Просмотр и распечатка документации. Версии справочной доументации доступны для просмотра и распечатки в формате PDF (Portable Document Format) с помощью средства Adobe’s Acrobat. Оно позволяет просматривать текст в формате печатной страницы, с полным набором шрифтов, графики и изображений, с полным ощущением чтения книги. Одновременно это и наилучший способ получения копий нужных страниц.

Web-сервер фирмы MathWorks. Если Ваш компьюер подсоединен к сети Интернет, то можно реализовать через механизм Help Desk соединение с WWW-сервером фирмы-производителя и выйти на страницу системы MATLAB. Можно также восвоспользоваться электронной почтой,чтобы задать вопросы, внести предложения или сообщить об обнаружнных ошибках. Можно воспользоватьсяся поисковой системой WWW-сервера, чтобы сделать запрс к постоянно обновляемой базе данных технической поддержки. Возможности WWW-сервера постоянно и расширяются и вы можете более подробно ознакомиться с его информационными возможностями, непосредственно связавшись с его зеркалом в Европе по адресу www-europe.mathworks.com.

Исправляем ошибки: Нашли опечатку? Выделите ее мышкой и нажмите Ctrl+Enter

Источник

Документация

Помощь по функциям в Командном окне

Синтаксис

Описание

Примечание

Некоторый текст справки отображает имена функций в символах верхнего регистра, чтобы заставить их выделиться от остальной части текста. При введении этих имен функций используйте нижний регистр. Для имен функций, которые появляются в смешанном случае (таком как javaObject ), введите имена как показано.

help содержимое отображений, относящееся к вашим предыдущим действиям.

Примеры

Отобразите справку функционального и перегруженного метода

Отобразите справку для MATLAB ® delete функция.

Поскольку delete имя функции и нескольких методов, текст справки включает ссылку на список методов с тем же именем.

Запросите справку для delete метод handle класс.

Отобразите пакет, класс и справку метода

Отобразите справку для containers пакет, Map класс, и isKey метод.

Не все пакеты, классы, и сопоставленные методы или события требуют полной спецификации. Например, отобразите текст справки для throwAsCaller метод MException класс.

Отобразите переменную справку

Отобразите справку для функций в папке

Перечислите все функции в папке matlabroot /toolbox/matlab/timefun путем определения частичного пути.

Входные параметры

name — Имя функциональности
вектор символов | строковый скаляр

Имя функциональности, такое как имя функции, метода, класса, тулбокса или переменной в виде вектора символов или строкового скаляра. name также может быть символ оператора (такой как + ).

Если name переменная, help отображает текст справки для класса той переменной.

Если name появляется в нескольких папках на пути поиска файлов MATLAB, help отображает текст справки для первой инстанции name найденный на пути поиска файлов.

Если name перегружается, help отображает ссылку на список методов с тем же именем.

Если name задает имя или частичный путь папки:

Если папка содержит непустой Contents.m файл, help функционируйте отображает файл. Contents.m содержит список файлов программы MATLAB в папке и их описаниях.

Если папка не содержит Contents.m файл, help функционируйте перечисляет первую линию текста справки для каждого программного файла в папке.

Если name имя и папки и другого элемента на пути поиска файлов MATLAB (таком как метод, класс, тулбокс или переменная), help функционируйте отображает связанный текст для элемента на пути поиска файлов и ссылке, чтобы отобразить текст справки для папки.

Советы

Альтернативная функциональность

Просмотрите более обширную справку с помощью doc команда или браузер функций.

Источник

Для чего служит команда help matlab

Display help for MATLAB functions in Command Window

help lists all primary help topics in the Command Window. Each main help topic corresponds to a directory name on the MATLAB search path.

help / lists all operators and special characters, along with their descriptions.

help toolboxname / functionname displays the M-file help for the functionname that resides in the toolboxname directory. Use this form to get direct help for an overloaded function.

help syntax displays M-file help describing the syntax used in MATLAB commands and functions.

Note M-file help displayed in the Command Window uses all uppercase characters for the function and variable names to make them stand out from the rest of the text. When typing function names, however, use lowercase characters. Some functions for interfacing to Java do use mixed case; the M-file help accurately reflects that and you should use mixed case when typing them. For example, the javaObject function uses mixed case.

Creating Online Help for Your Own M-Files

The MATLAB help system, like MATLAB itself, is highly extensible. You can write help descriptions for your own M-files and toolboxes using the same self-documenting method that MATLAB M-files and toolboxes use.

The help function lists all help topics by displaying the first line (the H1 line) of the contents files in each directory on the MATLAB search path. The contents files are the M-files named Contents.m within each directory.

Create self-documenting online help for your own M-files by entering text on one or more contiguous comment lines, beginning with the second line of the file (first line if it is a script). For example, the function soundspeed.m begins with

These lines are the first block of contiguous comment lines. After the first contiguous comment lines, enter an executable statement or blank line, which effectively ends the help section. Any later comments in the M-file do not appear when you type help for the function.

The first comment line in any M-file (the H1 line) is special. It should contain the function name and a brief description of the function. The lookfor function searches and displays this line, and help displays these lines in directories that do not contain a Contents.m file. For the soundspeed example, the H1 line is

Use the Help Report to help you create and manage M-file help for your own files.

Creating Contents Files for Your Own M-File Directories

A Contents.m file is provided for each M-file directory included with the MATLAB software. If you create directories in which to store your own M-files, it is a good practice to create Contents.m files for them, too. Use the Contents Report to help you create and maintain your own Contents.m files.

help close displays help for the close function.

help database/close displays help for the close function in the Database Toolbox.

help datafeed displays help for the Datafeed Toolbox.

Источник

П.1. Справочная система MATLAB

ПРИЛОЖЕНИЕ

Среда MATLAB обладает многоуровневой справочной системой, которая позволяет получить информацию как по самой MATLAB, так и по всем ее приложениям.

Получить доступ к справочной информации MATLAB можно различными способами: введя в командную строку соответствующую справочную команду или функцию; с помощью команд меню Help; щелкнув на кнопке со знаком вопроса на панели инструментов основного окна MATLAB.

MATLAB имеет интерактивную справочную систему, которая реализуется в командном режиме с помощью ряда команд. Одной из них является команда

которая выводит весь список папок (каталогов), содержащих m-файлы с определениями операторов, функций и иных объектов (рис.П.1). Этот список дает представление о пакетах прикладных программ, расширяющих возможности системы MATLAB и содержащих примеры применения системы.

в командное окно выводится список встроенных элементарных функций (рис.П.2).

ASINH Inverse hyperbolic sine.

ASINH(X) is the inverse hyperbolic sine of the elements of X.

Теперь полученное сообщение содержит информацию о функции asinh. Хотя имя функции в MATLAB задается малыми (строчными) буквами, в сообщениях справочной системы имена функций и команд выделяются большими (прописными) буквами.

Если в командной строке набрать команду doc elfun, то при этом перейдем в главное окно Help внутренней справочной системы MATLAB, в правой половине которого будет открыта первая страница документа справочной информации с указанным заголовком.

В главном окне Help внутренней внутренней справочной системы MATLAB слева находится панель Help Navigator – так называемый Help – навигатор – с пятью вкладками, на которых реализованы различные способы поиска информации:

● Contents (Cодержание) – поиск информации по оглавлению доступных разделов;

● Index (Индекс) – поиск информации по алфавитному) каталогу;

● Search (Поиск) – поиск информации по ключевому слову или фразе, набираемых в поле ввода;

● Demos (Примеры) – переход к странице, с которой можно получить доступ к демонстрационным примерам по любым темам;

● Favorites (Фавориты) – список разделов, выделенных пользователем в качестве наиболее посещаемых.

● При вызове окна справки Help по умолчанию в нем отображается вкладка Contents с оглавлением, представленным в виде дерева справочных каталогов (разделов). Чтобы раскрыть в оглавлении нужный раздел, щелкните по кнопке со знаком (слева от названия раздела) либо дважды щелкните по кнопке с его названием.

Каждый раздел имеет подраздел Getting Started (Начало), который кратко знакомит с содержимым этого раздела, а также подраздел Examples (Примеры), помеченный пиктограммой с изображением лампочки – здесь можно найти соответствующие данной теме примеры.

Далее можно перейти к требуемому подразделу.

В раделе 6.6 рассмотрен пример решения с помощью солвера ode45 задачи Коши для обыкновенного дифференциального уравнения. Там же упоминалось уравнение Ван-дер-Поля y»-μ(1-y 2 )y’+y=0, пример решения которого с помощью солвера ode15sможно найти во встроенной в пакет MATLAB справочной системе Help. Это решение приведено внутри раздела Differential Equations, являющегося подразделом раздела Mathematics. Ознакомиться с ним с помощью Help Navigator можно следующим образом (рис.П.4).

Система MATLAB предлагает и решатели для граничных задач, а также решатели для дифференциальных уравнений с частными производными. Об этих решателях можно узнать с помощью Help Navigator следующим

Из рис.П.5 видно, что нужно ознакомится с разделами Boundary Value Problems for ODEs (Граничные задачи для обыкновенных дифференциальных уравнений) и Partial Differential Equations (Дифференциальные уравнения в частных производных). Они находятся внутри раздела Differential Equations, являющегося подразделом раздела Mathematics. Решению дифференциальных уравнений в частных производных посвящен отдельный пакет расширенной системы MATLAB – Partial Differentional ToolBox.

Чтобы выделить больше места для отображения справочной информации, панель Help Navigator можно закрыть щелчком по кнопке с крестиком в правом верхнем углу. Открыть панель после этого можно посредством команды View=> Help Navigator.● Вкладка Index (рис.П.6) позволяет

организовать поиск по ключевому слову, набираему в поле ввода под надписью Search index for (Поиск по индексу). Имеется возможность перемещаться по упорядоченному списку либо с помощью линейки прокрутки, либо набрав в поле ввода одну или несколько начальных букв.

● Вкладка Search (рис.П.7) позволяет организовать несколько вариантов поиска в зависимости от того, что выбрано среди строк раскрывающегося списка Search type (Тип поиска). Вариантов всего четыре – поиск по всем документам (Full text (Полный текст)), поиск по заголовкам документов (Docment Titles (Название документа)), поиск по именам функций (Function name (Имя функции)), поиск в базе данных по каналам Интернета (Online Knowledge Base (Информационная база в Интернете)).

● Вкладка Demos (рис.П.8) содержит на левой панели дерево каталогов с

демонстрационными примерами. Открыв нужный каталог (щелчком на кнопке со знаком ), попадаем на страницу на страницу со списком примеров по выбранной теме.

Примеры могут содержать листинги программ MATLAB, которые можно просмотреть и запустить на выполнение. Для запуска примера нужно щелкнуть на кнопке Run this demo (Запустить этот пример) внизу страницы с примером.

Примеры могут представлять собой видеоролики или видеоуроки, демонстрирующие, как пользоваться тем или иным инструментом.

● Страницы, которые просматриваются чаще всего, можно добавить в список избранных с помощью команды Add to Favorites (Добавить в избранное). После этого их названия появятся в меню Favorites, отсюда их можно будет быстро открыть.

Использование команд справки является быстрым способом получения информации, если вы точно знаете, что ищете и как это называется.

Например: doc ops – выводит информацию по разделу операторов и специальных символов; doc function – выводит информацию о назначении и создании файл-функций.

Для ускорения поиска сведений о функциях в файлах помощи предусмотрены два систематизированных каталога – список функций, упорядоченных по алфавиту и классифицированных по категориям (MATLAB Function Listed by Category (Список функций MATLAB по категориям)) и общий список всех функций, упорядоченных по алфавиту (MATLAB Function Listed Alphabetically(Алфавитный список функций MATLAB)).

Справочная система MATLAB позволяет получить информацию по пакету Symbolic Math Toolbox как по одному из приложений MATLAB. Для этого после вызова главного окна справки Help в оглавлении вкладки Contents надо раскрыть раздел Symbolic Math Toolbox. Способы получения информации по пакету в окне справки Help аналогичны тем, что были показаны выше при поиске информации по самой MATLAB.

В интерактивной справочной системе MATLAB с помощью команды

можно получить перечень входящих в пакет Symbolic Math Toolbox команд и функций. Для получения справки по любой команде или функции можно использовать команду

где name – это имя соответствующей команды или функции, а name.m – имя m – файла, задающего данную команду или функцию.

В справках вместо help можно использовать doc. При этом перейдем в главное окно Help внутренней справочной системы MATLAB, в правой половине которого будет открыта первая страница документа справочной информации с указанным заголовком. Например, (рис. П.9)

Источник

Для чего служит команда help matlab

Help for functions in Command Window

Syntax

Description

Note

Some help text displays the names of functions in uppercase characters to make them stand out from the rest of the text. When typing these function names, use lowercase. For function names that appear in mixed case (such as javaObject ), type the names as shown.

help displays content relevant to your previous actions.

Examples

Display Function and Overloaded Method Help

Display help for the MATLAB ® delete function.

Because delete is the name of a function and of several methods, the help text includes a link to a list of the methods with the same name.

Request help for the delete method of the handle class.

Display Package, Class, and Method Help

Display help for the containers package, the Map class, and the isKey method.

Not all packages, classes, and associated methods or events require complete specification. For example, display the help text for the throwAsCaller method of the MException class.

Display Variable Help

Display Help for Functions in Folder

List all of the functions in the folder matlabroot /toolbox/matlab/timefun by specifying a partial path.

Input Arguments

name — Functionality name
character vector | string scalar

Functionality name, such as the name of a function, method, class, toolbox, or variable, specified as a character vector or string scalar. name also can be an operator symbol (such as + ).

If name is a variable, help displays the help text for the class of that variable.

If name appears in multiple folders on the MATLAB search path, help displays the help text for the first instance of name found on the search path.

If name is overloaded, help displays a link to a list of the methods with the same name.

If name specifies the name or partial path of a folder:

If the folder contains a nonempty Contents.m file, the help function displays the file. Contents.m contains a list of MATLAB program files in the folder and their descriptions.

If the folder does not contain a Contents.m file, the help function lists the first line of help text for each program file in the folder.

If name is the name of both a folder and another item on the MATLAB search path (such as a method, class, toolbox, or variable), the help function displays the associated text for the item on the search path and a link to display the help text for the folder.

Alternative Functionality

View more extensive help using the doc command or the Function Browser.

Источник