bliftax 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 785167c0e657e38b987fd032dacacfeb2b31229e
-  data.tar.gz: 8144130dde9b34a98b76fb67d940cd81ee861d3d
+  metadata.gz: 95f21014af5db3e266688d3f20d31b817a11708c
+  data.tar.gz: 0d8c9011f2c4a9f36153d32f780cc843138dca3b
 SHA512:
-  metadata.gz: 769d3fea118d3ee1c2bac90fa5c727f7eb49f5c8ee2c68cc3e6ff3ec511491d47b1ede6b40ad4dbb988ac739cd8340dcdd677f1d4668b9b66e41b9e291d8c444
-  data.tar.gz: b804198d60ee236c8a3084a879fe6630acf38a319b8d6b9aa7b92563fcc825fe4f13209e20c307e46a316ce46266ccd4541afbd4d82f410e4878ad98df47c4f2
+  metadata.gz: a1544c38fcc1755a1d1fb9268f211dc85025219c1aadf586edc917d3e059db9290a08b1269a32c429cd10a65c4b0c6fd39474d6a0551a4111e9bf757f95f7a9f
+  data.tar.gz: 7ed62be87398dd05a1a66495f5fd72d98e5f01b0a675621945b19eebd389ac82d38d4e99106044ea99a7ebb332cd76ad0285ea52594c3395af1ca1ed1ba3b9c5

data/bliftax.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Naoki Mizuno"]
   spec.email         = ["nigorojr@gmail.com"]
 
-  spec.summary       = 'A library that parses BLIF files and do logic optimization'
+  spec.summary       = 'A library that parses BLIF files and does logic optimization'
   spec.homepage      = 'https://github.com/NigoroJr/bliftax'
   spec.license       = "MIT"
 

data/lib/bliftax.rb

@@ -22,7 +22,7 @@ class Bliftax
 
   # Initializes the object.
   #
-  # @param str [String] filename or text to parse
+  # @param str [String] filename or text to parse.
   def initialize(str = nil)
     @latches = []
     @clocks = []
@@ -93,7 +93,7 @@ class Bliftax
 
   # Returns a string representation of this gate in BLIF format.
   #
-  # @return [String] this gate in BLIF format
+  # @return [String] this gate in BLIF format.
   def to_blif
     in_labels = @inputs.join(SPACE)
     out_labels = @outputs.join(SPACE)
@@ -120,7 +120,7 @@ class Bliftax
 
   # Duplicates this object.
   #
-  # @return the deep copy of this object.
+  # @return [Bliftax] the deep copy of this object.
   def dup
     copy = Bliftax.new
     copy.name = @name.dup
@@ -138,7 +138,7 @@ class Bliftax
   # logical line (removing comments and joining lines that end with
   # backslash with the next line).
   #
-  # @param fh [IO] File handle
+  # @param fh [IO] the file handle to read from.
   #
   # @return [Array] each element being the logical lines with comments and
   #   backslashes removed. Lines ending with a backslash gets joined with the
@@ -173,18 +173,18 @@ class Bliftax
 
   # Removes the trailing comments from a string.
   #
-  # @param str [String] the original string
+  # @param str [String] the original string.
   #
-  # @return [String] string with the trailing whitespace and comments removed
+  # @return [String] string with the trailing whitespace and comments removed.
   def strip_comments(str)
     str.sub(/\s*\#.*$/, EMPTY).strip
   end
 
   # Removes the trailing backslash from a string.
   #
-  # @param str [String] the original string
+  # @param str [String] the original string.
   #
-  # @return [String] string with the trailing backslash removed
+  # @return [String] string with the trailing backslash removed.
   def strip_trailing_backslash(str)
     str.sub(/\\/, EMPTY)
   end

data/lib/bliftax/gate.rb

@@ -24,6 +24,8 @@ class Bliftax
     #   being the output bit. For example, '010 1' represents the three inputs
     #   being 0, 1, 0 and the output being 1 in this case. If an Array is
     #   given, it will add all of the implicants.
+    #
+    # @return [Gate] the gate itself.
     def add_implicant(implicant)
       case implicant
       when Implicant
@@ -34,6 +36,7 @@ class Bliftax
         # Recursive call
         implicant.each { |i| add(i) }
       end
+      self
     end
     alias_method :<<, :add_implicant
 
@@ -55,7 +58,7 @@ class Bliftax
 
     # Returns a string representation of this gate in BLIF format.
     #
-    # @return [String] this gate in BLIF format
+    # @return [String] this gate in BLIF format.
     def to_blif
       str = format(".names %s %s\n",
                    @input_labels.join(SPACE),

data/lib/bliftax/implicant.rb

@@ -360,7 +360,7 @@ class Bliftax
 
     # Checks whether all the bits are either 1, 0, or DC.
     #
-    # @param bits [Array<String>]
+    # @param bits [Array<String>] the bits to be checked.
     #
     # @return [true, false] true if all the bits are 1, 0, or DC.
     def bits_valid?(bits)

data/lib/bliftax/implicant/bit.rb

@@ -30,12 +30,23 @@ class Bliftax
 
       # Checks for equality.
       #
-      # @param other [Object] whatever to compare against
+      # @param other [Object] whatever to compare against.
+      #
+      # @return [true, false] true if two bits are equal, false otherwise.
       def ==(other)
         @bit == other.bit && @type == other.type
       end
       alias_method :eql?, :==
 
+      # Checks for inequality.
+      #
+      # @param other [Object] whatever to compare against.
+      #
+      # @return [true, false] true if two bits are not equal, false otherwise.
+      def !=(other)
+        @bit != other.bit || @type != other.type
+      end
+
       # Returns the hash value of this instance.
       #
       # @return [Integer] the hash value of this instance.

data/lib/bliftax/optimizer.rb

@@ -5,7 +5,7 @@ class Bliftax
 
     # Does 2-level logic optimization to the given gate (a set of implicants).
     # This is done in the following steps (as described in the book
-    # Fundamentals of Digital Logic with Verilog Design.
+    # Fundamentals of Digital Logic with Verilog Design).
     #
     # 1. Find all prime implicants by using the star operator until the
     #    resulting set of implicants is the same as the previous round.
@@ -123,7 +123,7 @@ class Bliftax
     #
     # @param what [Implicant, #to_a<#cost>] the thing to be evaluated.
     #
-    # @return the evaluated cost
+    # @return the evaluated cost.
     def cost(what)
       return what.cost if what.is_a?(Bliftax::Implicant)
 
@@ -140,6 +140,9 @@ class Bliftax
     # @param to_cover [Set<Integer>] the set of minterms that need to be
     #   covered.
     # @param options [Set<Implicant>] the set of implicants to choose from.
+    #
+    # @return [Set<Implicant>] a set of implicants that has achieves the cover
+    #   in the minimum cost.
     def branching(to_cover, options)
       to_use = Set.new
       options.dup.each do |implicant|

data/lib/bliftax/version.rb

@@ -1,3 +1,3 @@
 class Bliftax
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bliftax
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Naoki Mizuno
@@ -99,6 +99,6 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: A library that parses BLIF files and do logic optimization
+summary: A library that parses BLIF files and does logic optimization
 test_files: []
 has_rdoc: