direction2num.m

Go to the documentation of this file.

% =========================================================================== %
%> @brief convert a direction to a number
%>
%> @param dir direction to convert (positive, negative)
%>
%> @retval num number
%>
%> @code
%> num = direction2num("positive") % returns 1
%> num = direction2num("negative") % returns -1
%> @endcode
%>
%> %> @copyright see the file @ref LICENSE in the root directory of the repository
% =========================================================================== %
function num = direction2num(dir)
 
arguments
    dir (1,1) string
end
 
switch dir
    case "positive"
        num = 1;
    case "negative"
        num = -1;
    otherwise
        error("The direction %s does not correspond to a number", dir)
end
 
end