Commit | Line | Data |
---|---|---|
86530b38 AT |
1 | .\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13 |
2 | .\" | |
3 | .\" Standard preamble: | |
4 | .\" ======================================================================== | |
5 | .de Sh \" Subsection heading | |
6 | .br | |
7 | .if t .Sp | |
8 | .ne 5 | |
9 | .PP | |
10 | \fB\\$1\fR | |
11 | .PP | |
12 | .. | |
13 | .de Sp \" Vertical space (when we can't use .PP) | |
14 | .if t .sp .5v | |
15 | .if n .sp | |
16 | .. | |
17 | .de Vb \" Begin verbatim text | |
18 | .ft CW | |
19 | .nf | |
20 | .ne \\$1 | |
21 | .. | |
22 | .de Ve \" End verbatim text | |
23 | .ft R | |
24 | .fi | |
25 | .. | |
26 | .\" Set up some character translations and predefined strings. \*(-- will | |
27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left | |
28 | .\" double quote, and \*(R" will give a right double quote. | will give a | |
29 | .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to | |
30 | .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' | |
31 | .\" expand to `' in nroff, nothing in troff, for use with C<>. | |
32 | .tr \(*W-|\(bv\*(Tr | |
33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' | |
34 | .ie n \{\ | |
35 | . ds -- \(*W- | |
36 | . ds PI pi | |
37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch | |
38 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch | |
39 | . ds L" "" | |
40 | . ds R" "" | |
41 | . ds C` "" | |
42 | . ds C' "" | |
43 | 'br\} | |
44 | .el\{\ | |
45 | . ds -- \|\(em\| | |
46 | . ds PI \(*p | |
47 | . ds L" `` | |
48 | . ds R" '' | |
49 | 'br\} | |
50 | .\" | |
51 | .\" If the F register is turned on, we'll generate index entries on stderr for | |
52 | .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index | |
53 | .\" entries marked with X<> in POD. Of course, you'll have to process the | |
54 | .\" output yourself in some meaningful fashion. | |
55 | .if \nF \{\ | |
56 | . de IX | |
57 | . tm Index:\\$1\t\\n%\t"\\$2" | |
58 | .. | |
59 | . nr % 0 | |
60 | . rr F | |
61 | .\} | |
62 | .\" | |
63 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes | |
64 | .\" way too many mistakes in technical documents. | |
65 | .hy 0 | |
66 | .if n .na | |
67 | .\" | |
68 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). | |
69 | .\" Fear. Run. Save yourself. No user-serviceable parts. | |
70 | . \" fudge factors for nroff and troff | |
71 | .if n \{\ | |
72 | . ds #H 0 | |
73 | . ds #V .8m | |
74 | . ds #F .3m | |
75 | . ds #[ \f1 | |
76 | . ds #] \fP | |
77 | .\} | |
78 | .if t \{\ | |
79 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) | |
80 | . ds #V .6m | |
81 | . ds #F 0 | |
82 | . ds #[ \& | |
83 | . ds #] \& | |
84 | .\} | |
85 | . \" simple accents for nroff and troff | |
86 | .if n \{\ | |
87 | . ds ' \& | |
88 | . ds ` \& | |
89 | . ds ^ \& | |
90 | . ds , \& | |
91 | . ds ~ ~ | |
92 | . ds / | |
93 | .\} | |
94 | .if t \{\ | |
95 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" | |
96 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' | |
97 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' | |
98 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' | |
99 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' | |
100 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' | |
101 | .\} | |
102 | . \" troff and (daisy-wheel) nroff accents | |
103 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' | |
104 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' | |
105 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] | |
106 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' | |
107 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' | |
108 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] | |
109 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] | |
110 | .ds ae a\h'-(\w'a'u*4/10)'e | |
111 | .ds Ae A\h'-(\w'A'u*4/10)'E | |
112 | . \" corrections for vroff | |
113 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' | |
114 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' | |
115 | . \" for low resolution devices (crt and lpr) | |
116 | .if \n(.H>23 .if \n(.V>19 \ | |
117 | \{\ | |
118 | . ds : e | |
119 | . ds 8 ss | |
120 | . ds o a | |
121 | . ds d- d\h'-1'\(ga | |
122 | . ds D- D\h'-1'\(hy | |
123 | . ds th \o'bp' | |
124 | . ds Th \o'LP' | |
125 | . ds ae ae | |
126 | . ds Ae AE | |
127 | .\} | |
128 | .rm #[ #] #H #V #F C | |
129 | .\" ======================================================================== | |
130 | .\" | |
131 | .IX Title "Ordinate 3" | |
132 | .TH Ordinate 3 "2000-08-24" "perl v5.8.0" "User Contributed Perl Documentation" | |
133 | .SH "NAME" | |
134 | Lingua::EN::Numbers::Ordinate \-\- go from cardinal number (3) to ordinal ("3rd") | |
135 | .SH "SYNOPSIS" | |
136 | .IX Header "SYNOPSIS" | |
137 | .Vb 5 | |
138 | \& use Lingua::EN::Numbers::Ordinate; | |
139 | \& print ordinate(4), "\en"; | |
140 | \& # prints 4th | |
141 | \& print ordinate(-342), "\en"; | |
142 | \& # prints -342nd | |
143 | .Ve | |
144 | .PP | |
145 | .Vb 9 | |
146 | \& # Example of actual use: | |
147 | \& ... | |
148 | \& for(my $i = 0; $i < @records; $i++) { | |
149 | \& unless(is_valid($record[$i]) { | |
150 | \& warn "The ", ordinate($i), " record is invalid!\en"; | |
151 | \& next; | |
152 | \& } | |
153 | \& ... | |
154 | \& } | |
155 | .Ve | |
156 | .SH "DESCRIPTION" | |
157 | .IX Header "DESCRIPTION" | |
158 | There are two kinds of numbers in English \*(-- cardinals (1, 2, 3...), and | |
159 | ordinals (1st, 2nd, 3rd...). This library provides functions for giving | |
160 | the ordinal form of a number, given its cardinal value. | |
161 | .SH "FUNCTIONS" | |
162 | .IX Header "FUNCTIONS" | |
163 | .IP "ordinate(\s-1SCALAR\s0)" 4 | |
164 | .IX Item "ordinate(SCALAR)" | |
165 | Returns a string consisting of that scalar's string form, plus the | |
166 | appropriate ordinal suffix. Example: \f(CW\*(C`ordinate(23)\*(C'\fR returns \*(L"23rd\*(R". | |
167 | .Sp | |
168 | As a special case, \f(CW\*(C`ordinate(undef)\*(C'\fR and \f(CW\*(C`ordinate("")\*(C'\fR return \*(L"0th\*(R", | |
169 | not \*(L"th\*(R". | |
170 | .Sp | |
171 | This function is exported by default. | |
172 | .IP "th(\s-1SCALAR\s0)" 4 | |
173 | .IX Item "th(SCALAR)" | |
174 | Merely an alias for \f(CW\*(C`ordinate\*(C'\fR, but not exported by default. | |
175 | .IP "ordsuf(\s-1SCALAR\s0)" 4 | |
176 | .IX Item "ordsuf(SCALAR)" | |
177 | Returns just the appropriate ordinal suffix for the given scalar | |
178 | numeric value. This is what \f(CW\*(C`ordinate\*(C'\fR uses to actually do its | |
179 | work. For example, \f(CWordsuf(3)\fR is \*(L"rd\*(R". | |
180 | .Sp | |
181 | Not exported by default. | |
182 | .PP | |
183 | The above functions are all prototyped to take a scalar value, | |
184 | so \f(CW\*(C`ordinate(@stuff)\*(C'\fR is the same as \f(CW\*(C`ordinate(scalar @stuff)\*(C'\fR. | |
185 | .SH "CAVEATS" | |
186 | .IX Header "CAVEATS" | |
187 | * Note that this library knows only about numbers, not number\-words. | |
188 | \&\f(CW\*(C`ordinate('seven')\*(C'\fR might just as well be \f(CW\*(C`ordinate('superglue')\*(C'\fR | |
189 | or \f(CW\*(C`ordinate("\ex1E\ex9A")\*(C'\fR \*(-- you'll get the fallthru case of the input | |
190 | string plus \*(L"th\*(R". | |
191 | .PP | |
192 | * As is unavoidable, \f(CW\*(C`ordinate(0256)\*(C'\fR returns \*(L"174th\*(R" (because ordinate | |
193 | sees the value 174). Similarly, \f(CW\*(C`ordinate(1E12)\*(C'\fR returns | |
194 | \&\*(L"1000000000000th\*(R". Returning \*(L"trillionth\*(R" would be nice, but that's an | |
195 | awfully atypical case. | |
196 | .PP | |
197 | * Note that this library's algorithm (as well as the basic concept | |
198 | and implementation of ordinal numbers) is totally language specific. | |
199 | .PP | |
200 | To pick a trivial example, consider that in French, 1 ordinates | |
201 | as \*(L"1ier\*(R", whereas 41 ordinates as \*(L"41ieme\*(R". | |
202 | .SH "STILL NOT SATISFIED?" | |
203 | .IX Header "STILL NOT SATISFIED?" | |
204 | Bored of this...? | |
205 | .PP | |
206 | .Vb 4 | |
207 | \& use Lingua::EN::Numbers::Ordinate qw(ordinate th); | |
208 | \& ... | |
209 | \& print th($n), " entry processed...\en"; | |
210 | \& ... | |
211 | .Ve | |
212 | .PP | |
213 | Try this bit of lunacy: | |
214 | .PP | |
215 | .Vb 3 | |
216 | \& { | |
217 | \& my $th_object; | |
218 | \& sub _th () { $th_object } | |
219 | .Ve | |
220 | .PP | |
221 | .Vb 11 | |
222 | \& package Lingua::EN::Numbers::Ordinate::Overloader; | |
223 | \& my $x; # Gotta have something to bless. | |
224 | \& $th_object = bless \e$x; # Define the object now, which _th returns | |
225 | \& use Carp (); | |
226 | \& use Lingua::EN::Numbers::Ordinate (); | |
227 | \& sub overordinate { | |
228 | \& Carp::croak "_th should be used only as postfix!" unless $_[2]; | |
229 | \& Lingua::EN::Numbers::Ordinate::ordinate($_[1]); | |
230 | \& } | |
231 | \& use overload '&' => \e&overordinate; | |
232 | \& } | |
233 | .Ve | |
234 | .PP | |
235 | Then you get to do: | |
236 | .PP | |
237 | .Vb 2 | |
238 | \& print 3 & _th, "\en"; | |
239 | \& # prints "3rd" | |
240 | .Ve | |
241 | .PP | |
242 | .Vb 3 | |
243 | \& print 1 + 2 & _th, "\en"; | |
244 | \& # prints "3rd" too! | |
245 | \& # Because of the precedence of & ! | |
246 | .Ve | |
247 | .PP | |
248 | .Vb 2 | |
249 | \& print _th & 3, "\en"; | |
250 | \& # dies with: "th should be used only as postfix!" | |
251 | .Ve | |
252 | .PP | |
253 | Kooky, isn't it? For more delightful deleria like this, see | |
254 | Damian Conway's \fIObject Oriented Perl\fR from Manning Press. | |
255 | .PP | |
256 | Kinda makes you like \f(CWth(3)\fR, doesn't it? | |
257 | .SH "COPYRIGHT" | |
258 | .IX Header "COPYRIGHT" | |
259 | Copyright (c) 2000 Sean M. Burke. All rights reserved. | |
260 | .PP | |
261 | This library is free software; you can redistribute it and/or | |
262 | modify it under the same terms as Perl itself. | |
263 | .SH "AUTHOR" | |
264 | .IX Header "AUTHOR" | |
265 | Sean M. Burke \f(CW\*(C`sburke@cpan.org\*(C'\fR |