exponenta event banner

nargin

Количество входных аргументов функции

Описание

пример

nargin возвращает число входных аргументов функции, приведенных в вызове исполняемой функции. Используйте этот синтаксис только в теле функции. При использовании arguments блок проверки, значение, возвращенное nargin внутри функции - количество позиционных аргументов, предоставляемых при вызове функции. Дополнительные сведения см. в разделе наргин в разделе Проверка аргументов.

пример

nargin(fun) возвращает количество входных аргументов, которые отображаются в fun определение функции. Если функция включает varargin в его определении, то nargin возвращает отрицательное значение числа входов. Например, если функция myFun объявляет входные данные a, b, и varargin, то nargin('myFun') прибыль -3.

Если входной аргумент ссылается на функцию, использующую arguments блок проверки, то возвращаемое значение - это количество объявленных позиционных аргументов в определении функции как неотрицательное значение.

Примеры

свернуть все

В файле с именем addme.mсоздайте функцию, которая принимает до двух входов. Использовать nargin в теле функции для определения количества входов.

type addme.m
function c = addme(a,b)
    switch nargin
        case 2
            c = a + b;
        case 1
            c = a + a;
        otherwise
            c = 0;
    end
end

В командной строке вызовите addme функция с двумя входами.

c = addme(13,42)
c = 55

Вызовите функцию с одним входом.

c = addme(13)
c = 26

Определите, сколько входных данных принимает функция.

Функция addme создан в предыдущем примере, имеет два входа в своем объявлении (a и b). Определите имя функции как символьный вектор и используйте его как ввод для nargin.

fun = 'addme';
nargin(fun)
ans = 2

Определите, сколько входов использует функция varargin может принять.

В файле с именем mynewplot.m, создайте функцию, которая принимает числовые входные данные x и y и любое количество дополнительных входных данных графика с использованием varargin.

type mynewplot.m
function mynewplot(x,y,varargin)
    figure
    plot(x,y,varargin{:})
    title('My New Plot')
end

Запрос количества входных данных newplot может принять.

fx = 'mynewplot';
nargin(fx)
ans = -3

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

Входные аргументы

свернуть все

Функция, для которой nargin возвращает число входных аргументов из определения, указанного как дескриптор функции, символьный вектор или строковый скаляр.

Пример: @cos

Пример: 'plot'

Типы данных: char | function_handle

Расширенные возможности

.
Представлен до R2006a