rem_test.c

/*	$OpenBSD$	*/
/*-
 * Copyright (c) 2005-2008 David Schultz <das@FreeBSD.org>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#include "macros.h"

/*
 * Test for remainder functions: remainder, remainderf, remainderl,
 * remquo, remquof, and remquol.
 * Missing tests: fmod, fmodf.
 */

#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");

#include <float.h>
#include <math.h>
#include <stdio.h>
#include <stdlib.h>
#include <strings.h>

#include "test-utils.h"

static void test_invalid(long double, long double);
static void testl(long double, long double, long double, int);
static void testd(double, double, double, int);
static void testf(float, float, float, int);

#define	test(x, y, e_r, e_q) do {	\
	testl(x, y, e_r, e_q);		\
	testd(x, y, e_r, e_q);		\
	testf(x, y, e_r, e_q);		\
} while (0)

ATF_TC_WITHOUT_HEAD(rem1);
ATF_TC_BODY(rem1, tc)
{
	test_invalid(0.0, 0.0);
	test_invalid(1.0, 0.0);
	test_invalid(INFINITY, 0.0);
	test_invalid(INFINITY, 1.0);
	test_invalid(-INFINITY, 1.0);
	test_invalid(NAN, 1.0);
	test_invalid(1.0, NAN);

	test(4, 4, 0, 1);
	test(0, 3.0, 0, 0);
	testd(0x1p-1074, 1, 0x1p-1074, 0);
	testf(0x1p-149, 1, 0x1p-149, 0);
	test(3.0, 4, -1, 1);
	test(3.0, -4, -1, -1);
	testd(275 * 1193040, 275, 0, 1193040);
	test(4.5 * 7.5, 4.5, -2.25, 8); /* we should get the even one */
	testf(0x1.9044f6p-1, 0x1.ce662ep-1, -0x1.f109cp-4, 1);
#if LDBL_MANT_DIG > 53
	testl(-0x1.23456789abcdefp-2000L, 0x1.fedcba987654321p-2000L,
	    0x1.b72ea61d950c862p-2001L, -1);
#endif
}

ATF_TC_WITHOUT_HEAD(rem2);
ATF_TC_BODY(rem2, tc)
{
	/*
	 * The actual quotient here is 864062210.50000003..., but
	 * double-precision division gets -8.64062210.5, which rounds
	 * the wrong way.  This test ensures that remquo() is smart
	 * enough to get the low-order bit right.
	 */
	testd(-0x1.98260f22fc6dep-302, 0x1.fb3167c430a13p-332,
	    0x1.fb3165b82de72p-333, -864062211);
	/* Even harder cases with greater exponent separation */
	test(0x1.fp100, 0x1.ep-40, -0x1.cp-41, 143165577);
	testd(-0x1.abcdefp120, 0x1.87654321p-120, -0x1.69c78ec4p-121,
	    -63816414);
}

ATF_TC_WITHOUT_HEAD(rem3);
ATF_TC_BODY(rem3, tc)
{
	test(0x1.66666cp+120, 0x1p+71, 0.0, 1476395008);
	testd(-0x1.0000000000003p+0, 0x1.0000000000003p+0, -0.0, -1);
	testl(-0x1.0000000000003p+0, 0x1.0000000000003p+0, -0.0, -1);
	testd(-0x1.0000000000001p-749, 0x1.4p-1072, 0x1p-1074, -1288490189);
	testl(-0x1.0000000000001p-749, 0x1.4p-1072, 0x1p-1074, -1288490189);
}

static void
test_invalid(long double x, long double y)
{
	int q;

	q = 0xdeadbeef;

	ATF_CHECK(isnan(remainder(x, y)));
	ATF_CHECK(isnan(remquo(x, y, &q)));
#ifdef STRICT
	ATF_CHECK(q == 0xdeadbeef);
#endif

	ATF_CHECK(isnan(remainderf(x, y)));
	ATF_CHECK(isnan(remquof(x, y, &q)));
#ifdef STRICT
	ATF_CHECK(q == 0xdeadbeef);
#endif

	ATF_CHECK(isnan(remainderl(x, y)));
	ATF_CHECK(isnan(remquol(x, y, &q)));
#ifdef STRICT
	ATF_CHECK(q == 0xdeadbeef);
#endif
}

/* 0x012345 ==> 0x01ffff */
static inline int
mask(int x)
{
	return ((unsigned)~0 >> (32 - fls(x)));
}

static void
testl(long double x, long double y, long double expected_rem, int expected_quo)
{
	int q;
	long double rem;

	q = random();
	rem = remainderl(x, y);
	ATF_CHECK(rem == expected_rem);
	ATF_CHECK(!signbit(rem) == !signbit(expected_rem));
	rem = remquol(x, y, &q);
	ATF_CHECK(rem == expected_rem);
	ATF_CHECK(!signbit(rem) == !signbit(expected_rem));
	ATF_CHECK((q ^ expected_quo) >= 0); /* sign(q) == sign(expected_quo) */
	ATF_CHECK((q & 0x7) == (expected_quo & 0x7));
	if (q != 0) {
		ATF_CHECK((q > 0) ^ !(expected_quo > 0));
		q = abs(q);
		ATF_CHECK(q == (abs(expected_quo) & mask(q)));
	}
}

static void
testd(double x, double y, double expected_rem, int expected_quo)
{
	int q;
	double rem;

	q = random();
	rem = remainder(x, y);
	ATF_CHECK(rem == expected_rem);
	ATF_CHECK(!signbit(rem) == !signbit(expected_rem));
	rem = remquo(x, y, &q);
	ATF_CHECK(rem == expected_rem);
	ATF_CHECK(!signbit(rem) == !signbit(expected_rem));
	ATF_CHECK((q ^ expected_quo) >= 0); /* sign(q) == sign(expected_quo) */
	ATF_CHECK((q & 0x7) == (expected_quo & 0x7));
	if (q != 0) {
		ATF_CHECK((q > 0) ^ !(expected_quo > 0));
		q = abs(q);
		ATF_CHECK(q == (abs(expected_quo) & mask(q)));
	}
}

static void
testf(float x, float y, float expected_rem, int expected_quo)
{
	int q;
	float rem;

	q = random();
	rem = remainderf(x, y);
	ATF_CHECK(rem == expected_rem);
	ATF_CHECK(!signbit(rem) == !signbit(expected_rem));
	rem = remquof(x, y, &q);
	ATF_CHECK(rem == expected_rem);
	ATF_CHECK(!signbit(rem) == !signbit(expected_rem));
	ATF_CHECK((q ^ expected_quo) >= 0); /* sign(q) == sign(expected_quo) */
	ATF_CHECK((q & 0x7) == (expected_quo & 0x7));
	if (q != 0) {
		ATF_CHECK((q > 0) ^ !(expected_quo > 0));
		q = abs(q);
		ATF_CHECK((q & mask(q)) == (abs(expected_quo) & mask(q)));
	}
}

ATF_TP_ADD_TCS(tp)
{
	ATF_TP_ADD_TC(tp, rem1);
	ATF_TP_ADD_TC(tp, rem2);
	ATF_TP_ADD_TC(tp, rem3);

	return (atf_no_error());
}