Matlab Unused input notation details

Question

Matlab R2009b introduced a new "operator" - ~ - to symbolize an unused function output or input. I have detailed question about that implementation. (Calling all @Loren s.)

What does the function see for the value of an unused input parameter?

i.e. if my function is defined as

myfunc(argOne, argTwo, argThree)

and it’s called like this:

myfunc('arg', ~, 'arg')

Is nargin 2, or 3? Is argTwo undefined or empty or something else?

Thanks

Answer 1

The ~ syntax is only applicable to the inputs of the function definition, not the inputs of the function call (as discussed on this documentation page). In other words, this is OK:

function myfunc(argOne, ~, argThree)  %# Will do nothing with the second input
  %# Do stuff here
end

but this is not:

myfunc('arg', ~, 'arg');  %# Error city ;)

So, when calling a function, you can only use ~ on the left-hand side:

[~, I] = sort([2 4 1 2 5 3]);  %# Sort the vector and keep only the index