1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
package Lingua::EN::Numbers::Ordinate;
$Lingua::EN::Numbers::Ordinate::VERSION = '1.05';
# ABSTRACT: go from cardinal number (3) to ordinal ("3rd")
use 5.006;
use strict;
use warnings;
require Exporter;
our @ISA = qw/ Exporter /;
our @EXPORT = qw/ ordinate /;
our @EXPORT_OK = qw/ ordsuf th /;
###########################################################################
=head1 NAME
Lingua::EN::Numbers::Ordinate -- go from cardinal number (3) to ordinal ("3rd")
=head1 SYNOPSIS
use Lingua::EN::Numbers::Ordinate;
print ordinate(4), "\n";
# prints 4th
print ordinate(-342), "\n";
# prints -342nd
# Example of actual use:
...
for(my $i = 0; $i < @records; $i++) {
unless(is_valid($record[$i]) {
warn "The ", ordinate($i), " record is invalid!\n";
next;
}
...
}
=head1 DESCRIPTION
There are two kinds of numbers in English -- cardinals (1, 2, 3...), and
ordinals (1st, 2nd, 3rd...). This library provides functions for giving
the ordinal form of a number, given its cardinal value.
=head1 FUNCTIONS
=over
=item ordinate(SCALAR)
Returns a string consisting of that scalar's string form, plus the
appropriate ordinal suffix. Example: C<ordinate(23)> returns "23rd".
As a special case, C<ordinate(undef)> and C<ordinate("")> return "0th",
not "th".
This function is exported by default.
=item th(SCALAR)
Merely an alias for C<ordinate>, but not exported by default.
=item ordsuf(SCALAR)
Returns just the appropriate ordinal suffix for the given scalar
numeric value. This is what C<ordinate> uses to actually do its
work. For example, C<ordsuf(3)> is "rd".
Not exported by default.
=back
The above functions are all prototyped to take a scalar value,
so C<ordinate(@stuff)> is the same as C<ordinate(scalar @stuff)>.
=head1 CAVEATS
* Note that this library knows only about numbers, not number-words.
C<ordinate('seven')> might just as well be C<ordinate('superglue')>
or C<ordinate("\x1E\x9A")> -- you'll get the fallthru case of the input
string plus "th".
* As is unavoidable, C<ordinate(0256)> returns "174th" (because ordinate
sees the value 174). Similarly, C<ordinate(1E12)> returns
"1000000000000th". Returning "trillionth" would be nice, but that's an
awfully atypical case.
* Note that this library's algorithm (as well as the basic concept
and implementation of ordinal numbers) is totally language specific.
To pick a trivial example, consider that in French, 1 ordinates
as "1ier", whereas 41 ordinates as "41ieme".
=head1 SEE ALSO
L<Lingua::EN::Inflect> provides an C<ORD> function,
which returns the ordinal form of a cardinal number.
L<Lingua::EN::Number::IsOrdinal> provides an C<is_ordinal>
function, which returns true if passed an ordinal number.
L<Lingua::EN::Numbers> provides function C<num2en_ordinal()>
which will take a number and return the ordinal as a word.
So 3 will result in "third".
=head1 REPOSITORY
L<https://github.com/neilb/Lingua-EN-Numbers-Ordinate>
=head1 COPYRIGHT
Copyright (c) 2000 Sean M. Burke. All rights reserved.
This library is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
=head1 AUTHOR
Sean M. Burke C<sburke@cpan.org>
This has been maintained by Neil Bowers (NEILB)
since 2014.
=cut
###########################################################################
sub ordsuf ($) {
return 'th' if not(defined($_[0])) or $_[0] !~ /^-?[0-9]+$/;
# 'th' for undef, 0, or anything non-number.
my $n = abs($_[0]); # Throw away the sign.
$n %= 100;
return 'th' if $n == 11 or $n == 12 or $n == 13;
$n %= 10;
return 'st' if $n == 1;
return 'nd' if $n == 2;
return 'rd' if $n == 3;
return 'th';
}
sub ordinate ($) {
my $i = $_[0] || 0;
return $i . ordsuf($i);
}
no warnings 'all';
*th = \&ordinate; # correctly copies the prototype, too.
###########################################################################
1;
__END__
|
