.\" -*- 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 "Math::BigInt::GMP 3pm"
.TH Math::BigInt::GMP 3pm 2024-03-07 "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
Math::BigInt::GMP \- backend library for Math::BigInt etc. based on GMP
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&    # to use it with Math::BigInt
\&    use Math::BigInt lib => \*(AqGMP\*(Aq;
\&
\&    # to use it with Math::BigFloat
\&    use Math::BigFloat lib => \*(AqGMP\*(Aq;
\&
\&    # to use it with Math::BigRat
\&    use Math::BigRat lib => \*(AqGMP\*(Aq;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Math::BigInt::GMP is a backend library for Math::BigInt, Math::BigFloat,
Math::BigRat and related modules.
.PP
Math::BigInt::GMP provides support for big integer calculations by means of the
GMP C library. See <https://gmplib.org/> for more information about the GMP
library.
.PP
Math::BigInt::GMP no longer uses Math::GMP, but provides its own XS layer to
access the GMP C library. This cuts out another (Perl subroutine) layer and
also reduces the memory footprint.
.PP
Math::BigInt::GMP inherits from Math::BigInt::Lib.
.SH "STATIC FUNCTIONS"
.IX Header "STATIC FUNCTIONS"
.ie n .SS "$str = \fBgmp_version()\fP;"
.el .SS "\f(CW$str\fP = \fBgmp_version()\fP;"
.IX Subsection "$str = gmp_version();"
Returns the underlying GMP library's version as a string, e.g., \f(CW6.2.1\fR.
.SH BUGS
.IX Header "BUGS"
Please report any bugs or feature requests to
\&\f(CW\*(C`bug\-math\-bigint\-gmp at rt.cpan.org\*(C'\fR, or through the web interface at
<https://rt.cpan.org/Ticket/Create.html?Queue=Math\-BigInt\-GMP>
(requires login). We will be notified, and then you'll automatically be
notified of progress on your bug as I make changes.
.SH SUPPORT
.IX Header "SUPPORT"
After installing, you can find documentation for this module with the perldoc
command.
.PP
.Vb 1
\&    perldoc Math::BigInt::GMP
.Ve
.PP
You can also look for information at:
.IP GitHub 4
.IX Item "GitHub"
<https://github.com/pjacklam/p5\-Math\-BigInt\-GMP>
.IP "RT: CPAN's request tracker" 4
.IX Item "RT: CPAN's request tracker"
<https://rt.cpan.org/Dist/Display.html?Name=Math\-BigInt\-GMP>
.IP MetaCPAN 4
.IX Item "MetaCPAN"
<https://metacpan.org/release/Math\-BigInt\-GMP>
.IP "CPAN Testers Matrix" 4
.IX Item "CPAN Testers Matrix"
<http://matrix.cpantesters.org/?dist=Math\-BigInt\-GMP>
.SH LICENSE
.IX Header "LICENSE"
This program is free software; you may redistribute it and/or modify it under
the same terms as Perl itself.
.SH AUTHORS
.IX Header "AUTHORS"
Tels <http://bloodgate.com/> in 2001\-2007.
.PP
Thanks to Chip Turner (CHIPT on CPAN) for providing Math::GMP, which was
inspiring my work.
.PP
Maintained by Peter John Acklam <pjacklam@gmail.com> 2010\-2021.
.PP
\&\fBgmp_version()\fR provided by FGasper on GitHub.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Math::BigInt::Lib for a description of the API.
.PP
Alternative libraries Math::BigInt::Calc, Math::BigInt::FastCalc, and
Math::BigInt::Pari.
.PP
Some of the modules that use these libraries Math::BigInt,
Math::BigFloat, and Math::BigRat.