Further renaming of length to width
[Mograsim.git] / net.mograsim.logic.core / src / net / mograsim / logic / core / wires / Wire.java
index 8eff2ef..8b28511 100644 (file)
@@ -25,85 +25,75 @@ public class Wire
        private BitVector values;
        public final int travelTime;
        private List<ReadEnd> attached = new ArrayList<>();
-       public final int length;
+       public final int width;
        List<ReadWriteEnd> inputs = new ArrayList<>();
        Timeline timeline;
 
-       public Wire(Timeline timeline, int length, int travelTime)
+       public Wire(Timeline timeline, int width, int travelTime)
        {
-               this(timeline, length, travelTime, null);
+               this(timeline, width, travelTime, null);
        }
 
-       public Wire(Timeline timeline, int length, int travelTime, String name)
+       public Wire(Timeline timeline, int width, int travelTime, String name)
        {
-               if (length < 1)
+               if (width < 1)
                        throw new IllegalArgumentException(
-                                       String.format("Tried to create an array of wires with length %d, but a length of less than 1 makes no sense.", length));
+                                       String.format("Tried to create an array of wires with width %d, but a width of less than 1 makes no sense.", width));
                this.name = name;
                this.timeline = timeline;
-               this.length = length;
+               this.width = width;
                this.travelTime = travelTime;
                initValues();
        }
 
        private void initValues()
        {
-               values = U.toVector(length);
-       }
-
-       private void recalculateSingleInput()
-       {
-               setNewValues(inputs.get(0).getInputValues());
-       }
-
-       private void recalculateMultipleInputs()
-       {
-               BitVectorMutator mutator = BitVectorMutator.empty();
-               for (ReadWriteEnd wireArrayEnd : inputs)
-                       mutator.join(wireArrayEnd.getInputValues());
-               setNewValues(mutator.toBitVector());
+               values = U.toVector(width);
        }
 
        private void setNewValues(BitVector newValues)
        {
                if (values.equals(newValues))
                        return;
-//             BitVector oldValues = values;
                values = newValues;
                notifyObservers();
        }
 
        void recalculate()
        {
-               switch (inputs.size())
+               if (inputs.isEmpty())
+                       setNewValues(U.toVector(width));
+               else
                {
-               case 0:
-                       setNewValues(BitVector.of(Bit.U, length));
-                       break;
-               case 1:
-                       recalculateSingleInput();
-                       break;
-               default:
-                       recalculateMultipleInputs();
+                       BitVectorMutator mutator = BitVectorMutator.empty();
+                       for (ReadWriteEnd wireArrayEnd : inputs)
+                               mutator.join(wireArrayEnd.getInputValues());
+                       setNewValues(mutator.toBitVector());
                }
        }
 
+       /**
+        * Forces a Wire to take on specific values. If the new values differ from the old ones, the observers of the Wire will be notified.
+        * WARNING! Use this with care! The preferred way of writing the values is ReadWriteEnd.feedSignals(BitVector)
+        * 
+        * @param values The values the <code>Wire</code> will have immediately after this method is called
+        */
+       public void forceValues(BitVector values)
+       {
+               setNewValues(values);
+       }
+
        /**
         * The {@link Wire} is interpreted as an unsigned integer with n bits.
         * 
         * @return <code>true</code> if all bits are either <code>Bit.ONE</code> or <code>Bit.ZERO</code> (they do not all have to have the same
-        *         value), not <code>Bit.X</code> or <code>Bit.Z</code>. <code>false</code> is returned otherwise.
+        *         value), not <code>Bit.U</code>, <code>Bit.X</code> or <code>Bit.Z</code>. <code>false</code> is returned otherwise.
         * 
         * @author Fabian Stemmler
         */
        public boolean hasNumericValue()
        {
-               for (Bit b : values)
-               {
-                       if (b != Bit.ZERO && b != Bit.ONE)
-                               return false;
-               }
-               return true;
+               return values.isBinary();
        }
 
        /**
@@ -145,23 +135,29 @@ public class Wire
        public long getSignedValue()
        {
                long val = getUnsignedValue();
-               long mask = 1 << (length - 1);
+               long mask = 1 << (width - 1);
                if ((mask & val) != 0)
                {
-                       int shifts = 64 - length;
+                       int shifts = 64 - width;
                        return (val << shifts) >> shifts;
                }
                return val;
        }
 
+       /**
+        * Returns the least significant bit (LSB)
+        */
        public Bit getValue()
        {
                return getValue(0);
        }
 
+       /**
+        * Returns the least significant bit (LSB) of the given index
+        */
        public Bit getValue(int index)
        {
-               return values.getBit(index);
+               return values.getLSBit(index);
        }
 
        public BitVector getValues(int start, int end)
@@ -182,9 +178,9 @@ public class Wire
         * 
         * @author Fabian Stemmler
         */
-       void attachEnd(ReadEnd end)
+       boolean attachEnd(ReadEnd end)
        {
-               attached.add(end);
+               return attached.add(end);
        }
 
        void detachEnd(ReadEnd end)
@@ -194,7 +190,7 @@ public class Wire
 
        private void notifyObservers()
        {
-               attached.forEach(r -> r.update());
+               attached.forEach(ReadEnd::update);
        }
 
        /**
@@ -241,7 +237,7 @@ public class Wire
                }
 
                /**
-                * Included for convenient use on {@link Wire}s of length 1.
+                * Included for convenient use on {@link Wire}s of width 1.
                 * 
                 * @return The value of bit 0.
                 * 
@@ -263,12 +259,6 @@ public class Wire
                        return Wire.this.getValue(index);
                }
 
-               /**
-                * @param index Index of the requested bit.
-                * @return The value of the indexed bit.
-                * 
-                * @author Fabian Stemmler
-                */
                public BitVector getValues()
                {
                        return Wire.this.getValues();
@@ -336,9 +326,9 @@ public class Wire
                        recalculate();
                }
 
-               public int length()
+               public int width()
                {
-                       return length;
+                       return width;
                }
 
                public Wire getWire()
@@ -367,7 +357,8 @@ public class Wire
 
        public class ReadWriteEnd extends ReadEnd
        {
-               private boolean open, isWriting;
+               private boolean open;
+               private boolean isWriting;
                private BitVector inputValues;
 
                ReadWriteEnd()
@@ -381,7 +372,7 @@ public class Wire
 
                private void initValues()
                {
-                       inputValues = U.toVector(length);
+                       inputValues = U.toVector(width);
                }
 
                /**
@@ -398,11 +389,11 @@ public class Wire
 
                public void feedSignals(BitVector newValues)
                {
-                       if (newValues.length() != length)
+                       if (newValues.width() != width)
                                throw new IllegalArgumentException(
-                                               String.format("Attempted to input %d bits instead of %d bits.", newValues.length(), length));
+                                               String.format("Attempted to input %d bits instead of %d bits.", newValues.width(), width));
                        if (!open)
-                               throw new RuntimeException("Attempted to write to closed WireArrayEnd.");
+                               throw new IllegalStateException("Attempted to write to closed WireArrayEnd.");
                        timeline.addEvent(e -> setValues(newValues), travelTime);
                }
 
@@ -417,7 +408,7 @@ public class Wire
                public void feedSignals(int startingBit, BitVector bitVector)
                {
                        if (!open)
-                               throw new RuntimeException("Attempted to write to closed WireArrayEnd.");
+                               throw new IllegalStateException("Attempted to write to closed WireArrayEnd.");
                        timeline.addEvent(e -> setValues(startingBit, bitVector), travelTime);
                }
 
@@ -431,7 +422,7 @@ public class Wire
                        if (!inputValues.equalsWithOffset(newValues, startingBit))
                        {
                                Bit[] vals = inputValues.getBits();
-                               System.arraycopy(newValues.getBits(), 0, vals, startingBit, newValues.length());
+                               System.arraycopy(newValues.getBits(), 0, vals, startingBit, newValues.width());
                                inputValues = BitVector.of(vals);
                                Wire.this.recalculate();
                        }
@@ -450,7 +441,8 @@ public class Wire
                }
 
                /**
-                * @return The value (of bit 0) the {@link ReadEnd} is currently feeding into the associated {@link Wire}.
+                * @return The value (of bit 0) the {@link ReadEnd} is currently feeding into the associated {@link Wire}.Returns the least
+                *         significant bit (LSB)
                 */
                public Bit getInputValue()
                {
@@ -459,10 +451,12 @@ public class Wire
 
                /**
                 * @return The value which the {@link ReadEnd} is currently feeding into the associated {@link Wire} at the indexed {@link Bit}.
+                *         Returns the least significant bit (LSB)
+                * 
                 */
                public Bit getInputValue(int index)
                {
-                       return inputValues.getBit(index);
+                       return inputValues.getLSBit(index);
                }
 
                /**
@@ -470,7 +464,7 @@ public class Wire
                 */
                public BitVector getInputValues()
                {
-                       return getInputValues(0, length);
+                       return inputValues;
                }
 
                public BitVector getInputValues(int start, int end)
@@ -483,7 +477,7 @@ public class Wire
                 */
                public void clearSignals()
                {
-                       feedSignals(Z.toVector(length));
+                       feedSignals(Z.toVector(width));
                }
 
                public BitVector wireValuesExcludingMe()
@@ -550,20 +544,20 @@ public class Wire
         * Fuses the selected bits of two wires together. If the bits change in one Wire, the other is changed accordingly immediately. Warning:
         * The bits are permanently fused together.
         * 
-        * @param a      The {@link Wire} to be (partially) fused with b
-        * @param b      The {@link Wire} to be (partially) fused with a
-        * @param fromA  The first bit of {@link Wire} a to be fused
-        * @param fromB  The first bit of {@link Wire} b to be fused
-        * @param length The amount of bits to fuse
+        * @param a     The {@link Wire} to be (partially) fused with b
+        * @param b     The {@link Wire} to be (partially) fused with a
+        * @param fromA The first bit of {@link Wire} a to be fused
+        * @param fromB The first bit of {@link Wire} b to be fused
+        * @param width The amount of bits to fuse
         */
-       public static void fuse(Wire a, Wire b, int fromA, int fromB, int length)
+       public static void fuse(Wire a, Wire b, int fromA, int fromB, int width)
        {
                ReadWriteEnd rA = a.createReadWriteEnd(), rB = b.createReadWriteEnd();
                rA.setWriting(false);
                rB.setWriting(false);
-               rA.setValues(BitVector.of(Bit.Z, a.length));
-               rB.setValues(BitVector.of(Bit.Z, b.length));
-               Fusion aF = new Fusion(rB, fromA, fromB, length), bF = new Fusion(rA, fromB, fromA, length);
+               rA.setValues(BitVector.of(Bit.Z, a.width));
+               rB.setValues(BitVector.of(Bit.Z, b.width));
+               Fusion aF = new Fusion(rB, fromA, fromB, width), bF = new Fusion(rA, fromB, fromA, width);
                rA.registerObserver(aF);
                rB.registerObserver(bF);
                aF.update(rA);
@@ -580,20 +574,20 @@ public class Wire
         */
        public static void fuse(Wire a, Wire b)
        {
-               fuse(a, b, 0, 0, a.length);
+               fuse(a, b, 0, 0, a.width);
        }
 
        private static class Fusion implements LogicObserver
        {
                private ReadWriteEnd target;
-               int fromSource, fromTarget, length;
+               int fromSource, fromTarget, width;
 
-               public Fusion(ReadWriteEnd target, int fromSource, int fromTarget, int length)
+               public Fusion(ReadWriteEnd target, int fromSource, int fromTarget, int width)
                {
                        this.target = target;
                        this.fromSource = fromSource;
                        this.fromTarget = fromTarget;
-                       this.length = length;
+                       this.width = width;
                }
 
                @Override
@@ -605,7 +599,7 @@ public class Wire
                        else
                        {
                                target.setWriting(true);
-                               BitVector targetInput = source.wireValuesExcludingMe().subVector(fromSource, fromSource + length);
+                               BitVector targetInput = source.wireValuesExcludingMe().subVector(fromSource, fromSource + width);
                                target.setValues(fromTarget, targetInput);
                        }
                }