Files
rational/rational_test.cpp

469 lines
14 KiB
C++

/*
* A test program for boost/rational.hpp.
* Change the typedef at the beginning of run_tests() to try out different
* integer types. (These tests are designed only for signed integer
* types. They should work for short, int and long.)
*
* (C) Copyright Stephen Silver, 2001. Permission to copy, use, modify, sell
* and distribute this software is granted provided this copyright notice
* appears in all copies. This software is provided "as is" without express or
* implied warranty, and with no claim as to its suitability for any purpose.
*
* Incorporated into the boost rational number library, and modified and
* extended, by Paul Moore, with permission.
*/
// Revision History
// 24 Dec 05 Change code to use Boost.Test (Daryle Walker)
// 04 Mar 01 Patches for Intel C++ and GCC (David Abrahams)
#define BOOST_TEST_MAIN "Boost::Rational unit tests"
#include <boost/test/unit_test.hpp>
#include <boost/preprocessor/stringize.hpp>
#include "boost/rational.hpp"
#include "boost/operators.hpp"
#include <cstdlib>
#include <iomanip>
#include <iostream>
#include <cstring>
#include <sstream>
// We can override this on the compile, as -DINT_TYPE=short or whatever.
// The default test is against rational<long>.
#ifndef INT_TYPE
#define INT_TYPE long
#endif
namespace {
// This is a trivial user-defined wrapper around the built in int type.
// It can be used as a test type for rational<>
class MyInt : boost::operators<MyInt>
{
int val;
public:
MyInt(int n = 0) : val(n) {}
friend MyInt operator+ (const MyInt&);
friend MyInt operator- (const MyInt&);
MyInt& operator+= (const MyInt& rhs) { val += rhs.val; return *this; }
MyInt& operator-= (const MyInt& rhs) { val -= rhs.val; return *this; }
MyInt& operator*= (const MyInt& rhs) { val *= rhs.val; return *this; }
MyInt& operator/= (const MyInt& rhs) { val /= rhs.val; return *this; }
MyInt& operator%= (const MyInt& rhs) { val %= rhs.val; return *this; }
MyInt& operator|= (const MyInt& rhs) { val |= rhs.val; return *this; }
MyInt& operator&= (const MyInt& rhs) { val &= rhs.val; return *this; }
MyInt& operator^= (const MyInt& rhs) { val ^= rhs.val; return *this; }
const MyInt& operator++() { ++val; return *this; }
const MyInt& operator--() { --val; return *this; }
bool operator< (const MyInt& rhs) const { return val < rhs.val; }
bool operator== (const MyInt& rhs) const { return val == rhs.val; }
bool operator! () const { return !val; }
friend std::istream& operator>>(std::istream&, MyInt&);
friend std::ostream& operator<<(std::ostream&, const MyInt&);
};
inline MyInt operator+(const MyInt& rhs) { return rhs; }
inline MyInt operator-(const MyInt& rhs) { return MyInt(-rhs.val); }
inline std::istream& operator>>(std::istream& is, MyInt& i) { is >> i.val; return is; }
inline std::ostream& operator<<(std::ostream& os, const MyInt& i) { os << i.val; return os; }
inline MyInt abs(MyInt rhs) { if (rhs < MyInt()) rhs = -rhs; return rhs; }
// This fixture replaces the check of rational's packing at the start of main.
class rational_size_check
{
typedef INT_TYPE int_type;
typedef ::boost::rational<int_type> rational_type;
public:
rational_size_check()
{
using ::std::cout;
char const * const int_name = BOOST_PP_STRINGIZE( INT_TYPE );
cout << "Running tests for boost::rational<" << int_name << ">\n\n";
cout << "Implementation issue: the minimal size for a rational\n"
<< "is twice the size of the underlying integer type.\n\n";
cout << "Checking to see if space is being wasted.\n"
<< "\tsizeof(" << int_name << ") == " << sizeof( int_type )
<< "\n";
cout << "\tsizeof(boost::rational<" << int_name << ">) == "
<< sizeof( rational_type ) << "\n\n";
cout << "Implementation has "
<< (
(sizeof( rational_type ) > 2u * sizeof( int_type ))
? "included padding bytes"
: "minimal size"
)
<< "\n\n";
}
};
// This fixture groups all the common settings.
class my_configuration
{
public:
typedef INT_TYPE IntType;
typedef ::boost::rational<IntType> rat;
};
// The factoring function template suite
BOOST_FIXTURE_TEST_SUITE( factoring_suite, my_configuration );
// GCD tests
BOOST_AUTO_TEST_CASE( gcd_test )
{
BOOST_CHECK_EQUAL( boost::gcd<IntType>( 1, -1), 1 );
BOOST_CHECK_EQUAL( boost::gcd<IntType>( -1, 1), 1 );
BOOST_CHECK_EQUAL( boost::gcd<IntType>( 1, 1), 1 );
BOOST_CHECK_EQUAL( boost::gcd<IntType>( -1, -1), 1 );
BOOST_CHECK_EQUAL( boost::gcd<IntType>( 0, 0), 0 );
BOOST_CHECK_EQUAL( boost::gcd<IntType>( 7, 0), 7 );
BOOST_CHECK_EQUAL( boost::gcd<IntType>( 0, 9), 9 );
BOOST_CHECK_EQUAL( boost::gcd<IntType>( -7, 0), 7 );
BOOST_CHECK_EQUAL( boost::gcd<IntType>( 0, -9), 9 );
BOOST_CHECK_EQUAL( boost::gcd<IntType>( 42, 30), 6 );
BOOST_CHECK_EQUAL( boost::gcd<IntType>( 6, -9), 3 );
BOOST_CHECK_EQUAL( boost::gcd<IntType>(-10, -10), 10 );
BOOST_CHECK_EQUAL( boost::gcd<IntType>(-25, -10), 5 );
}
// LCM tests
BOOST_AUTO_TEST_CASE( lcm_test )
{
BOOST_CHECK_EQUAL( boost::lcm<IntType>( 1, -1), 1 );
BOOST_CHECK_EQUAL( boost::lcm<IntType>( -1, 1), 1 );
BOOST_CHECK_EQUAL( boost::lcm<IntType>( 1, 1), 1 );
BOOST_CHECK_EQUAL( boost::lcm<IntType>( -1, -1), 1 );
BOOST_CHECK_EQUAL( boost::lcm<IntType>( 0, 0), 0 );
BOOST_CHECK_EQUAL( boost::lcm<IntType>( 6, 0), 0 );
BOOST_CHECK_EQUAL( boost::lcm<IntType>( 0, 7), 0 );
BOOST_CHECK_EQUAL( boost::lcm<IntType>( -5, 0), 0 );
BOOST_CHECK_EQUAL( boost::lcm<IntType>( 0, -4), 0 );
BOOST_CHECK_EQUAL( boost::lcm<IntType>( 18, 30), 90 );
BOOST_CHECK_EQUAL( boost::lcm<IntType>( -6, 9), 18 );
BOOST_CHECK_EQUAL( boost::lcm<IntType>(-10, -10), 10 );
BOOST_CHECK_EQUAL( boost::lcm<IntType>( 25, -10), 50 );
}
BOOST_AUTO_TEST_SUITE_END();
// The basic test suite
BOOST_FIXTURE_TEST_CASE( rational_test, my_configuration )
{
/* initialization tests */
rat r1, r2(0), r3(1), r4(-3), r5(7,2), r6(5,15), r7(14,-21),
r8(-4,6), r9(-14,-70);
BOOST_CHECK_EQUAL( r1.numerator(), 0 );
BOOST_CHECK_EQUAL( r2.numerator(), 0 );
BOOST_CHECK_EQUAL( r3.numerator(), 1 );
BOOST_CHECK_EQUAL( r4.numerator(), -3 );
BOOST_CHECK_EQUAL( r5.numerator(), 7 );
BOOST_CHECK_EQUAL( r6.numerator(), 1 );
BOOST_CHECK_EQUAL( r7.numerator(), -2 );
BOOST_CHECK_EQUAL( r8.numerator(), -2 );
BOOST_CHECK_EQUAL( r9.numerator(), 1 );
BOOST_CHECK_EQUAL( r1.denominator(), 1 );
BOOST_CHECK_EQUAL( r2.denominator(), 1 );
BOOST_CHECK_EQUAL( r3.denominator(), 1 );
BOOST_CHECK_EQUAL( r4.denominator(), 1 );
BOOST_CHECK_EQUAL( r5.denominator(), 2 );
BOOST_CHECK_EQUAL( r6.denominator(), 3 );
BOOST_CHECK_EQUAL( r7.denominator(), 3 );
BOOST_CHECK_EQUAL( r8.denominator(), 3 );
BOOST_CHECK_EQUAL( r9.denominator(), 5 );
/* assign() tests */
r1.assign(6,8);
BOOST_CHECK_EQUAL( r1.numerator(), 3 );
BOOST_CHECK_EQUAL( r1.denominator(), 4 );
r1.assign(0,-7);
BOOST_CHECK_EQUAL( r1.numerator(), 0 );
BOOST_CHECK_EQUAL( r1.denominator(), 1 );
/* comparison tests */
BOOST_CHECK( r1 == r2 );
BOOST_CHECK( r2 != r3 );
BOOST_CHECK( r4 < r3 );
BOOST_CHECK( r4 <= r5 );
BOOST_CHECK( r1 <= r2 );
BOOST_CHECK( r5 > r6 );
BOOST_CHECK( r5 >= r6 );
BOOST_CHECK( r7 >= r8 );
BOOST_CHECK( !(r3 == r2) );
BOOST_CHECK( !(r1 != r2) );
BOOST_CHECK( !(r1 < r2) );
BOOST_CHECK( !(r5 < r6) );
BOOST_CHECK( !(r9 <= r2) );
BOOST_CHECK( !(r8 > r7) );
BOOST_CHECK( !(r8 > r2) );
BOOST_CHECK( !(r4 >= r6) );
BOOST_CHECK( r1 == 0 );
BOOST_CHECK( r2 != -1 );
BOOST_CHECK( r3 < 2 );
BOOST_CHECK( r4 <= -3 );
BOOST_CHECK( r5 > 3 );
BOOST_CHECK( r6 >= 0 );
BOOST_CHECK( 0 == r2 );
BOOST_CHECK( 0 != r7 );
BOOST_CHECK( -1 < r8 );
BOOST_CHECK( -2 <= r9 );
BOOST_CHECK( 1 > r1 );
BOOST_CHECK( 1 >= r3 );
/* increment/decrement tests */
BOOST_CHECK( r1++ == r2 );
BOOST_CHECK( r1 != r2 );
BOOST_CHECK( r1 == r3 );
BOOST_CHECK( --r1 == r2 );
BOOST_CHECK( r8-- == r7 );
BOOST_CHECK( r8 != r7 );
BOOST_CHECK( ++r8 == r7 );
/* abs tests */
#ifdef BOOST_NO_ARGUMENT_DEPENDENT_LOOKUP
// This is a nasty hack, required because some compilers do not implement
// "Koenig Lookup". Basically, if I call abs(r), the C++ standard says that
// the compiler should look for a definition of abs in the namespace which
// contains r's class (in this case boost) - among other places.
using boost::abs;
#endif
BOOST_CHECK_EQUAL( abs(r2), r2 );
BOOST_CHECK_EQUAL( abs(r5), r5 );
BOOST_CHECK_EQUAL( abs(r8), rat(2, 3) );
/* unary operator tests */
BOOST_CHECK_EQUAL( +r5, r5 );
BOOST_CHECK( -r3 != r3 );
BOOST_CHECK_EQUAL( -(-r3), r3 );
BOOST_CHECK_EQUAL( -r4, 3 );
BOOST_CHECK( !r2 );
BOOST_CHECK( !!r3 );
}
// The rational arithmetic operations suite
BOOST_FIXTURE_TEST_SUITE( rational_arithmetic_suite, my_configuration );
// Addition & subtraction tests
BOOST_AUTO_TEST_CASE( rational_additive_test )
{
BOOST_CHECK_EQUAL( rat( 1, 2) + rat(1, 2), 1 );
BOOST_CHECK_EQUAL( rat(11, 3) + rat(1, 2), rat( 25, 6) );
BOOST_CHECK_EQUAL( rat(-8, 3) + rat(1, 5), rat(-37, 15) );
BOOST_CHECK_EQUAL( rat(-7, 6) + rat(1, 7), rat( 1, 7) - rat(7, 6) );
BOOST_CHECK_EQUAL( rat(13, 5) - rat(1, 2), rat( 21, 10) );
BOOST_CHECK_EQUAL( rat(22, 3) + 1, rat( 25, 3) );
BOOST_CHECK_EQUAL( rat(12, 7) - 2, rat( -2, 7) );
BOOST_CHECK_EQUAL( 3 + rat(4, 5), rat( 19, 5) );
BOOST_CHECK_EQUAL( 4 - rat(9, 2), rat( -1, 2) );
rat r( 11 );
r -= rat( 20, 3 );
BOOST_CHECK_EQUAL( r, rat(13, 3) );
r += rat( 1, 2 );
BOOST_CHECK_EQUAL( r, rat(29, 6) );
r -= 5;
BOOST_CHECK_EQUAL( r, rat( 1, -6) );
r += rat( 1, 5 );
BOOST_CHECK_EQUAL( r, rat( 1, 30) );
r += 2;
BOOST_CHECK_EQUAL( r, rat(61, 30) );
}
// Assignment tests
BOOST_AUTO_TEST_CASE( rational_assignment_test )
{
rat r;
r = rat( 1, 10 );
BOOST_CHECK_EQUAL( r, rat( 1, 10) );
r = -9;
BOOST_CHECK_EQUAL( r, rat(-9, 1) );
}
// Multiplication tests
BOOST_AUTO_TEST_CASE( rational_multiplication_test )
{
BOOST_CHECK_EQUAL( rat(1, 3) * rat(-3, 4), rat(-1, 4) );
BOOST_CHECK_EQUAL( rat(2, 5) * 7, rat(14, 5) );
BOOST_CHECK_EQUAL( -2 * rat(1, 6), rat(-1, 3) );
rat r = rat( 3, 7 );
r *= 14;
BOOST_CHECK_EQUAL( r, 6 );
r *= rat( 3, 8 );
BOOST_CHECK_EQUAL( r, rat(9, 4) );
}
// Division tests
BOOST_AUTO_TEST_CASE( rational_division_test )
{
BOOST_CHECK_EQUAL( rat(-1, 20) / rat(4, 5), rat(-1, 16) );
BOOST_CHECK_EQUAL( rat( 5, 6) / 7, rat( 5, 42) );
BOOST_CHECK_EQUAL( 8 / rat(2, 7), 28 );
rat r = rat( 4, 3 );
r /= rat(5,4);
BOOST_CHECK_EQUAL( r, rat(16, 15) );
r /= 4;
BOOST_CHECK_EQUAL( r, rat( 4, 15) );
BOOST_CHECK_EQUAL( rat(-1) / rat(-3), rat(1, 3) );
}
// Tests for operations on self
BOOST_AUTO_TEST_CASE( rational_self_operations_test )
{
rat r = rat( 4, 3 );
r += r;
BOOST_CHECK_EQUAL( r, rat( 8, 3) );
r *= r;
BOOST_CHECK_EQUAL( r, rat(64, 9) );
r /= r;
BOOST_CHECK_EQUAL( r, rat( 1, 1) );
r -= r;
BOOST_CHECK_EQUAL( r, rat( 0, 1) );
}
BOOST_AUTO_TEST_SUITE_END();
// The non-basic rational operations suite
BOOST_FIXTURE_TEST_SUITE( rational_extras_suite, my_configuration );
// Output test
BOOST_AUTO_TEST_CASE( rational_output_test )
{
::std::ostringstream oss;
oss << rat( 44, 14 );
BOOST_CHECK_EQUAL( oss.str(), "22/7" );
}
// Input test, failing
BOOST_AUTO_TEST_CASE( rational_input_failing_test )
{
::std::istringstream iss( "" );
rat r;
iss >> r;
BOOST_CHECK( !iss );
iss.clear();
iss.str( "42" );
iss >> r;
BOOST_CHECK( !iss );
iss.clear();
iss.str( "57A" );
iss >> r;
BOOST_CHECK( !iss );
iss.clear();
iss.str( "20-20" );
iss >> r;
BOOST_CHECK( !iss );
iss.clear();
iss.str( "1/" );
iss >> r;
BOOST_CHECK( !iss );
iss.clear();
iss.str( "1/ 2" );
iss >> r;
BOOST_CHECK( !iss );
iss.clear();
iss.str( "1 /2" );
iss >> r;
BOOST_CHECK( !iss );
}
// Input test, passing
BOOST_AUTO_TEST_CASE( rational_input_passing_test )
{
::std::istringstream iss( "1/2 12" );
rat r;
int n = 0;
BOOST_CHECK( iss >> r >> n );
BOOST_CHECK_EQUAL( r, rat(1, 2) );
BOOST_CHECK_EQUAL( n, 12 );
iss.clear();
iss.str( "34/67" );
BOOST_CHECK( iss >> r );
BOOST_CHECK_EQUAL( r, rat(34, 67) );
iss.clear();
iss.str( "-3/-6" );
BOOST_CHECK( iss >> r );
BOOST_CHECK_EQUAL( r, rat(1, 2) );
}
// Conversion test
BOOST_AUTO_TEST_CASE( rational_cast_test )
{
// Note that these are not generic. The problem is that rational_cast<T>
// requires a conversion from IntType to T. However, for a user-defined
// IntType, it is not possible to define such a conversion except as an
// "operator T()". This causes problems with overloading resolution.
::boost::rational<int> const half( 1, 2 );
BOOST_CHECK_EQUAL( ::boost::rational_cast<double>(half), 0.5 );
BOOST_CHECK_EQUAL( ::boost::rational_cast<int>(half), 0 );
}
// Dice tests (a non-main test)
BOOST_AUTO_TEST_CASE( dice_roll_test )
{
// Determine the mean number of times a fair six-sided die
// must be thrown until each side has appeared at least once.
rat r = IntType( 0 );
for ( int i = 1 ; i <= 6 ; ++i )
{
r += rat( 1, i );
}
r *= 6;
BOOST_CHECK_EQUAL( r, rat(147, 10) );
}
BOOST_AUTO_TEST_SUITE_END();
} // namespace
BOOST_GLOBAL_FIXTURE( rational_size_check );