net.mograsim.logic.core/src/net/mograsim/logic/core/types/Bit.java

   1 package net.mograsim.logic.core.types;
   2
   3 import java.util.Arrays;
   4 import java.util.Map;
   5 import java.util.Objects;
   6
   7 /**
   8  * stdlogic according to IEEE 1164
   9  */
  10 public enum Bit implements StrictLogicType<Bit>
  11 {
  12         U("U"), X("X"), ZERO("0"), ONE("1"), Z("Z");
  13
  14         private final String symbol;
  15
  16         private Bit(String symbol)
  17         {
  18                 this.symbol = symbol;
  19         }
  20
  21         @Override
  22         public Bit and(Bit other)
  23         {
  24                 return fromTable(AND_TABLE, this, other);
  25         }
  26
  27         @Override
  28         public Bit or(Bit other)
  29         {
  30                 return fromTable(OR_TABLE, this, other);
  31         }
  32
  33         @Override
  34         public Bit xor(Bit other)
  35         {
  36                 return fromTable(XOR_TABLE, this, other);
  37         }
  38
  39         @Override
  40         public Bit not()
  41         {
  42                 switch (this)
  43                 {
  44                 case U:
  45                         return U;
  46                 case ONE:
  47                         return ZERO;
  48                 case ZERO:
  49                         return ONE;
  50                 default:
  51                         return X;
  52                 }
  53         }
  54
  55         public Bit[] makeArray(int length)
  56         {
  57                 Bit[] bits = new Bit[length];
  58                 Arrays.fill(bits, this);
  59                 return bits;
  60         }
  61
  62         public BitVector toVector(int length)
  63         {
  64                 return BitVector.of(this, length);
  65         }
  66
  67         @Override
  68         public Bit join(Bit other)
  69         {
  70                 return fromTable(JOIN_TABLE, this, other);
  71         }
  72
  73         @Override
  74         public String toString()
  75         {
  76                 return getSymbol();
  77         }
  78
  79         public String getSymbol()
  80         {
  81                 return symbol;
  82         }
  83
  84         public static Bit lastBitOf(int value)
  85         {
  86                 return values()[2 + (value & 1)];
  87         }
  88
  89         public static Bit parse(String s)
  90         {
  91                 Bit bit = SYMBOL_MAP.get(s);
  92                 Objects.requireNonNull(bit, "No Bit found for symbol " + s);
  93                 return bit;
  94         }
  95
  96         public static Bit parse(String s, int symbolPosition)
  97         {
  98                 return parse(s.substring(symbolPosition, symbolPosition + 1));
  99         }
 100
 101         private static Bit fromTable(Bit[][] table, Bit a, Bit b)
 102         {
 103                 return table[a.ordinal()][b.ordinal()];
 104         }
 105
 106         static final Map<String, Bit> SYMBOL_MAP = Map.of(U.symbol, U, X.symbol, X, ZERO.symbol, ZERO, ONE.symbol, ONE, Z.symbol, Z);
 107
 108         // @formatter:off
 109         private static final Bit[][] JOIN_TABLE =
 110                 { { U, U, U,    U,   U    },
 111                   { U, X, X,    X,   X    },
 112                   { U, X, ZERO, X,   ZERO },
 113                   { U, X, X,    ONE, ONE  },
 114                   { U, X, ZERO, ONE, Z    } };
 115
 116         private static final Bit[][] AND_TABLE =
 117                 { { U,    U,    ZERO, U,    U    },
 118                   { U,    X,    ZERO, X,    X    },
 119                   { ZERO, ZERO, ZERO, ZERO, ZERO },
 120                   { U,    X,    ZERO, ONE,  X    },
 121                   { U,    X,    ZERO, X,    X    } };
 122
 123         private static final Bit[][] OR_TABLE =
 124         { { U,   U,   U,    ONE, U    },
 125           { U,   X,   X,    ONE, X    },
 126           { U,   X,   ZERO, ONE, X    },
 127           { ONE, ONE, ONE,  ONE, ONE  },
 128           { U,   X,   X,    ONE, X    } };
 129
 130         private static final Bit[][] XOR_TABLE =
 131         { { U, U, U,    U,    U },
 132           { U, X, X,    X,    X },
 133           { U, X, ZERO, ONE,  X },
 134           { U, X, ONE,  ZERO, X },
 135           { U, X, X,    X,    X } };
 136         // @formatter:on
 137 }