nargin

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

Синтаксис

Описание

пример

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

пример

nargin(fun) возвращает количество входных параметров, которые появляются в fun функциональное определение. Если функция включает varargin в его определении, затем nargin возвращает отрицание количества входных параметров. Например, если функциональный myFun объявляет вводит aB, и 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

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