1 package net.mograsim.logic.core.types;
3 import static net.mograsim.logic.core.types.BitVector.*;
4 import static net.mograsim.logic.core.types.Bit.*;
5 import static org.junit.jupiter.api.Assertions.*;
7 import java.math.BigInteger;
8 import java.util.Iterator;
10 import org.junit.jupiter.api.Test;
12 @SuppressWarnings("static-method") // JUnit requires non-static methods
19 BitVector.of(); // should be allowed and work
21 assertSame(SINGLE_U, BitVector.of(U));
22 assertSame(SINGLE_X, BitVector.of(X));
23 assertSame(SINGLE_0, BitVector.of(ZERO));
24 assertSame(SINGLE_1, BitVector.of(ONE));
25 assertSame(SINGLE_Z, BitVector.of(Z));
31 assertEquals(BitVector.of(), BitVector.of(ONE, 0));
33 assertSame(SINGLE_U, BitVector.of(U, 1));
34 assertSame(SINGLE_X, BitVector.of(X, 1));
35 assertSame(SINGLE_0, BitVector.of(ZERO, 1));
36 assertSame(SINGLE_1, BitVector.of(ONE, 1));
37 assertSame(SINGLE_Z, BitVector.of(Z, 1));
39 assertEquals(BitVector.of(X, X, X), BitVector.of(X, 3));
43 void testGetUnsignedValue()
45 assertEquals(BigInteger.valueOf(0b101), BitVector.parseBitstring("101").getUnsignedValue());
46 assertEquals(BigInteger.valueOf(0b01010), BitVector.parseBitstring("01010").getUnsignedValue());
47 assertEquals(BigInteger.valueOf(0), BitVector.parseBitstring("0000").getUnsignedValue());
48 assertEquals(BigInteger.valueOf(0b0000000101), BitVector.parseBitstring("0000000101").getUnsignedValue());
49 assertEquals(BigInteger.valueOf(0b1010000000), BitVector.parseBitstring("1010000000").getUnsignedValue());
51 assertThrows(NumberFormatException.class, () -> BitVector.parseBitstring("00X1").getUnsignedValue());
57 assertEquals(BitVector.parseBitstring("101"), BitVector.from(0b101L, 3));
58 assertEquals(BitVector.parseBitstring("01010"), BitVector.from(0b01010L, 5));
59 assertEquals(BitVector.parseBitstring("10101"), BitVector.from(-11L, 5));
60 assertEquals(BitVector.parseBitstring("0000"), BitVector.from(0L, 4));
64 void testOfBigIntegerInt()
66 assertEquals(BitVector.parseBitstring("101"), BitVector.from(BigInteger.valueOf(0b101), 3));
67 assertEquals(BitVector.parseBitstring("01010"), BitVector.from(BigInteger.valueOf(0b01010), 5));
68 assertEquals(BitVector.parseBitstring("10101"), BitVector.from(BigInteger.valueOf(-11), 5));
69 assertEquals(BitVector.parseBitstring("0000"), BitVector.from(BigInteger.valueOf(0), 4));
75 var bv = BitVector.SINGLE_1;
76 var bvm = bv.mutator();
78 assertFalse(bvm.isEmpty());
79 assertEquals(ONE, bvm.getLSBit(0));
80 assertEquals(SINGLE_1, bvm.toBitVector());
86 assertEquals(ONE, SINGLE_1.getMSBit(0));
87 assertEquals(ONE, BitVector.of(ONE, X, X, X).getMSBit(0));
88 assertEquals(ONE, BitVector.of(X, X, X, X, ONE, X).getMSBit(4));
94 assertEquals(ONE, SINGLE_1.getLSBit(0));
95 assertEquals(ONE, BitVector.of(X, X, X, ONE).getLSBit(0));
96 assertEquals(ONE, BitVector.of(X, X, X, X, ONE, X).getLSBit(1));
102 assertArrayEquals(new Bit[] { X, ONE, Z }, BitVector.of(X, ONE, Z).getBits());
103 assertArrayEquals(new Bit[] { X, ONE, Z }, BitVector.parseBitstring("X1Z").getBits());
109 assertTrue(SINGLE_0.isBinary());
110 assertTrue(SINGLE_1.isBinary());
112 assertFalse(SINGLE_U.isBinary());
113 assertFalse(SINGLE_X.isBinary());
114 assertFalse(SINGLE_Z.isBinary());
116 assertTrue(BitVector.of(ONE, ZERO, ONE, ONE, ZERO).isBinary());
117 assertFalse(BitVector.of(ONE, ZERO, ZERO, X).isBinary());
124 assertEquals(SINGLE_0, SINGLE_0.join(SINGLE_0));
125 assertEquals(SINGLE_X, SINGLE_0.join(SINGLE_1));
126 assertEquals(SINGLE_1, SINGLE_1.join(SINGLE_1));
129 assertEquals(SINGLE_1, SINGLE_Z.join(SINGLE_1));
130 assertEquals(SINGLE_U, SINGLE_0.join(SINGLE_U));
131 assertEquals(SINGLE_X, SINGLE_X.join(SINGLE_Z));
134 var result = BitVector.of(U, X, ZERO, ONE, Z).join(BitVector.of(ONE, ZERO, ZERO, ONE, Z));
135 assertEquals(BitVector.of(U, X, ZERO, ONE, Z), result);
142 assertEquals(SINGLE_0, SINGLE_0.and(SINGLE_0));
143 assertEquals(SINGLE_0, SINGLE_0.and(SINGLE_1));
144 assertEquals(SINGLE_1, SINGLE_1.and(SINGLE_1));
147 assertEquals(SINGLE_X, SINGLE_Z.and(SINGLE_1));
148 assertEquals(SINGLE_0, SINGLE_0.and(SINGLE_U));
149 assertEquals(SINGLE_X, SINGLE_X.and(SINGLE_Z));
152 var result = BitVector.of(U, X, ZERO, ONE, ONE).and(BitVector.of(ONE, ONE, ZERO, ZERO, ONE));
153 assertEquals(BitVector.of(U, X, ZERO, ZERO, ONE), result);
160 assertEquals(SINGLE_0, SINGLE_0.or(SINGLE_0));
161 assertEquals(SINGLE_1, SINGLE_0.or(SINGLE_1));
162 assertEquals(SINGLE_1, SINGLE_1.or(SINGLE_1));
165 assertEquals(SINGLE_1, SINGLE_Z.or(SINGLE_1));
166 assertEquals(SINGLE_1, SINGLE_1.or(SINGLE_U));
167 assertEquals(SINGLE_X, SINGLE_X.or(SINGLE_Z));
170 var result = BitVector.of(U, X, ZERO, ONE, ZERO).or(BitVector.of(ZERO, ZERO, ZERO, ONE, ONE));
171 assertEquals(BitVector.of(U, X, ZERO, ONE, ONE), result);
178 assertEquals(SINGLE_0, SINGLE_0.xor(SINGLE_0));
179 assertEquals(SINGLE_1, SINGLE_0.xor(SINGLE_1));
180 assertEquals(SINGLE_0, SINGLE_1.xor(SINGLE_1));
183 assertEquals(SINGLE_X, SINGLE_Z.xor(SINGLE_1));
184 assertEquals(SINGLE_U, SINGLE_0.xor(SINGLE_U));
185 assertEquals(SINGLE_X, SINGLE_X.xor(SINGLE_Z));
188 var result = BitVector.of(U, X, ZERO, ONE, ONE).xor(BitVector.of(ONE, ZERO, ZERO, ZERO, ONE));
189 assertEquals(BitVector.of(U, X, ZERO, ONE, ZERO), result);
196 assertEquals(SINGLE_1, SINGLE_0.not());
197 assertEquals(SINGLE_0, SINGLE_1.not());
200 assertEquals(SINGLE_U, SINGLE_U.not());
201 assertEquals(SINGLE_X, SINGLE_X.not());
202 assertEquals(SINGLE_X, SINGLE_Z.not());
205 var result = BitVector.of(U, X, ZERO, ONE, Z).not();
206 assertEquals(BitVector.of(U, X, ONE, ZERO, X), result);
212 assertEquals(0, BitVector.of().length());
213 assertEquals(1, SINGLE_0.length());
214 assertEquals(3, BitVector.of(X, X, Z).length());
220 assertEquals(BitVector.of(U, X), SINGLE_U.concat(SINGLE_X));
221 assertEquals(BitVector.of(Z, X, U, ONE, X), BitVector.of(Z, X, U).concat(BitVector.of(ONE, X)));
225 void testSubVectorInt()
227 assertEquals(SINGLE_0, SINGLE_0.subVector(0));
228 assertEquals(BitVector.of(), SINGLE_0.subVector(1));
229 assertEquals(SINGLE_0, BitVector.of(ONE, ZERO).subVector(1));
230 assertEquals(BitVector.of(X, Z), BitVector.of(ZERO, U, ONE, X, Z).subVector(3));
234 void testSubVectorIntInt()
236 assertEquals(SINGLE_0, SINGLE_0.subVector(0, 1));
237 assertEquals(BitVector.of(), SINGLE_0.subVector(0, 0));
238 assertEquals(SINGLE_0, BitVector.of(ONE, ZERO).subVector(1, 2));
239 assertEquals(BitVector.of(ONE, X), BitVector.of(ZERO, U, ONE, X, Z).subVector(2, 4));
243 void testEqualsObject()
245 assertEquals(SINGLE_X, SINGLE_X);
246 assertNotEquals(SINGLE_0, SINGLE_1);
248 assertEquals(BitVector.of(X, Z, U), BitVector.of(X, Z, U));
249 assertNotEquals(BitVector.of(X, Z, U), BitVector.of(X, X, U));
253 void testEqualsWithOffset()
255 assertTrue(SINGLE_X.equalsWithOffset(SINGLE_X, 0));
256 assertFalse(SINGLE_0.equalsWithOffset(SINGLE_1, 0));
258 assertTrue(BitVector.of(X, Z, U).equalsWithOffset(BitVector.of(Z, U), 1));
259 assertFalse(BitVector.of(X, Z, U).equalsWithOffset(BitVector.of(X, U), 1));
260 assertTrue(BitVector.of(X, Z, U).equalsWithOffset(BitVector.of(U), 2));
266 assertEquals(SINGLE_U, BitVector.parseBitstring("U"));
267 assertEquals(SINGLE_X, BitVector.parseBitstring("X"));
268 assertEquals(SINGLE_0, BitVector.parseBitstring("0"));
269 assertEquals(SINGLE_1, BitVector.parseBitstring("1"));
270 assertEquals(SINGLE_Z, BitVector.parseBitstring("Z"));
272 assertEquals(BitVector.of(X, U, Z, ONE, ZERO), BitVector.parseBitstring("XUZ10"));
274 assertThrows(RuntimeException.class, () -> BitVector.parseBitstring("01BX"));
280 var bv = BitVector.of(U, Z, ONE, ZERO, X);
281 Iterator<Bit> it = bv.iterator();
283 assertEquals(U, it.next());
284 assertEquals(Z, it.next());
285 assertEquals(ONE, it.next());
286 assertEquals(ZERO, it.next());
287 assertEquals(X, it.next());
288 assertFalse(it.hasNext());