signed_multiset 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09a3ae9f761ec896d77d62a7a691f9fe65a20f09
-  data.tar.gz: 0f66bdd5eb798fece35bcd588bc90a50e1c22d81
+  metadata.gz: 5974015c8b24aea8ddb676594f8991c5ff7b989e
+  data.tar.gz: 6f8cbf71b0c72bddb0eb63ae3230337528df5fcd
 SHA512:
-  metadata.gz: a30b92054d69d03ebfa1947fd8505f81ce57d7f1230095ec2ffff274910232a26596c8af4df9bfba87cacaab441e6704cc9b1fcde7477969b4411282628dc382
-  data.tar.gz: 45684d6839b35ffe4c26073fd4d026064b2aa251ef8aee35eb07c1408ab1b4cfbf97d3e073dd2f4d098861a05247c64c4b8bbea4dfeeb3233ce5814ce3b3dd89
+  metadata.gz: b7976458e026b80c572ebe4ccde8fd4ac21ddb4b4dad0f42be3624c9b8d87895e74b47dc13d7379ff8fc31a14bfbe6d0abe67d7487c8d437f86c35d016c97c9d
+  data.tar.gz: b4eac8514917c458c8e559b93d4b54e12aae455675585c2ae1f75288b14e90d23bfb33a39e16c0732d6b1e83d451e2b115d00b7efc67498bf3d067904932b7d2

data/HISTORY.md

@@ -0,0 +1,4 @@
+# 0.0.2
+- New #delete method [@joshwlewis]
+# 0.0.1
+- Initial Release [@joshwlewis]

data/README.md

@@ -1,5 +1,6 @@
 # signed_multiset
 
+[![Gem Version](https://badge.fury.io/rb/signed_multiset.png)](http://badge.fury.io/rb/signed_multiset)
 [![Build Status](https://travis-ci.org/joshwlewis/signed_multiset.png?branch=master)](https://travis-ci.org/joshwlewis/signed_multiset)
 [![Code Climate](https://codeclimate.com/github/joshwlewis/signed_multiset.png)](https://codeclimate.com/github/joshwlewis/signed_multiset)
 [![Dependency Status](https://gemnasium.com/joshwlewis/signed_multiset.png)](https://gemnasium.com/joshwlewis/signed_multiset)
@@ -8,15 +9,15 @@ Signed Multiset is a Ruby implementation of a Multiset that allows negative memb
 
 You can think of it as a Multiset or Bag that allows for negative counts. It feels like a Ruby Hash or Array, but with some differences:
 
-- A key (any ruby object) can be added to or removed from the Multiset any number of times, and is referred to as it's multiplicity
+- A key (any ruby object) can be added to or removed from the SignedMultiset any number of times. The number of times it is included in the multiset (positive or negative) is referred to as it's multiplicity.
 
-- A key can only be considered a member of the Signed Multiset if it's multiplicity is not 0. Setting it's multiplicity to 0 effectively removes that item from the SignedMultiset.
+- A key can only be considered a member of the SignedMultiset if it's multiplicity is not 0. Setting it's multiplicity to 0 effectively removes that item from the SignedMultiset.
 
 - The size or length of a SignedMultiset is the number of unique keys with non-zero multiplicities.
 
 - The cardinality or sum of a SignedMultiset is the total sum of the multiplicities.
 
-For theory and proofs, refer to [Negative Membership](http://projecteuclid.org/DPubS/Repository/1.0/Disseminate?view=body&id=pdf_1&handle=euclid.ndjfl/1093635499) by Wayne D. Blizard.
+For futher reading, refer to [Negative Membership](http://projecteuclid.org/DPubS/Repository/1.0/Disseminate?view=body&id=pdf_1&handle=euclid.ndjfl/1093635499) by Wayne D. Blizard.
 
 ## Installation
 
@@ -37,23 +38,44 @@ Or install it yourself as:
 ```ruby
 require 'signed_multiset'
 
-s = SignedMultiset.new(a: 1, b: 2, c: 3)
-#=> => <SignedMultiset a: 1, b: 2, c: 3>
+set = SignedMultiset.new(a: 1, b: 2, c: 3)
+# => <SignedMultiset a: 1, b: 2, c: 3>
 
-s[:b]
-#=> 2
+set[:b]
+# => 2
 
-s[:d] = -4
-#=> -4
+set[:d] = -4
+# => -4
 
-s << :d
-#=> <SignedMultiset a: 1, b: 2, c: 3, d: -3>
+set << :d
+# => <SignedMultiset a: 1, b: 2, c: 3, d: -3>
 
-s.increment(a, -1)
-#=> 0
+set.increment(a, -1)
+# => 0
 
-s[:a]
-#=> nil
+set[:a]
+# => nil
+
+set
+# => <SignedMultiset b: 2, c: 3, d: -3>
+
+set.cardinality
+# => 2
+
+set.size
+# => 3
+
+other_set = SignedMultiset[:a, :c, :d, :d]
+# => <SignedMultiset a: 1, c: 1, d: 2>
+
+set + other_set
+# => <SignedMultiset b: 2, c: 4, d: -1, a: 1>
+
+set & other_set
+# => <SignedMultiset c: 1, d: -3>
+
+set | other_set
+=> <SignedMultiset b: 2, c: 3, d: 2, a: 1>
 ```
 
 ## Contributing

data/lib/signed_multiset/signed_multiset.rb

@@ -23,7 +23,7 @@ class SignedMultiset
   #
   # @return [Hash]
   def multiplicities
-    entries.delete_if{|k,v| v == 0}
+    entries.reject{|k,v| v == 0}
   end
 
   # Iterate over the multiplicity collection.
@@ -53,7 +53,7 @@ class SignedMultiset
   # @return [Integer] The multiplicity for the key
   def []=(key, multiplicity)
     entries[key] = multiplicity
-    multiplicities[key]
+    [key]
   end
 
   # Increment the multiplicity for a key.
@@ -64,6 +64,7 @@ class SignedMultiset
   def increment(key, value)
     entries[key] ||= 0
     entries[key] += value
+    [key]
   end
 
   # Increment multiplicity by 1 for a key. This method is chainable.
@@ -75,6 +76,14 @@ class SignedMultiset
     self
   end
 
+  # Remove key completely from the set, similar to [key]=0
+  #
+  # @param key [Object] The key to remove
+  # @return [Integer] The multiplicity of the item removed.
+  def delete(key)
+    entries.delete(key)
+  end
+
   # Creates a new instance of equal to current instance
   # @return [SignedMultiset]
   def dup
@@ -117,8 +126,7 @@ class SignedMultiset
   # @return (see #+)
   def &(other)
     (keys & other.keys).reduce(self.class.new) do |m, k|
-      value = [self[k], other[k]].min
-      m.increment(k, value); m
+      m.increment(k, [self[k], other[k]].min); m
     end
   end
 
@@ -179,11 +187,11 @@ class SignedMultiset
   end
 
   def to_s
-    multiplicities.map{ |k,c| "#{k}: #{c}"}.join(', ')
+    multiplicities.map{ |k,m| "#{k}: #{m}"}.join(', ')
   end
 
   def inspect
-    "<SignedMultiset #{to_s}>"
+    "<#{self.class} #{to_s}>"
   end
 
   private

data/lib/signed_multiset/version.rb

@@ -1,3 +1,3 @@
 class SignedMultiset
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/signed_multiset/signed_multiset_test.rb

@@ -65,7 +65,7 @@ describe SignedMultiset do
     end
   end
 
-  describe "increment" do
+  describe "#increment" do
     it "should increment existing keys" do
       subject[:bar].must_equal(2)
       subject.increment(:bar, -4)
@@ -78,7 +78,7 @@ describe SignedMultiset do
     end
   end
 
-  describe "<<" do
+  describe "#<<" do
     it "should increment existing keys" do
       subject[:bar].must_equal(2)
       subject << :bar
@@ -96,6 +96,14 @@ describe SignedMultiset do
     end
   end
 
+  describe "#delete" do
+    it "should remove the key" do
+      subject[:foo].must_equal(4)
+      subject.delete(:foo).must_equal(4)
+      subject[:foo].must_be_nil
+    end
+  end
+
   describe "#+" do
     let(:merged) { subject + other }
     it "should return a new set" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: signed_multiset
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Josh Lewis
@@ -63,6 +63,7 @@ files:
 - .ruby-version
 - .travis.yml
 - Gemfile
+- HISTORY.md
 - LICENSE.txt
 - README.md
 - Rakefile