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/sqrt/SqrtLUTTest.lvt

namespace Livt.Math.Tests.Sqrt

using Livt.Math.Sqrt

/**
 * Exercises SqrtLUT with a shared fixture instance. Each scenario establishes the inputs
 * and state it needs.
 */
@Test
component SqrtLUTTest
{
	// Shared fixture instances, signals, and observation state.
	sqrt: SqrtLUT

	/**
	 * Creates the shared fixture instances (SqrtLUT). Tests initialize the state required by
	 * their scenario.
	 */
	new()
	{
		sqrt = new SqrtLUT()
	}

	/**
	 * Checks the zero case.
	 */
	@Test
	fn TestZero()
	{
		var result = sqrt.Compute(0)
		assert result == 0
	}

	/**
	 * Checks the one case.
	 */
	@Test
	fn TestOne()
	{
		var result = sqrt.Compute(1)
		assert result == 1
	}

	/**
	 * Checks the non perfect square2 case.
	 */
	@Test
	fn TestNonPerfectSquare2()
	{
		var result = sqrt.Compute(2)
		assert result == 1
	}

	/**
	 * Checks the non perfect square3 case.
	 */
	@Test
	fn TestNonPerfectSquare3()
	{
		var result = sqrt.Compute(3)
		assert result == 1
	}

	/**
	 * Checks the perfect square4 case.
	 */
	@Test
	fn TestPerfectSquare4()
	{
		var result = sqrt.Compute(4)
		assert result == 2
	}

	/**
	 * Checks the perfect square9 case.
	 */
	@Test
	fn TestPerfectSquare9()
	{
		var result = sqrt.Compute(9)
		assert result == 3
	}

	/**
	 * Checks the non perfect square15 case.
	 */
	@Test
	fn TestNonPerfectSquare15()
	{
		var result = sqrt.Compute(15)
		assert result == 3
	}

	/**
	 * Checks the perfect square25 case.
	 */
	@Test
	fn TestPerfectSquare25()
	{
		var result = sqrt.Compute(25)
		assert result == 5
	}

	/**
	 * Checks the non perfect square63 case.
	 */
	@Test
	fn TestNonPerfectSquare63()
	{
		var result = sqrt.Compute(63)
		assert result == 7
	}

	/**
	 * Checks the perfect square64 case.
	 */
	@Test
	fn TestPerfectSquare64()
	{
		var result = sqrt.Compute(64)
		assert result == 8
	}

	/**
	 * Checks the perfect square144 case.
	 */
	@Test
	fn TestPerfectSquare144()
	{
		var result = sqrt.Compute(144)
		assert result == 12
	}

	/**
	 * Checks the perfect square225 case.
	 */
	@Test
	fn TestPerfectSquare225()
	{
		var result = sqrt.Compute(225)
		assert result == 15
	}

	/**
	 * Checks the max case.
	 */
	@Test
	fn TestMax()
	{
		var result = sqrt.Compute(SqrtLUT.MAX_INPUT)
		assert result == 15
	}

	/**
	 * Checks that Clamp above max.
	 */
	@Test
	fn TestClampAboveMax()
	{
		var result = sqrt.Compute(300)
		assert result == 15
	}

	/**
	 * Checks that Clamp below zero.
	 */
	@Test
	fn TestClampBelowZero()
	{
		var result = sqrt.Compute(-1)
		assert result == 0
	}
}