Определения аргументов

Примите переменное количество входов или выходов, проверьте на допустимые значения

Начиная с MATLAB® является нетипичным языком, большинство функций не требуют объявлений аргументов или валидации. Однако, если ваша функция имеет широкое использование, и вам нужно проверить тип, размер или другие аспекты входов, чтобы убедиться, что ваш код работает должным образом, вы можете задать arguments блок (с R2019b). Для получения дополнительной информации смотрите Валидация аргументов функции.

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

Функции

расширить все

Блок аргументов

argumentsОбъявить валидацию аргумента функции

Числовая Валидация

mustBePositiveПроверьте, что значение положительно
mustBeNonpositiveПроверьте, что значение непозитивно
mustBeNonnegativeПроверьте, что значение неотрицательно
mustBeNegativeПроверьте, что значение отрицательно
mustBeFiniteПроверьте, что значение конечное
mustBeNonNanПроверьте, что значение не NaN
mustBeNonzeroПроверьте, что значение ненулевое
mustBeNonsparseПроверьте, что значение не проанализировано
mustBeRealПроверьте, что значение реально
mustBeIntegerПроверьте, что значение целое
mustBeNonmissingПроверьте, что значение не отсутствует

Сравнения

mustBeGreaterThanПроверьте, что значение больше другого значения
mustBeLessThanПроверьте, что значение меньше другого значения
mustBeGreaterThanOrEqualПроверьте, что значение больше или равно другому значению
mustBeLessThanOrEqualПроверьте, что значение меньше или равно другому значению

Типы данных

mustBeAПроверьте, что значение получено из одного из заданных классов
mustBeNumericПроверьте, что значение является числовым
mustBeNumericOrLogicalПроверьте, что значение является числовым или логическим
mustBeFloatПроверьте, что значение является массивом с плавающей точкой
mustBeTextПроверьте, что значение является строковыми массивами, вектором символов или массивом ячеек из векторов символов
mustBeTextScalarПроверьте, что значение представляет собой одну часть текста
mustBeNonzeroLengthTextПроверьте, что значение является текстом ненулевой длины
mustBeUnderlyingTypeПроверьте, что значение имеет указанный базовый тип

Размер

mustBeNonemptyПроверьте, что значение непусто
mustBeScalarOrEmptyПроверьте, что значение скаляром или пустым
mustBeVectorПроверьте, что значение является вектором

Область значений и настройка членства

mustBeInRangeПроверьте, что значение находится в заданной области
mustBeMemberПроверьте, что значение является представителем заданного набора

Имена

mustBeFileПроверьте, что путь ссылается на файл
mustBeFolderПроверьте, что входной путь относится к папке
mustBeValidVariableNameПроверьте, что входное имя является допустимым именем переменной

Структура аргументов имя-значение

namedargs2cellПреобразуйте структуру, содержащую пары "имя-значение", в массив ячеек

Исходные данные

vararginСписок входных параметров переменной длины
narginКоличество входных аргументов функции
narginchkПроверьте количество входных параметров

Выходы

varargoutСписок выходных аргументов переменной длины
nargoutКоличество выходных аргументов функции
nargoutchkПроверьте количество выходных аргументов
validateattributesПроверяйте валидность массива
validatestringПроверяйте валидность текста
validatecolorПроверьте значения цветов
inputnameИмя переменного входного параметра функции
mfilenameИмя файла текущего выполняемого кода
inputParserВходной анализатор для функций

Темы

Значения аргументов

Способы проанализировать входные параметры функции

Выберите метод проверки валидности входных параметров.

Валидация аргумента функции

Объявить класс и размер входных параметров и применить ограничения к значениям аргументов.

Проверяйте входные параметры функции с помощью validateattributes

В этом примере показано, как проверить, что входы в вашу функцию соответствуют набору требований, используя validateattributes функция.

Анализ входных параметров функции

Задайте требуемые и необязательные входы, присвойте значения по умолчанию необязательным входам и проверьте все входы пользовательской функции с помощью Input Parser.

Количество аргументов

Поддерживайте переменное количество входов

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

Поддерживайте переменное количество выходов

Задайте функцию, которая возвращает переменное количество выходных аргументов с помощью varargout. Выходные varargout - массив ячеек, который содержит выходы функции, где каждый выход находится в своей собственной камере.

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

Использование nargin и nargout чтобы определить, сколько входных или выходных аргументов получит ваша функция.

Сквозные входы

Игнорируйте входные параметры в определениях функций

Если ваша функция принимает предопределенный набор входов, но не использует все входы, используйте tilde (~) оператор, чтобы игнорировать их в определении функции.

Для просмотра документации необходимо авторизоваться на сайте