summaryrefslogtreecommitdiffstats
path: root/README
blob: d770ad1ba5124b8e972f5f71dcad23fe09264c62 (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
=head1 Math::Decimal::FastPP

Math::Decimal::FastPP provides a few common decimal arithmetic and
rounding functions written in pure Perl.  The functions are of course
slower than Perl's built-in binary floating-point math, but they're
faster than L<Math::BigFloat|Math::BigFloat> and other commonly used
decimal math modules.

This module is currently less complete than Perl's built-in math and
other decimal math modules.  So far it only includes addition,
multiplication, two rounding functions, and one formatting function.

Despite the similar name and purpose, this module is not compatible with
L<Math::Decimal|Math::Decimal>.

=head2 INSTALLATION

To install this module, run the following commands:

    perl Makefile.PL
    make
    make test
    make install

=head2 DOCUMENTATION

Documentation for this module is embedded within it and can be formatted
with perldoc:

    perldoc lib/Math/Decimal/FastPP.pm

After installing, you can refer to the module by name instead of by file
path:

    perldoc Math::Decimal::FastPP

=head2 COPYRIGHT

Copyright (C) 2017  Libiquity LLC

=head2 LICENSE

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see L<http://www.gnu.org/licenses/>.