Code covered by the BSD License  

Highlights from
Numeric to Ordinal-String

image thumbnail

Numeric to Ordinal-String

by

 

25 Jul 2013 (Updated )

Convert numeric values to a character array of integers with ordinal suffixes (numeric -> string).

num2ordinal(num,sel)
function chr = num2ordinal(num,sel)
% Convert a numeric array to a character array of integers and ordinal suffixes (string).
%
% (c) 2014 Stephen Cobeldick
%
% Convert a numeric scalar/vector/matrix/array to a character array giving the
% ordinal integers and suffixes of the input element values, eg. 1 -> '1st'.
%
% Syntax:
% chr = num2ordinal(nun)
% chr = num2ordinal(num,sel)
%
% The code is fully vectorized (ie. no loops or "arrayfun" calls are used
% or required), and rounds any fractional values to the nearest integers.
% It provides the correct suffixes for values ending in 11, 12 or 13.
%
% See also SPRINTF INT2STR MAT2STR NUM2STR NUM2CELL BINUM BIPRE SINUM SIPRE CELLSTR STRTRIM STRCAT ISREAL INTMAX
%
% ### Examples ###
%
% num2ordinal(1)
%  ans = '1st'
%
% num2ordinal(1:6)
%  ans = ['1st';'2nd';'3rd';'4th';'5th';'6th']
%
% num2ordinal([1,11,111,1111])
%  ans = ['   1st';'  11th';' 111th';'1111th']
%
% num2ordinal(100:113,false)
%  ans = ['th';'st';'nd';'rd';'th';'th';'th';'th';'th';'th';'th';'th';'th';'th']
%
% num2ordinal(intmax('int64')-4)
%  ans = '9223372036854775803rd'
%
% num2ordinal([-0,0])
%  ans = ['-0th';' 0th']
%
% vals = [-1,-0,0;-Inf,NaN,Inf];
% reshape(strtrim(cellstr(num2ordinal(vals))),size(vals))
%  ans = {'-1th','-0th','0th';'-Infth','NaNth','Infth'}
%
% ### Input & Output Arguments ###
%
% Inputs (*=default):
% num = NumericArray (any size), with values to convert to string.
% sel = LogicalScalar, *true/false -> integer & suffix / suffix only.
%
% Output:
% chr = CharArray, integers & ordinal suffixes of the rounded <num> values,
%       rows are linear indexed from <num> and cols fit the largest value.
%
% chr = num2ordinal(num,*sel)

typ = class(num);
switch typ(1:3)
    case {'dou','sin'}
        assert(isreal(num),'First input <num> must be a real numeric.')
        fmt = '.0f';
    case 'uin'
        fmt = 'lu';
    case 'int'
        fmt = 'ld';
    otherwise
        error('First input <num> must be a numeric scalar/vector/matrix/array.')
end
num = num(:);
%
% Convert from number to character array plus 'th' suffix:
if isempty(num)
    % Empty numeric.
    chr = '';
    return
    %
elseif nargin>1&&~sel
    % Return suffixes only.
    len = 2;
    chr(1:numel(num),2) = 'h';
    chr(:,1) = 't';
    %
elseif isscalar(num)
    % Numeric scalar.
    chr = sprintf(['%',fmt,'th'], num);
    len = numel(chr);
    %
else
    % Numeric matrix.
    % Calculate the number of digits required:
    len = 1 + max(0, floor(log10(double(abs(num)))));
    len(~isfinite(num)) = 3;
    len = 2 + max(len + (num<0 | 1./num<0));
    % Convert from numeric to character:
    fmt = sprintf('%%%.0f%sth', len-2, fmt);
    chr = reshape(sprintf(fmt, num), len, []).';
    %
end
%
% Determine the correct ordinal suffixes:
rm = rem(num,100);
th = 10.5<=rm & rm<13.5;
rm = rem(num,10);
st = ~th & 0.5<=rm & rm<1.5;
nd = ~th & 1.5<=rm & rm<2.5;
rd = ~th & 2.5<=rm & rm<3.5;
%
% Replace 'th' suffixes with the correct suffixes:
lem = len-1;
chr(st,lem) = 's';
chr(st,len) = 't';
chr(nd,lem) = 'n';
chr(nd,len) = 'd';
chr(rd,lem) = 'r';
chr(rd,len) = 'd';
%
end
%----------------------------------------------------------------------END:num2ordinal

Contact us