X-Git-Url: https://mograsim.net/gitweb/?a=blobdiff_plain;f=net.mograsim.logic.core%2Fsrc%2Fnet%2Fmograsim%2Flogic%2Fcore%2Ftypes%2FBitVector.java;h=3e5c17702fd8e35c124ac3cea3e4dbc6e091728a;hb=813aa8a53a4377eb3875752aa3569bdadb971930;hp=4d5365a0188a95961a37e867b36046cfaf165ae9;hpb=bec6c3a711448475c7b8e43dd031efe7b89aba24;p=Mograsim.git

diff --git a/net.mograsim.logic.core/src/net/mograsim/logic/core/types/BitVector.java b/net.mograsim.logic.core/src/net/mograsim/logic/core/types/BitVector.java
index 4d5365a0..3e5c1770 100644
--- a/net.mograsim.logic.core/src/net/mograsim/logic/core/types/BitVector.java
+++ b/net.mograsim.logic.core/src/net/mograsim/logic/core/types/BitVector.java
@@ -2,6 +2,7 @@ package net.mograsim.logic.core.types;
 
 import static java.lang.String.format;
 
+import java.math.BigInteger;
 import java.util.Arrays;
 import java.util.Iterator;
 import java.util.NoSuchElementException;
@@ -13,17 +14,30 @@ import java.util.function.UnaryOperator;
 /**
  * Immutable class representing a {@link Bit}Vector
  *
- *
  * @author Christian Femers
  *
  */
 public final class BitVector implements StrictLogicType<BitVector>, Iterable<Bit>, RandomAccess
 {
+	public static final BitVector SINGLE_U = new BitVector(Bit.U);
+	public static final BitVector SINGLE_X = new BitVector(Bit.X);
+	public static final BitVector SINGLE_0 = new BitVector(Bit.ZERO);
+	public static final BitVector SINGLE_1 = new BitVector(Bit.ONE);
+	public static final BitVector SINGLE_Z = new BitVector(Bit.Z);
+
+	private static final BitVector[] SINGLE_BIT_MAPPING = { SINGLE_U, SINGLE_X, SINGLE_0, SINGLE_1, SINGLE_Z };
+
 	private final Bit[] bits;
 
+	private BitVector(Bit single)
+	{
+		Objects.requireNonNull(single);
+		bits = new Bit[] { single };
+	}
+
 	private BitVector(Bit[] bits)
 	{
-		this.bits = Objects.requireNonNull(bits);// do this first to "catch" bits==null before the foreach loop
+		this.bits = Objects.requireNonNull(bits); // do this first to "catch" bits==null before the foreach loop
 		for (Bit bit : bits)
 			if (bit == null)
 				throw new NullPointerException();
@@ -31,11 +45,15 @@ public final class BitVector implements StrictLogicType<BitVector>, Iterable<Bit
 
 	public static BitVector of(Bit... bits)
 	{
+		if (bits.length == 1)
+			return SINGLE_BIT_MAPPING[bits[0].ordinal()];
 		return new BitVector(bits.clone());
 	}
 
 	public static BitVector of(Bit bit, int length)
 	{
+		if (length == 1)
+			return SINGLE_BIT_MAPPING[bit.ordinal()];
 		return new BitVector(bit.makeArray(length));
 	}
 
@@ -44,20 +62,43 @@ public final class BitVector implements StrictLogicType<BitVector>, Iterable<Bit
 		return BitVectorMutator.of(this);
 	}
 
-	public Bit getBit(int bitIndex)
+	/**
+	 * Returns the most significant bit at <code>bitIndex</code>. (leftmost bit of a binary number at the given index)
+	 */
+	public Bit getMSBit(int bitIndex)
 	{
 		return bits[bitIndex];
 	}
 
+	/**
+	 * Returns the least significant bit at <code>bitIndex</code>. (rightmost bit of a binary number at the given index)
+	 */
+	public Bit getLSBit(int bitIndex)
+	{
+		return bits[bits.length - bitIndex - 1];
+	}
+
 	public Bit[] getBits()
 	{
 		return bits.clone();
 	}
 
+	public boolean isBinary()
+	{
+		for (int i = 0; i < bits.length; i++)
+		{
+			if (!bits[i].isBinary())
+				return false;
+		}
+		return true;
+	}
+
 	@Override
 	public BitVector join(BitVector t)
 	{
 		checkCompatibility(t);
+		if (bits.length == 1)
+			return SINGLE_BIT_MAPPING[bits[0].join(t.bits[0]).ordinal()];
 		return new BitVector(binOp(bits.clone(), t.bits, Bit::join));
 	}
 
@@ -65,6 +106,8 @@ public final class BitVector implements StrictLogicType<BitVector>, Iterable<Bit
 	public BitVector and(BitVector t)
 	{
 		checkCompatibility(t);
+		if (bits.length == 1)
+			return SINGLE_BIT_MAPPING[bits[0].and(t.bits[0]).ordinal()];
 		return new BitVector(binOp(bits.clone(), t.bits, Bit::and));
 	}
 
@@ -72,6 +115,8 @@ public final class BitVector implements StrictLogicType<BitVector>, Iterable<Bit
 	public BitVector or(BitVector t)
 	{
 		checkCompatibility(t);
+		if (bits.length == 1)
+			return SINGLE_BIT_MAPPING[bits[0].or(t.bits[0]).ordinal()];
 		return new BitVector(binOp(bits.clone(), t.bits, Bit::or));
 	}
 
@@ -79,12 +124,16 @@ public final class BitVector implements StrictLogicType<BitVector>, Iterable<Bit
 	public BitVector xor(BitVector t)
 	{
 		checkCompatibility(t);
+		if (bits.length == 1)
+			return SINGLE_BIT_MAPPING[bits[0].xor(t.bits[0]).ordinal()];
 		return new BitVector(binOp(bits.clone(), t.bits, Bit::xor));
 	}
 
 	@Override
 	public BitVector not()
 	{
+		if (bits.length == 1)
+			return SINGLE_BIT_MAPPING[bits[0].not().ordinal()];
 		return new BitVector(unOp(bits.clone(), Bit::not));
 	}
 
@@ -224,16 +273,38 @@ public final class BitVector implements StrictLogicType<BitVector>, Iterable<Bit
 			return this;
 		}
 
-		public void setBit(int bitIndex, Bit bit)
+		/**
+		 * Set the most significant bit at <code>bitIndex</code>. (leftmost bit of a binary number at the given index)
+		 */
+		public void setMSBit(int bitIndex, Bit bit)
 		{
 			bits[bitIndex] = bit;
 		}
 
-		public Bit getBit(int bitIndex)
+		/**
+		 * Set the least significant bit at <code>bitIndex</code>. (rightmost bit of a binary number at the given index)
+		 */
+		public void setLSBit(int bitIndex, Bit bit)
+		{
+			bits[bits.length - bitIndex - 1] = bit;
+		}
+
+		/**
+		 * Returns the most significant bit at <code>bitIndex</code>. (leftmost bit of a binary number at the given index)
+		 */
+		public Bit getMSBit(int bitIndex)
 		{
 			return bits[bitIndex];
 		}
 
+		/**
+		 * Returns the least significant bit at <code>bitIndex</code>. (rightmost bit of a binary number at the given index)
+		 */
+		public Bit getLSBit(int bitIndex)
+		{
+			return bits[bits.length - bitIndex - 1];
+		}
+
 		public int length()
 		{
 			return bits.length;
@@ -287,7 +358,7 @@ public final class BitVector implements StrictLogicType<BitVector>, Iterable<Bit
 	}
 
 	/**
-	 * All {@link Bit}s symbols concatenated together
+	 * All {@link Bit}s symbols concatenated together (MSB first)
 	 * 
 	 * @see #parse(String)
 	 */
@@ -301,7 +372,7 @@ public final class BitVector implements StrictLogicType<BitVector>, Iterable<Bit
 	}
 
 	/**
-	 * Parses a String containing solely {@link Bit} symbols
+	 * Parses a String containing solely {@link Bit} symbols (MSB first)
 	 * 
 	 * @see #toString()
 	 */
@@ -315,6 +386,24 @@ public final class BitVector implements StrictLogicType<BitVector>, Iterable<Bit
 		return new BitVector(values);
 	}
 
+	public static BitVector of(long value, int bits)
+	{
+		return of(BigInteger.valueOf(value), bits);
+	}
+
+	public static BitVector of(BigInteger value, int bits)
+	{
+		Bit[] values = new Bit[bits];
+		for (int i = 0; i < bits; i++)
+		{
+			values[bits - i - 1] = Bit.of(value.testBit(i));
+		}
+		return new BitVector(values);
+	}
+
+	/**
+	 * Iterate over the {@link Bit}s of the BitVector <b>from MSB to LSB</b> (left to right).
+	 */
 	@Override
 	public Iterator<Bit> iterator()
 	{
@@ -327,7 +416,7 @@ public final class BitVector implements StrictLogicType<BitVector>, Iterable<Bit
 			{
 				if (!hasNext())
 					throw new NoSuchElementException();
-				return getBit(pos++);
+				return getMSBit(pos++);
 			}
 
 			@Override