.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "DateTime::Infinite 3pm"
.TH DateTime::Infinite 3pm 2024-02-24 "perl v5.38.2" "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
DateTime::Infinite \- Infinite past and future DateTime objects
.SH VERSION
.IX Header "VERSION"
version 1.65
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&  my $future = DateTime::Infinite::Future\->new;
\&  my $past   = DateTime::Infinite::Past\->new;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module provides two DateTime subclasses, \f(CW\*(C`DateTime::Infinite::Future\*(C'\fR
and \f(CW\*(C`DateTime::Infinite::Past\*(C'\fR.
.PP
The objects are always in the "floating" timezone, and this cannot be changed.
.SH METHODS
.IX Header "METHODS"
The only constructor for these two classes is the \f(CW\*(C`new\*(C'\fR method, as shown in
the "SYNOPSIS". This method takes no parameters.
.PP
All "get" methods in this module simply return infinity, positive or negative.
If the method is expected to return a string, it returns the string
representation of positive or negative infinity used by your system. For
example, on my system calling \f(CW\*(C`$dt\->year\*(C'\fR> returns a number which when
printed appears either "Inf" or "\-Inf".
.PP
This also applies to methods that are compound stringifications, which return
the same strings even for things like \f(CW\*(C`$dt\->ymd\*(C'\fR or \f(CW\*(C`$dt\->iso8601\*(C'\fR
.PP
The object is not mutable, so the \f(CW\*(C`$dt\->set\*(C'\fR, \f(CW\*(C`$dt\->set_time_zone\*(C'\fR,
and \f(CW\*(C`$dt\->truncate\*(C'\fR methods are all do-nothing methods that simply return
the object they are called with.
.PP
Obviously, the \f(CW\*(C`$dt\->is_finite\*(C'\fR method returns false and the \f(CW\*(C`$dt\->is_infinite\*(C'\fR method returns true.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
datetime@perl.org mailing list
.SH BUGS
.IX Header "BUGS"
There seem to be lots of problems when dealing with infinite numbers on Win32.
This may be a problem with this code, Perl, or Win32's IEEE math
implementation. Either way, the module may not be well-behaved on Win32
operating systems.
.PP
Bugs may be submitted at <https://github.com/houseabsolute/DateTime.pm/issues>.
.PP
There is a mailing list available for users of this distribution,
<mailto:datetime@perl.org>.
.SH SOURCE
.IX Header "SOURCE"
The source code repository for DateTime can be found at <https://github.com/houseabsolute/DateTime.pm>.
.SH AUTHOR
.IX Header "AUTHOR"
Dave Rolsky <autarch@urth.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2003 \- 2023 by Dave Rolsky.
.PP
This is free software, licensed under:
.PP
.Vb 1
\&  The Artistic License 2.0 (GPL Compatible)
.Ve
.PP
The full text of the license can be found in the
\&\fILICENSE\fR file included with this distribution.