num2direction.m

Go to the documentation of this file.

% =========================================================================== %
%> @brief convert a number to a direction
%>
%> @param num number to convert
%>
%> @retval dir direction (positive, negative)
%>
%> @code
%> dir = num2direction(1) % returns "positive"
%> dir = num2direction(-1) % returns "negative"
%> @endcode
%>
%> @copyright see the file @ref LICENSE in the root directory of the repository
% =========================================================================== %
function dir = num2direction(num)
 
arguments
    num (1,1) double
end
 
num = round(num);
 
if num > 0
    dir = "positive";
elseif num < 0
    dir = "negative";
else
    error("The number %d does not correspond to a direction", num)
end
 
end