.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Lingua::EN::Numbers::Ordinate 3pm"
.TH Lingua::EN::Numbers::Ordinate 3pm "2021-03-25" "perl v5.32.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Lingua::EN::Numbers::Ordinate \-\- go from cardinal number (3) to ordinal ("3rd")
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 5
\&  use Lingua::EN::Numbers::Ordinate;
\&  print ordinate(4), "\en";
\&   # prints 4th
\&  print ordinate(\-342), "\en";
\&   # 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!\en"; 
\&      next;
\&    }
\&    ...
\&  }
.Ve
.SH "DESCRIPTION"
.IX Header "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.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.IP "ordinate(\s-1SCALAR\s0)" 4
.IX Item "ordinate(SCALAR)"
Returns a string consisting of that scalar's string form, plus the
appropriate ordinal suffix.  Example: \f(CW\*(C`ordinate(23)\*(C'\fR returns \*(L"23rd\*(R".
.Sp
As a special case, \f(CW\*(C`ordinate(undef)\*(C'\fR and \f(CW\*(C`ordinate("")\*(C'\fR return \*(L"0th\*(R",
not \*(L"th\*(R".
.Sp
This function is exported by default.
.IP "th(\s-1SCALAR\s0)" 4
.IX Item "th(SCALAR)"
Merely an alias for \f(CW\*(C`ordinate\*(C'\fR, but not exported by default.
.IP "ordsuf(\s-1SCALAR\s0)" 4
.IX Item "ordsuf(SCALAR)"
Returns just the appropriate ordinal suffix for the given scalar
numeric value.  This is what \f(CW\*(C`ordinate\*(C'\fR uses to actually do its
work.  For example, \f(CWordsuf(3)\fR is \*(L"rd\*(R".
.Sp
Not exported by default.
.PP
The above functions are all prototyped to take a scalar value,
so \f(CW\*(C`ordinate(@stuff)\*(C'\fR is the same as \f(CW\*(C`ordinate(scalar @stuff)\*(C'\fR.
.SH "CAVEATS"
.IX Header "CAVEATS"
* Note that this library knows only about numbers, not number-words.
\&\f(CW\*(C`ordinate(\*(Aqseven\*(Aq)\*(C'\fR might just as well be \f(CW\*(C`ordinate(\*(Aqsuperglue\*(Aq)\*(C'\fR
or \f(CW\*(C`ordinate("\ex1E\ex9A")\*(C'\fR \*(-- you'll get the fallthru case of the input
string plus \*(L"th\*(R".
.PP
* As is unavoidable, \f(CW\*(C`ordinate(0256)\*(C'\fR returns \*(L"174th\*(R" (because ordinate
sees the value 174). Similarly, \f(CW\*(C`ordinate(1E12)\*(C'\fR returns
\&\*(L"1000000000000th\*(R".  Returning \*(L"trillionth\*(R" would be nice, but that's an
awfully atypical case.
.PP
* Note that this library's algorithm (as well as the basic concept
and implementation of ordinal numbers) is totally language specific.
.PP
To pick a trivial example, consider that in French, 1 ordinates
as \*(L"1ier\*(R", whereas 41 ordinates as \*(L"41ieme\*(R".
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Lingua::EN::Inflect provides an \f(CW\*(C`ORD\*(C'\fR function,
which returns the ordinal form of a cardinal number.
.PP
Lingua::EN::Number::IsOrdinal provides an \f(CW\*(C`is_ordinal\*(C'\fR
function, which returns true if passed an ordinal number.
.PP
Lingua::EN::Numbers provides function \f(CW\*(C`num2en_ordinal()\*(C'\fR
which will take a number and return the ordinal as a word.
So 3 will result in \*(L"third\*(R".
.SH "REPOSITORY"
.IX Header "REPOSITORY"
<https://github.com/neilb/Lingua\-EN\-Numbers\-Ordinate>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2000 Sean M. Burke.  All rights reserved.
.PP
This library is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
.SH "AUTHOR"
.IX Header "AUTHOR"
Sean M. Burke \f(CW\*(C`sburke@cpan.org\*(C'\fR
.PP
This has been maintained by Neil Bowers (\s-1NEILB\s0)
since 2014.