Doug's MATLAB Video Tutorials

January 8th, 2008

Advanced MATLAB: Varargin and Nargin- variable inputs to a function

Most MATLAB functions are overloaded. That means that there are several ways to call them and that MATLAB will “Do The Right Thing” based on the number and types of inputs. As a simple example you can call SUM sum(M) %this will sum along the columns sum(M,2) %this will sum along the rows This video shows how you can implement the same behavior based on using VARARGIN: VARiable ARGuments IN NARGIN: Number ARGuments IN
Find the files here. PodCast here Other videos have been gathered here: http://blogs.mathworks.com/pick/category/video/ Other Advanced MATLAB posts have been gathered here: http://blogs.mathworks.com/pick/category/advanced-matlab/

6 Responses to “Advanced MATLAB: Varargin and Nargin- variable inputs to a function”

  1. Justin replied on :

    Can your output ever be a text and not a number?

  2. Markus replied on :

    Hi!

    I sometimes use “exist” in order to realize variable inputs:

    function bla(A,B,D)
    if ~exist(‘D’, ‘var’)
    D = 10; % default value
    end

    Here, I did not hard-code the order and number of input arguments. If I ever want to introduce an additional input C before D, like

    function bla(A,B,C,D)

    I do not have to change anything (except the function calls of course). I think both alternatives have their pros and cons.

    Regards
    Markus

  3. Doug replied on :

    Justin,

    You can use num2str to make a number into text. You can have a function output be string if that is what you want.

    Doug

  4. Luca Balbi replied on :

    Hello Doug, great work as always!

    I think that the recent introduction of the inputParser object has made things evolve a bit with respect to the nargin approach.
    Have you ever thought about creating a video with a demo of inputParser?

  5. dylan replied on :

    i followed your code exactly and i get the following error:
    >> main(1)
    ??? Undefined function or method ‘mtimes’ for input arguments of type ‘cell’.

    Error in ==> main at 19
    out=alpha * beta;

  6. Jiro replied on :

    dylan,

    Make sure you are using (curly) braces and not parentheses:

    alpha = varargin{1}

    “varargin” is a cell array, so you need to use braces to get the contents of each element. Parentheses will only give you back the element as a cell.

Leave a Reply

Wrap code fragments inside <pre> tags, like this:

<pre class="code">
a = magic(3);
sum(a)
</pre>

If you have a "<" character in your code, either follow it with a space or replace it with "&lt;" (including the semicolon).


MathWorks

Doug Hull is a proud MathWorker who is on a mission to help you with MATLAB.

Doug's picture

These postings are the author's and don't necessarily represent the opinions of MathWorks.