nargin

Numero di argomenti di input della funzione

Sintassi

nargin

nargin(fun)

Descrizione

nargin restituisce il numero di argomenti di input della funzione specificati nella chiamata alla funzione attualmente in esecuzione. Utilizzare questa sintassi solo nel corpo di una funzione. Quando si utilizza un blocco di validazione arguments, il valore restituito da nargin all'interno di una funzione è il numero di argomenti per posizione forniti quando viene chiamata la funzione. Per maggiori informazioni, vedere Use nargin Functions During Argument Validation.

nargin(fun) restituisce il numero di argomenti di input che compaiono nella definizione della funzione fun. Se la definizione della funzione include varargin, nargin restituisce il negativo del numero di input. Ad esempio, se la funzione myFun dichiara gli input a, b e varargin, nargin('myFun') restituisce -3.

Se fun fa riferimento a una funzione che utilizza un blocco di validazione arguments, il valore restituito è il numero di argomenti per posizione dichiarati nella definizione della funzione come valore non negativo.

Esempi

Input alla funzione attuale

In un file denominato addme.m, creare una funzione che accetti fino a due input. Utilizzare nargin nel corpo della funzione per determinare il numero di input.

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

Dal prompt dei comandi, chiamare la funzione addme con due input.

c = addme(13,42)

c = 
55

Chiamare la funzione con un solo input.

c = addme(13)

c = 
26

Input definiti per una funzione

Determinare quanti input accetta una funzione.

La funzione addme creata nell'esempio precedente presenta due input nella propria dichiarazione (a e b). Definire il nome della funzione come vettore di caratteri e utilizzarlo come input per nargin.

fun = 'addme';
nargin(fun)

ans = 
2

Input alla funzione che utilizza varargin

Determinare quanti input può accettare una funzione che utilizza varargin.

In un file denominato mynewplot.m, creare una funzione che accetti input numerici x e y e un numero qualsiasi di ulteriori input per il grafico utilizzando varargin.

type mynewplot.m

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

Eseguire una query per determinare quanti input può accettare newplot.

fx = 'mynewplot';
nargin(fx)

ans = 
-3

Il segno meno indica che il terzo input è varargin. La funzione mynewplot può accettare un numero indeterminato di ulteriori argomenti di input.

Argomenti di input

fun — Funzione

handle della funzione | vettore di caratteri | scalare di stringa

Funzione per cui nargin restituisce il numero di argomenti di input dalla propria definizione, specificata come handle della funzione, vettore di caratteri o scalare di stringa.

Esempio @cos

Esempio 'plot'

Tipi di dati: char | function_handle

Funzionalità estese

Generazione di codice C/C++

Genera codice C e C++ con MATLAB® Coder™.

Note su utilizzo e limitazioni:

• Per la sintassi nargin(fun), se fun è un handle della funzione o un nome della funzione non supportato dalla generazione di codice C/C++, il codice generato per nargin restituisce 0.

• La generazione di codice C/C++ non supporta nargin(fun) per le funzioni annidate. Se fun è una funzione annidata e non è presente nessun'altra funzione denominata fun come funzione locale o nel percorso di MATLAB^®, la generazione di codice non va a buon fine.

Generazione di codice GPU

Genera codice CUDA® per GPU NVIDIA® con GPU Coder™.

Consultare le note su utilizzo e limitazioni nella sezione Generazione di codice C/C++. Le stesse note su utilizzo e limitazioni si applicano alla generazione di codice GPU.

Ambiente basato su thread

Esegui il codice in background usando MATLAB® backgroundPool oppure accelera il codice con Parallel Computing Toolbox™ ThreadPool.

La funzione nargin supporta completamente gli ambienti basati su thread. Per maggiori informazioni, vedere Run MATLAB Functions in Thread-Based Environment.

Cronologia versioni

Introduzione prima di R2006a

Vedi anche

narginchk | nargout | varargin

Argomenti

• Use nargin Functions During Argument Validation
• Find Number of Function Arguments
• Function Argument Validation
• Checking Number of Arguments in Nested Functions