logicuit 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26c6eb8e9b1845c097a5e64604ca2c71632c8d0f98f19e0df1d642e57ad6ee7a
-  data.tar.gz: 9e470fdd05e968fd46829a2df9a57015f40cd9460a2cef769e210d1e720c9144
+  metadata.gz: 8c670278d5f0547d3b3acdaa0f828731de1351c1d4148c2df2b57bae5a43a199
+  data.tar.gz: f84a271fd5df3767035f77ba196a84638a5214d52b71cd7151c81b18162709a5
 SHA512:
-  metadata.gz: beb747fa8ea167b01d3a765564f1ffcf546072afe315e8c8a9bb37601409204b002011d68a737302090e5f2808c54e75fa80de87ea4d02e66037d2c2a8792b74
-  data.tar.gz: dc144486811fc58d4ba1cda48f6fce95ed7776e7b3b059950388d3e41d8459c90e3d4500c4e0b97e9d9158654952fc1041e801c24a9b13c690f8d7c238bb5647
+  metadata.gz: 95e3514d3a0327f43becf3066a5a9ad6ecf4dcc51af6af0dfcbf1475fe055faaa715925878422fdc268c261006ea66514b7f6ad90a721c5f0f193cd66104231a
+  data.tar.gz: 39f1237f88d0bcf06d8aed9b08d9e9fd0c7b6f9659c8b6843c8c320382aff5a249f82c2e180a508fb3e9dac14f7eef04d02f6ed2037d14481d6abf2b8fdd3cc6

data/README.md

@@ -18,6 +18,8 @@ gem install logicuit
 
 ## Usage
 
+This is the code to create a 1-bit CPU:
+
 ```
 require "logicuit"
 
@@ -57,6 +59,12 @@ loop do
 end
 ```
 
+you can execute the following as a one-liner:
+
+```
+$ ruby -r logicuit -e 'Logicuit::Circuits::SystemLevel::OneBitCpu.run'
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

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/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/gates/and.rb

@@ -3,36 +3,25 @@
 module Logicuit
   module Gates
     # AND gate
-    #
-    # (A)-|
-    #     |AND|-(Y)
-    # (B)-|
-    #
-    class And
-      def initialize(a = 0, b = 0) # rubocop:disable Naming/MethodParameterName
-        @a = Signals::Signal.new(a == 1)
-        @a.on_change << self
+    class And < Base
+      define_inputs :a, :b
 
-        @b = Signals::Signal.new(b == 1)
-        @b.on_change << self
+      define_outputs y: ->(a, b) { a && b }
 
-        @y = Signals::Signal.new(false)
-        evaluate
-      end
+      diagram <<~DIAGRAM
+        (A)-|
+            |AND|-(Y)
+        (B)-|
+      DIAGRAM
 
-      attr_reader :a, :b, :y
-
-      def evaluate
-        a.current && b.current ? y.on : y.off
-      end
-
-      def to_s
-        <<~CIRCUIT
-          (#{a})-|
-              |AND|-(#{y})
-          (#{b})-|
-        CIRCUIT
-      end
+      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

@@ -3,29 +3,21 @@
 module Logicuit
   module Gates
     # NOT gate
-    #
-    # (A)-|NOT|-(Y)
-    #
-    class Not
-      def initialize(a = 0) # rubocop:disable Naming/MethodParameterName
-        @a = Signals::Signal.new(a == 1)
-        @a.on_change << self
+    class Not < Base
+      define_inputs :a
 
-        @y = Signals::Signal.new(false)
-        evaluate
-      end
+      define_outputs y: ->(a) { !a } # rubocop:disable Style/SymbolProc
 
-      attr_reader :a, :y
+      diagram <<~DIAGRAM
+        (A)-|NOT|-(Y)
+      DIAGRAM
 
-      def evaluate
-        a.current ? y.off : y.on
-      end
-
-      def to_s
-        <<~CIRCUIT
-          (#{a})-|NOT|-(#{y})
-        CIRCUIT
-      end
+      truth_table <<~TRUTH_TABLE
+        | A | Y |
+        | - | - |
+        | 0 | 1 |
+        | 1 | 0 |
+      TRUTH_TABLE
     end
   end
 end

data/lib/logicuit/gates/or.rb

@@ -3,36 +3,25 @@
 module Logicuit
   module Gates
     # OR gate
-    #
-    # (A)-|
-    #     |OR|-(Y)
-    # (B)-|
-    #
-    class Or
-      def initialize(a = 0, b = 0) # rubocop:disable Naming/MethodParameterName
-        @a = Signals::Signal.new(a == 1)
-        @a.on_change << self
+    class Or < Base
+      define_inputs :a, :b
 
-        @b = Signals::Signal.new(b == 1)
-        @b.on_change << self
+      define_outputs y: ->(a, b) { a || b }
 
-        @y = Signals::Signal.new(false)
-        evaluate
-      end
+      diagram <<~DIAGRAM
+        (A)-|
+            |OR|-(Y)
+        (B)-|
+      DIAGRAM
 
-      attr_reader :a, :b, :y
-
-      def evaluate
-        a.current || b.current ? y.on : y.off
-      end
-
-      def to_s
-        <<~CIRCUIT
-          (#{a})-|
-              |OR|-(#{y})
-          (#{b})-|
-        CIRCUIT
-      end
+      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/version.rb

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

data/lib/logicuit.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
 require_relative "logicuit/version"
+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.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Koji NAKAMURA
 bindir: exe
 cert_chain: []
-date: 2025-02-26 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,9 @@ files:
 - README.md
 - Rakefile
 - lib/logicuit.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
@@ -53,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: []