Taiki Kawakami > Test-LimitDecimalPlaces-0.01 > Test::LimitDecimalPlaces

Download:
Test-LimitDecimalPlaces-0.01.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.01   Source  

NAME ^

Test::LimitDecimalPlaces - Compare numerical values by limiting number of decimal places

VERSION ^

This document describes Test::LimitDecimalPlaces version 0.01

SYNOPSIS ^

    use Test::LimitDecimalPlaces tests => 5; # Can specify the test plan.

    # Equality test by default number of decimal places
    limit_ok(1.2345678, 1.2345678, 'Test the same floating-point values.');

    # Inequality test by default number of decimal places
    limit_not_ok( 0.0000001, 0.0000002, 'Test different values' );

    # Equality test by specified number of decimal places
    limit_ok_by(0.00000001, 0.000000006, 8, 'Test similar value.') ."\n"; # number of decimal places is 8

    # Inequality test by specified number of decimal places
    limit_not_ok_by( 0.00000001, 0.00000002, 8, 'Test different values.' ); # number of decimal places is 8

    # Compare arrays
    my @x = ( 0, 1, 0.1, 0.0000001, 0.0000001 );
    my @y = ( 0, 1, 0.1, 0.0000001, 0.00000006 );
    limit_ok(\@x, \@y, 'Compare arrays.');

    # Set a different default number of decimal places
    use Test::LimitDecimalPlaces num_of_digits => 6, tests => 1;
    limit_ok(1.234567, 1.234566, 'Test the similar floating-point values.');

DESCRIPTION ^

If compare floating point numbers normally, we cannot get the correct result on some environment. This module was made to solve this problem.

This module provides test functions that can compare numerical values by limiting number of decimal places. These functions are using splintf() internally to limit number of decimal places.

USAGE ^

use Test::LimitDecimalPlaces;

Use with no args, then number of decimal places to limit defaults 7.

use Test::LimitDecimalPlaces num_of_digits => 6;

Use with argument of 'num_of_digits', then default number of decimal places to limit is set specified number.

This parameter must be a number greater than or equal to zero.

With test plan

This module can specify test plan. Like so:

    use Test::LimitDecimalPlaces tests => 1;

And this module can specify own options with test plan. Like so:

    use Test::LimitDecimalPlaces num_of_digits => 6, tests => 1;

Test::LimitDecimalPlaces-specific option must come first.

FUNCTIONS ^

limit_ok

limit_ok($x, $y, 'Description of test');

limit_ok(\@x, \@y, 'Description of test');

This function compares and check equality between given values by limiting default number of decimal places.

limit_ok_by

limit_ok_by($x, $y, $num_of_digits, 'Description of test');

limit_ok_by(\@x, \@y, $num_of_digits, 'Description of test');

Action of this function is almost the same as limit_ok().

But this function uses specified number of decimal places ($num_of_digits in case of the above instance).

limit_not_ok

limit_not_ok($x, $y, 'Description of test');

limit_not_ok(\@x, \@y, 'Description of test');

This function compares and check inequality between given values by limiting default number of decimal places.

limit_not_ok_by

limit_not_ok_by($x, $y, $num_of_digits, 'Description of test');

limit_not_ok_by(\@x, \@y, $num_of_digits, 'Description of test');

Action of this function is almost the same as limit_not_ok().

But this function uses specified number of decimal places ($num_of_digits in case of the above instance).

CONFIGURATION AND ENVIRONMENT ^

Test::LimitDecimalPlaces requires no configuration files or environment variables.

DEPENDENCIES ^

Test::Exception (version 0.31 or later)

INCOMPATIBILITIES ^

None reported.

BUGS AND LIMITATIONS ^

No bugs have been reported.

Please report any bugs or feature requests to bug-test-limitdecimalplaces@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR ^

moznion <moznion@gmail.com>

LICENCE AND COPYRIGHT ^

Copyright (c) 2012, moznion <moznion@gmail.com>. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY ^

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

syntax highlighting: