Livt packages

Livt.Math

Version 1.7.2

Reusable integer and fixed-point arithmetic, complex numbers, trigonometry, and statistics for FPGA applications written in Livt.

Published files (90)

tests/arithmetic/WideArithmeticTest.lvt

namespace Livt.Math.Tests.Arithmetic

using Livt.Math.Arithmetic

/**
 * Exact scalar oracles include signed limits and values beyond Livt int.
 */
@Test
component WideArithmeticTest
{
	// Shared fixture instances, signals, and observation state.
	wide: WideArithmetic<24>
	small: WideArithmetic<16>

	// A divide-only instance must reject disabled operations deterministically.
	division: WideArithmetic<24, 4>

	/**
	 * Creates the shared fixture instances (WideArithmetic). Tests initialize the state
	 * required by their scenario.
	 */
	new()
	{
		wide = new WideArithmetic<24>()
		small = new WideArithmetic<16>()
		division = new WideArithmetic<24, 4>()
	}

	/**
	 * Checks the rounded division case.
	 */
	@Test
	fn RoundedDivision()
	{
		assert wide.DivideEven(0xfffffffffffffff9, 0x0000000000000002) == 0xfffffffffffffffc
		assert !wide.Failed()
		assert wide.DivideEven(0xfffffffffffffffb, 0x0000000000000002) == 0xfffffffffffffffe
		assert !wide.Failed()
		assert wide.DivideEven(0x0000000000000005, 0x0000000000000002) == 0x0000000000000002
		assert !wide.Failed()
		assert wide.DivideEven(0x0000000000000007, 0x0000000000000002) == 0x0000000000000004
		assert !wide.Failed()
		assert wide.DivideEven(0x0000000000000000, 0x0000000000000001) == 0x0000000000000000
		assert !wide.Failed()
		assert wide.DivideEven(0x8000000000000000, 0x0000000000000001) == 0x8000000000000000
		assert !wide.Failed()
		assert wide.DivideEven(0x8000000000000000, 0x0000000000000003) == 0xd555555555555555
		assert !wide.Failed()
		assert wide.DivideEven(0x7fffffffffffffff, 0x0000000000000003) == 0x2aaaaaaaaaaaaaaa
		assert !wide.Failed()
		assert wide.DivideEven(0x7fffffffffffffff, 0x7ffffffffffffffe) == 0x0000000000000001
		assert !wide.Failed()
		assert wide.DivideEven(0x0001000000008000, 0x0000000000010000) == 0x0000000100000000
		assert !wide.Failed()
		assert wide.DivideEven(0xfffeffffffff8000, 0x0000000000010000) == 0xffffffff00000000
		assert !wide.Failed()
		assert wide.DivideEven(0x007ffffffffffc19, 0x000000000012d687) == 0x00000006cb7688c9
		assert !wide.Failed()
		assert wide.DivideEven(1, 0) == 0
		assert wide.Failed()
		assert wide.DivideEven(1, 0xffffffffffffffff) == 0
		assert wide.Failed()
		assert wide.DivideFloor(7, 2) == 3
		assert wide.DivideFloor(0xffffffffffffffff, 2) == 0
		assert wide.Failed()
	}

	/**
	 * Checks the roots and overflow case.
	 */
	@Test
	fn RootsAndOverflow()
	{
		assert wide.Sqrt(0x0000000000000000) == 0x0000000000000000
		assert wide.Sqrt(0x0000000000000001) == 0x0000000000000001
		assert wide.Sqrt(0x0000000000000002) == 0x0000000000000001
		assert wide.Sqrt(0x0000000000000003) == 0x0000000000000001
		assert wide.Sqrt(0x0000000000000004) == 0x0000000000000002
		assert wide.Sqrt(0x000000000000000f) == 0x0000000000000003
		assert wide.Sqrt(0x0000000000000010) == 0x0000000000000004
		assert wide.Sqrt(0x0000000000000011) == 0x0000000000000004
		assert wide.Sqrt(0x00000000ffffffff) == 0x000000000000ffff
		assert wide.Sqrt(0x0000000100000000) == 0x0000000000010000
		assert wide.Sqrt(0x00003fffffffffff) == 0x00000000007fffff
		assert wide.Sqrt(0x8000000000000000) == 0x00000000b504f333
		assert wide.Sqrt(0xffffffffffffffff) == 0x00000000ffffffff
		assert wide.Add(0x7fffffffffffffff, 1) == 0
		assert wide.Failed()
		assert wide.Multiply(0x7fffffffffffffff, 2) == 0
		assert wide.Failed()
		assert wide.Multiply(0x8000000000000000, 0xffffffffffffffff) == 0
		assert wide.Failed()
		assert wide.Add(0xffffffffffffffff, 1) == 0
		assert !wide.Failed()
		assert wide.Clamp(0x8000000000000000) == -8388607
		assert small.Clamp(0x7fffffffffffffff) == 32767
		assert small.Clamp(0xffffffffffffffff) == -1
	}

	/**
	 * Checks compile-time operation selection and recovery after rejected requests.
	 */
	@Test
	fn OperationCapabilities()
	{
		assert division.Multiply(7, 9) == 0
		assert division.Failed()
		assert division.Sqrt(16) == 0
		assert division.Failed()
		assert division.Add(1, 2) == 0
		assert division.Failed()
		assert division.Clamp(42) == 0
		assert division.Failed()
		assert division.DivideEven(7, 2) == 4
		assert !division.Failed()
		assert division.DivideFloor(7, 2) == 3
		assert !division.Failed()
	}

}