nargin

Número de argumentos de entrada de una función

Sintaxis

nargin

nargin(fun)

Descripción

nargin devuelve el número de argumentos de entrada de una función que se proporcionan al llamar a la función que se está ejecutando. Utilice esta sintaxis únicamente en el cuerpo de una función. Cuando se utiliza un bloque de validación arguments, el valor devuelto por nargin dentro de una función es el número de argumentos de posición proporcionados cuando se llama a la función. Para obtener más información, consulte Use nargin Functions During Argument Validation.

nargin(fun) devuelve el número de argumentos de entrada que aparecen en la definición de la función fun. Si la función incluye varargin en su definición, nargin devuelve el negativo del número de entradas. Por ejemplo, si la función myFun declara entradas a, b y varargin, nargin('myFun') devuelve -3.

Si fun se refiere a una función que utiliza un bloque de validación arguments, el valor devuelto es el número de argumentos de posición declarados en la definición de la función como valor no negativo.

Ejemplos

Entradas a la función actual

En un archivo llamado addme.m, cree una función que acepte hasta dos entradas. Utilice nargin en el cuerpo de la función para determinar el número de entradas.

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

En la línea de comandos, llame a la función addme con dos entradas.

c = addme(13,42)

c = 
55

Llame a la función con una entrada.

c = addme(13)

c = 
26

Entradas definidas para una función

Determine cuántas entradas acepta una función.

La función addme, creada en el ejemplo anterior, tiene dos entradas en su instrucción de declaración (a y b). Defina el nombre de la función como vector de caracteres y utilícelo como entrada para nargin.

fun = 'addme';
nargin(fun)

ans = 
2

Entradas a la función que utiliza varargin

Determine cuántas entradas puede aceptar una función que utilice varargin.

En un archivo llamado mynewplot.m, cree una función que acepte las entradas numéricas x e y y cualquier número de entradas de gráfica adicionales utilizando varargin.

type mynewplot.m

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

Consulte cuántas entradas puede aceptar newplot .

fx = 'mynewplot';
nargin(fx)

ans = 
-3

El signo "menos" indica que la tercera entrada es varargin. La función mynewplot puede aceptar un número indeterminado de argumentos de entrada adicionales.

Argumentos de entrada

fun — Función

identificador de función | vector de caracteres | escalar de cadena

Función para la cual nargin devuelve el número de argumentos de entrada de su definición, especificada como identificador de función, vector de caracteres o escalar de cadena.

Ejemplo: @cos

Ejemplo: 'plot'

Tipos de datos: char | function_handle

Capacidades ampliadas

Generación de código C/C++

Genere código C y C++ mediante MATLAB® Coder™.

Notas y limitaciones de uso:

• Para la sintaxis nargin(fun), si fun es un identificador de función o un nombre de función no admitidos por la generación de código C/C++, el código generado para nargin devuelve 0.

• La generación de código C/C++ no es compatible con nargin(fun) para funciones anidadas. Si fun es una función anidada y no existe ninguna otra función llamada fun como función local o en la ruta de MATLAB^®, la generación de código falla.

Entorno basado en subprocesos

Ejecute código en segundo plano con MATLAB® backgroundPool o acelere código con Parallel Computing Toolbox™ ThreadPool.

Esta función es totalmente compatible con entornos basados en subprocesos. Para obtener más información, consulte Ejecutar funciones de MATLAB en entornos basados en subprocesos.

Historial de versiones

Introducido antes de R2006a

Consulte también

narginchk | nargout | varargin

Temas

• Use nargin Functions During Argument Validation
• Buscar el número de argumentos de funciones
• Function Argument Validation
• Checking Number of Arguments in Nested Functions