summaryrefslogtreecommitdiff
path: root/src/test/java/sevenUnits/utils/UncertainDoubleTest.java
blob: 733a3082970541aca1ecf3d3d41fa6ed92c63e8f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
/**
 * Copyright (C) 2021, 2022, 2024, 2025 Adrien Hopkins
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
package sevenUnits.utils;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static sevenUnits.utils.UncertainDouble.fromRoundedString;
import static sevenUnits.utils.UncertainDouble.fromString;
import static sevenUnits.utils.UncertainDouble.of;

import java.util.List;

import org.junit.jupiter.api.Test;

/**
 * Tests for the UncertainDouble
 *
 * @author Adrien Hopkins
 * @since 2021-11-29
 * @since v0.3.2
 */
class UncertainDoubleTest {
	/** Ensures that the compareTo function behaves correctly. */
	@Test
	final void testCompareTo() {
		assertTrue(of(2.0, 0.5).compareTo(of(2.0, 0.1)) == 0);
		assertTrue(of(2.0, 0.5).compareTo(of(1.0, 0.1)) > 0);
		assertTrue(of(2.0, 0.5).compareTo(of(3.0, 0.1)) < 0);
	}

	/** Tests the ___exact operations */
	@Test
	final void testExactOperations() {
		final var x = UncertainDouble.of(Math.PI, 0.1);

		// slightly different because roundoff errors
		final var x1 = UncertainDouble.of(Math.PI + Math.E - Math.E, 0.1);
		final var x2 = UncertainDouble.of(Math.PI * Math.E / Math.E, 0.1);

		// get results
		final var result1 = x.plusExact(Math.E).minusExact(Math.E);
		final var result2 = x.timesExact(Math.E).dividedByExact(Math.E);

		// test that these operations work & don't change uncertainty
		assertEquals(x1, result1);
		assertTrue(x.equivalent(result1));
		assertEquals(x2, result2);
		assertTrue(x.equivalent(result2));

		// exponents are different
		assertEquals(Math.pow(Math.PI, Math.E),
				x.toExponentExact(Math.E).value());
	}

	/**
	 * Test for {@link UncertainDouble#fromRoundedString}
	 *
	 * @since 2022-04-18
	 * @since v0.4.0
	 */
	@Test
	final void testFromRoundedString() {
		assertEquals(of(12345.678, 0.001), fromRoundedString("12345.678"));
	}

	/** Test for {@link UncertainDouble#fromString} */
	@Test
	final void testFromString() {
		// valid strings
		assertEquals(of(2.0, 0.5), fromString("2.0 ± 0.5"));
		assertEquals(of(2.0, 0.5), fromString("2.0 +- 0.5"));
		assertEquals(of(2.0, 0.0), fromString("2.0"));

		// invalid strings
		for (final String s : List.of("2.A", "A", "2.0 ± ", " ± 3.5")) {
			assertThrows(IllegalArgumentException.class, () -> fromString(s));
		}

		// back and forth
		assertEquals("2.0 ± 0.5", of(2.0, 0.5).toString());
		assertEquals("2.0", of(2.0, 0).toString());
	}

	@Test
	final void testHashCode() {
		assertEquals(of(2.0, 0.5).hashCode(), fromString("2.0 ± 0.5").hashCode());
	}
}