summaryrefslogtreecommitdiff
path: root/README
blob: 7c3c34becd2375ce927533ad8f210f8233feb6f1 (plain)
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
NAME
    Math::BigInt::GMP - backend library for Math::BigInt etc. based on GMP

SYNOPSIS
        # to use it with Math::BigInt
        use Math::BigInt lib => 'GMP';

        # to use it with Math::BigFloat
        use Math::BigFloat lib => 'GMP';

        # to use it with Math::BigRat
        use Math::BigRat lib => 'GMP';

DESCRIPTION
    Math::BigInt::GMP is a backend library for Math::BigInt, Math::BigFloat,
    Math::BigRat and related modules.

    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.

    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.

    Math::BigInt::GMP inherits from Math::BigInt::Lib.

STATIC FUNCTIONS
  $str = gmp_version();
    Returns the underlying GMP library's version as a string, e.g., 6.2.1.

BUGS
    Please report any bugs or feature requests to "bug-math-bigint-gmp at
    rt.cpan.org", 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.

SUPPORT
    After installing, you can find documentation for this module with the
    perldoc command.

        perldoc Math::BigInt::GMP

    You can also look for information at:

    GitHub
        <https://github.com/pjacklam/p5-Math-BigInt-GMP>

    RT: CPAN's request tracker
        <https://rt.cpan.org/Dist/Display.html?Name=Math-BigInt-GMP>

    MetaCPAN
        <https://metacpan.org/release/Math-BigInt-GMP>

    CPAN Testers Matrix
        <http://matrix.cpantesters.org/?dist=Math-BigInt-GMP>

    CPAN Ratings
        <https://cpanratings.perl.org/dist/Math-BigInt-GMP>

LICENSE
    This program is free software; you may redistribute it and/or modify it
    under the same terms as Perl itself.

AUTHORS
    Tels <http://bloodgate.com/> in 2001-2007.

    Thanks to Chip Turner (CHIPT on CPAN) for providing Math::GMP, which was
    inspiring my work.

    Maintained by Peter John Acklam <pjacklam@gmail.com> 2010-2021.

    gmp_version() provided by FGasper on GitHub.

SEE ALSO
    Math::BigInt::Lib for a description of the API.

    Alternative libraries Math::BigInt::Calc, Math::BigInt::FastCalc, and
    Math::BigInt::Pari.

    Some of the modules that use these libraries Math::BigInt,
    Math::BigFloat, and Math::BigRat.