Opcjonalne argumenty w funkcjach MATLAB

Question

Jak mogę zadeklarować funkcję w MATLAB z opcjonalnymi argumentami?

Na przykład: function [a] = train(x, y, opt), gdzie opcja musi być opcjonalnym argumentem.

Answer 1

Istnieje kilka różnych opcji, jak to zrobić. Najbardziej podstawowym jest użycie varargin, a następnie użycie nargin, size itd. W celu ustalenia, czy opcjonalne argumenty zostały przekazane do funkcji.

% Function that takes two arguments, X & Y, followed by a variable 
% number of additional arguments 
function varlist(X,Y,varargin) 
    fprintf('Total number of inputs = %d\n',nargin); 

    nVarargs = length(varargin); 
    fprintf('Inputs in varargin(%d):\n',nVarargs) 
    for k = 1:nVarargs 
     fprintf(' %d\n', varargin{k}) 
    end 

Nieco bardziej eleganckie rozwiązanie patrząc jest użycie klasy inputParser zdefiniowanie wszystkich argumentów oczekiwanych przez funkcję, zarówno obowiązkowe i fakultatywne. inputParser umożliwia również wykonywanie sprawdzania typów we wszystkich argumentach.

Answer 2

Prostym sposobem na to jest via nargin (N argumentów w). Minusem jest upewnienie się, że lista argumentów i sprawdzenia nargin są zgodne.

Warto pamiętać, że wszystkie wejścia są opcjonalne, ale funkcje wyjdą z błędem, jeśli wywoła zmienną, która nie jest ustawiona. Poniższy przykład ustawia wartości domyślne dla b i c. Wyjdzie, jeśli nie jest obecny.

function [ output_args ] = input_example(a, b, c) 
if nargin < 1 
    error('input_example : a is a required input') 
end 

if nargin < 2 
    b = 20 
end 

if nargin < 3 
    c = 30 
end 
end 

Answer 3

Dobrym sposobem będzie o to, aby nie używać nargin, ale aby sprawdzić, czy zmienne zostały ustawione przy użyciu exist('opt', 'var').

Przykład:

function [a] = train(x, y, opt) 
    if (~exist('opt', 'var')) 
     opt = true; 
    end 
end 

Zobacz tę odpowiedź dla profesjonalistów to zrobić w ten sposób: How to check whether an argument is supplied in function call?