logicuit 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0dad7e6a6e7b924c46183e5ef4bfc6e4647fee1d8bc64b10792569664a6c4b80
-  data.tar.gz: a5c316448fc8b3019488131b53ad8115e11da5151fddc6f1d40d821f2b9862b8
+  metadata.gz: 8c670278d5f0547d3b3acdaa0f828731de1351c1d4148c2df2b57bae5a43a199
+  data.tar.gz: f84a271fd5df3767035f77ba196a84638a5214d52b71cd7151c81b18162709a5
 SHA512:
-  metadata.gz: e5b4c0ea5bf5922c99a6ed7ee0d1a0eafe388c481bd1c54995645f01498adb9979c8967e1f70bcbbc7327b9c6ed2b43bd06fef326b25b73bd24beca3705a0fcc
-  data.tar.gz: f37bec9789e8292558fd8cf58d4aa29a1765ba6d82826315afe1f4d11a24d2bb99d92ba88bdd52f52ff0e74c160ca552ebc99067f7c20151c127f7f756eee593
+  metadata.gz: 95e3514d3a0327f43becf3066a5a9ad6ecf4dcc51af6af0dfcbf1475fe055faaa715925878422fdc268c261006ea66514b7f6ad90a721c5f0f193cd66104231a
+  data.tar.gz: 39f1237f88d0bcf06d8aed9b08d9e9fd0c7b6f9659c8b6843c8c320382aff5a249f82c2e180a508fb3e9dac14f7eef04d02f6ed2037d14481d6abf2b8fdd3cc6

data/.rubocop.yml

@@ -1,8 +1,13 @@
 AllCops:
   TargetRubyVersion: 3.1
+  NewCops: disable
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 
 Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
+
+require:
+  - rubocop-minitest
+  - rubocop-rake

data/README.md

@@ -18,14 +18,52 @@ gem install logicuit
 
 ## Usage
 
+This is the code to create a 1-bit CPU:
+
 ```
-Logicuit::And.new(1, 1).signal # [1]
-Logicuit::And.new(1, 0).signal # [0]
-Logicuit::And.new(0, 1).signal # [0]
-Logicuit::And.new(0, 0).signal # [0]
+require "logicuit"
+
+# 1 bit CPU
+#
+#  +-(Y)-|NOT|-(A)-+
+#  |               |
+#  +-(D)-|   |-(Q)-+
+#        |DFF|
+#   (CK)-|>  |
+#
+class OneBitCpu
+  def initialize
+    @dff = Logicuit::Circuits::Sequential::DFlipFlop.new
+    @not = Logicuit::Gates::Not.new
+    @dff.q >> @not.a
+    @not.y >> @dff.d
+  end
+
+  def to_s
+    <<~CIRCUIT
+      +-(#{@not.y})-|NOT|-(#{@not.a})-+
+      |               |
+      +-(#{@dff.d})-|   |-(#{@dff.q})-+
+            |DFF|
+       (CK)-|>  |
+    CIRCUIT
+  end
+end
+
+obc = OneBitCpu.new
+loop do
+  system("clear")
+  puts obc
+  sleep 1
+  Logicuit::Signals::Clock.tick
+end
 ```
 
-This is all for now :)
+you can execute the following as a one-liner:
+
+```
+$ ruby -r logicuit -e 'Logicuit::Circuits::SystemLevel::OneBitCpu.run'
+```
 
 ## Development
 

data/lib/logicuit/base.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Logicuit
+  # base class for all gates and circuits
+  class Base
+    def initialize(*args)
+      @input_targets = []
+      @output_targets = []
+      define_inputs(*args)
+      define_outputs
+      evaluate
+    end
+
+    attr_reader :input_targets, :output_targets
+
+    def self.define_inputs(*inputs) # rubocop:disable Metrics/MethodLength
+      inputs.each do |input|
+        define_method(input) do
+          instance_variable_get("@#{input}")
+        end
+      end
+
+      define_method(:define_inputs) do |*args|
+        inputs.each_with_index do |input, index|
+          signal = Signals::Signal.new(args[index] == 1)
+          signal.on_change << self
+          instance_variable_set("@#{input}", signal)
+          @input_targets << input
+        end
+      end
+    end
+
+    def self.define_outputs(**outputs) # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
+      outputs.each_key do |output|
+        define_method(output) do
+          instance_variable_get("@#{output}")
+        end
+      end
+
+      define_method(:define_outputs) do
+        outputs.each_key do |output|
+          instance_variable_set("@#{output}", Signals::Signal.new(false))
+          @output_targets << output
+        end
+      end
+
+      define_method(:evaluate) do
+        outputs.each do |output, evaluator|
+          signal = instance_variable_get("@#{output}")
+          if evaluator.call(*@input_targets.map do |input|
+            instance_variable_get("@#{input}").current
+          end)
+            signal.on
+          else
+            signal.off
+          end
+        end
+      end
+    end
+
+    def self.diagram(source)
+      define_method(:to_s) do
+        (@input_targets + @output_targets).reduce(source) do |result, input|
+          result.gsub(/\(#{input}\)/i, "(#{instance_variable_get("@#{input}")})#{"-" * (input.size - 1)}")
+        end
+      end
+    end
+
+    def self.truth_table(source) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
+      define_method(:truth_table) do # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity,Metrics/BlockLength
+        rows = source.strip.split("\n")
+        headers = rows.shift.split("|").map(&:strip).reject(&:empty?).map(&:downcase).map(&:to_sym)
+        rows.shift # devide line
+        table = rows.map do |row|
+          row.split("|").map(&:strip).reject(&:empty?).map(&:downcase).map do |v|
+            case v
+            when "x"
+              :any
+            when "1"
+              true
+            when "0"
+              false
+            else
+              raise "Invalid value in truth table: #{v}"
+            end
+          end
+        end.select do |values| # rubocop:disable Style/MultilineBlockChain
+          headers.size == values.size
+        end.map do |values| # rubocop:disable Style/MultilineBlockChain
+          array = [values]
+          while array.any? { |values| values.any? { |v| v == :any } }
+            target_index = array.find_index { |values| values.any? { |v| v == :any } }
+            target = array[target_index]
+            prop_index = target.find_index { |v| v == :any }
+            array.delete_at(target_index)
+            array.insert(target_index, *[true, false].map do |v|
+              target.dup.tap do |a|
+                a[prop_index] = v
+              end
+            end)
+          end
+          array
+        end.flatten!(1).map do |values| # rubocop:disable Style/MultilineBlockChain
+          headers.zip(values).to_h
+        end
+        table
+      end
+    end
+  end
+end

data/lib/logicuit/circuits/combinational/half_adder.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+# TODO: implement the HalfAdder class

data/lib/logicuit/circuits/combinational/multiplexer2to1.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Logicuit
+  module Circuits
+    module Combinational
+      # A Multiplexer with 2 inputs and 1 output
+      class Multiplexer2To1 < Base
+        define_inputs :c0, :c1, :a
+
+        define_outputs y: lambda { |c0, c1, a|
+          (c0 && !a) || (c1 && a)
+        }
+
+        diagram <<~DIAGRAM
+          (C0)---------|
+                       |AND|--+
+               +-|NOT|-|      +--|
+               |                 |OR|--(Y)
+          (C1)---------|      +--|
+               |       |AND|--+
+          (A)--+-------|
+        DIAGRAM
+
+        truth_table <<~TRUTH_TABLE
+          | C0 | C1 | A | Y |
+          | -- | -- | - | - |
+          |  0 |  x | 0 | 0 |
+          |  1 |  x | 0 | 1 |
+          |  x |  0 | 1 | 0 |
+          |  x |  1 | 1 | 1 |
+        TRUTH_TABLE
+      end
+    end
+  end
+end

data/lib/logicuit/circuits/sequential/d_flip_flop.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Logicuit
+  module Circuits
+    module Sequential
+      # D Flip-Flop
+      #
+      # (D)--|   |--(Q)
+      #      |DFF|
+      # (CK)-|>  |
+      #
+      class DFlipFlop
+        def initialize(d = 0) # rubocop:disable Naming/MethodParameterName
+          Signals::Clock.on_tick << self
+
+          @d = d.is_a?(Signals::Signal) ? d : Signals::Signal.new(d == 1)
+
+          @q = Signals::Signal.new(false)
+          evaluate
+        end
+
+        attr_reader :d, :q
+
+        def evaluate
+          if d.current
+            q.on
+          else
+            q.off
+          end
+        end
+
+        def to_s
+          <<~CIRCUIT
+            (#{d})--|   |--(#{q})
+                 |DFF|
+            (CK)-|>  |
+          CIRCUIT
+        end
+      end
+    end
+  end
+end

data/lib/logicuit/circuits/system_level/one_bit_cpu.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Logicuit
+  module Circuits
+    module SystemLevel
+      # 1 bit CPU
+      #
+      #  +-(Y)-|NOT|-(A)-+
+      #  |               |
+      #  +-(D)-|   |-(Q)-+
+      #        |DFF|
+      #   (CK)-|>  |
+      #
+      class OneBitCpu
+        def initialize
+          @dff = Sequential::DFlipFlop.new
+          @not = Gates::Not.new
+          @dff.q >> @not.a
+          @not.y >> @dff.d
+        end
+
+        def to_s
+          <<~CIRCUIT
+            +-(#{@not.y})-|NOT|-(#{@not.a})-+
+            |               |
+            +-(#{@dff.d})-|   |-(#{@dff.q})-+
+                  |DFF|
+             (CK)-|>  |
+          CIRCUIT
+        end
+
+        def self.run
+          obc = new
+          loop do
+            system("clear")
+            puts obc
+            sleep 1
+            Signals::Clock.tick
+          end
+        end
+      end
+    end
+  end
+end

data/lib/logicuit/gates/and.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Logicuit
+  module Gates
+    # AND gate
+    class And < Base
+      define_inputs :a, :b
+
+      define_outputs y: ->(a, b) { a && b }
+
+      diagram <<~DIAGRAM
+        (A)-|
+            |AND|-(Y)
+        (B)-|
+      DIAGRAM
+
+      truth_table <<~TRUTH_TABLE
+        | A | B | Y |
+        | - | - | - |
+        | 0 | 0 | 0 |
+        | 1 | 0 | 0 |
+        | 0 | 1 | 0 |
+        | 1 | 1 | 1 |
+      TRUTH_TABLE
+    end
+  end
+end

data/lib/logicuit/gates/not.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Logicuit
+  module Gates
+    # NOT gate
+    class Not < Base
+      define_inputs :a
+
+      define_outputs y: ->(a) { !a } # rubocop:disable Style/SymbolProc
+
+      diagram <<~DIAGRAM
+        (A)-|NOT|-(Y)
+      DIAGRAM
+
+      truth_table <<~TRUTH_TABLE
+        | A | Y |
+        | - | - |
+        | 0 | 1 |
+        | 1 | 0 |
+      TRUTH_TABLE
+    end
+  end
+end

data/lib/logicuit/gates/or.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Logicuit
+  module Gates
+    # OR gate
+    class Or < Base
+      define_inputs :a, :b
+
+      define_outputs y: ->(a, b) { a || b }
+
+      diagram <<~DIAGRAM
+        (A)-|
+            |OR|-(Y)
+        (B)-|
+      DIAGRAM
+
+      truth_table <<~TRUTH_TABLE
+        | A | B | Y |
+        | - | - | - |
+        | 0 | 0 | 0 |
+        | 1 | 0 | 1 |
+        | 0 | 1 | 1 |
+        | 1 | 1 | 1 |
+      TRUTH_TABLE
+    end
+  end
+end

data/lib/logicuit/signals/clock.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Logicuit
+  module Signals
+    # Clock
+    class Clock
+      def initialize
+        @on_tick = []
+      end
+
+      attr_reader :on_tick
+
+      def tick
+        @on_tick.each(&:evaluate)
+      end
+
+      def self.instance
+        @instance ||= new
+      end
+
+      def self.on_tick
+        instance.on_tick
+      end
+
+      def self.tick
+        instance.tick
+      end
+    end
+  end
+end

data/lib/logicuit/signals/signal.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Logicuit
+  module Signals
+    # Signal
+    class Signal
+      def initialize(current = false) # rubocop:disable Style/OptionalBooleanParameter
+        @current = current
+        @connected_by = nil
+        @on_change = []
+      end
+
+      attr_reader :current, :on_change
+      attr_accessor :connected_by
+
+      def on
+        changed = @current.!
+        @current = true
+        @on_change.each(&:evaluate) if changed
+      end
+
+      def off
+        changed = @current
+        @current = false
+        @on_change.each(&:evaluate) if changed
+      end
+
+      def toggle
+        @current ? off : on
+      end
+
+      def connects_to(other)
+        other.connected_by = self
+        other.evaluate
+        on_change << other
+      end
+      alias >> connects_to
+
+      def evaluate
+        return if @connected_by.nil?
+
+        @connected_by.current ? on : off
+      end
+
+      def to_s
+        current ? "1" : "0"
+      end
+    end
+  end
+end

data/lib/logicuit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Logicuit
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/logicuit.rb

@@ -1,4 +1,12 @@
 # frozen_string_literal: true
 
 require_relative "logicuit/version"
-require_relative "logicuit/and"
+require_relative "logicuit/base"
+require_relative "logicuit/gates/and"
+require_relative "logicuit/gates/or"
+require_relative "logicuit/gates/not"
+require_relative "logicuit/signals/signal"
+require_relative "logicuit/signals/clock"
+require_relative "logicuit/circuits/sequential/d_flip_flop"
+require_relative "logicuit/circuits/combinational/multiplexer2to1"
+require_relative "logicuit/circuits/system_level/one_bit_cpu"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: logicuit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Koji NAKAMURA
 bindir: exe
 cert_chain: []
-date: 2025-02-05 00:00:00.000000000 Z
+date: 2025-03-09 00:00:00.000000000 Z
 dependencies: []
 description: logi(c cir)cuit -> logicuit
 email:
@@ -21,7 +21,16 @@ files:
 - README.md
 - Rakefile
 - lib/logicuit.rb
-- lib/logicuit/and.rb
+- lib/logicuit/base.rb
+- lib/logicuit/circuits/combinational/half_adder.rb
+- lib/logicuit/circuits/combinational/multiplexer2to1.rb
+- lib/logicuit/circuits/sequential/d_flip_flop.rb
+- lib/logicuit/circuits/system_level/one_bit_cpu.rb
+- lib/logicuit/gates/and.rb
+- lib/logicuit/gates/not.rb
+- lib/logicuit/gates/or.rb
+- lib/logicuit/signals/clock.rb
+- lib/logicuit/signals/signal.rb
 - lib/logicuit/version.rb
 - sig/logicuit.rbs
 homepage: https://github.com/kozy4324/logicuit
@@ -46,7 +55,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.5
 specification_version: 4
 summary: logi(c cir)cuit -> logicuit
 test_files: []

data/lib/logicuit/and.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Logicuit
-  # AND circuit
-  class And
-    def initialize(a, b) # rubocop:disable Naming/MethodParameterName
-      @a = a
-      @b = b
-    end
-
-    def signal
-      [@a == 1 && @b == 1 ? 1 : 0]
-    end
-  end
-end