signed_multiset 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 09a3ae9f761ec896d77d62a7a691f9fe65a20f09
+  data.tar.gz: 0f66bdd5eb798fece35bcd588bc90a50e1c22d81
+SHA512:
+  metadata.gz: a30b92054d69d03ebfa1947fd8505f81ce57d7f1230095ec2ffff274910232a26596c8af4df9bfba87cacaab441e6704cc9b1fcde7477969b4411282628dc382
+  data.tar.gz: 45684d6839b35ffe4c26073fd4d026064b2aa251ef8aee35eb07c1408ab1b4cfbf97d3e073dd2f4d098861a05247c64c4b8bbea4dfeeb3233ce5814ce3b3dd89

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p195

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in signed_multiset.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Josh Lewis
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# 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)
+
+Signed Multiset is a Ruby implementation of a Multiset that allows negative membership.
+
+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 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.
+
+- 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'signed_multiset'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install signed_multiset
+
+## Usage
+
+```ruby
+require 'signed_multiset'
+
+s = SignedMultiset.new(a: 1, b: 2, c: 3)
+#=> => <SignedMultiset a: 1, b: 2, c: 3>
+
+s[:b]
+#=> 2
+
+s[:d] = -4
+#=> -4
+
+s << :d
+#=> <SignedMultiset a: 1, b: 2, c: 3, d: -3>
+
+s.increment(a, -1)
+#=> 0
+
+s[:a]
+#=> nil
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+end
+
+task default: [:test]

data/lib/signed_multiset.rb

@@ -0,0 +1,2 @@
+require "signed_multiset/version"
+require "signed_multiset/signed_multiset"

data/lib/signed_multiset/signed_multiset.rb

@@ -0,0 +1,198 @@
+class SignedMultiset
+
+  include Enumerable
+  include Comparable
+
+  # Create a new instance with a list of objects.
+  #
+  # @param *list [Object] A list of objects to add to the set
+  def self.[](*list)
+    new(list)
+  end
+
+  # Create a new SignedMultiset instance.
+  #
+  # @param object [Enumerable, nil] An array of keys, or key-muliplicity pairs.
+  def initialize(object=nil)
+    if object.is_a?(Enumerable)
+      object.each { |k, v| increment(k, v || 1) }
+    end
+  end
+
+  # Get the non-zero key-multiplicity pairs.
+  #
+  # @return [Hash]
+  def multiplicities
+    entries.delete_if{|k,v| v == 0}
+  end
+
+  # Iterate over the multiplicity collection.
+  #
+  # @return [Enumerator]
+  def each(*args, &block)
+    if block_given?
+      multiplicities.each { |k,v| yield(k,v) }
+    else
+      multiplicities.each(args)
+    end
+  end
+
+  # Get the multiplicity for a key.
+  #
+  # @param key [Object] The key to get the multiplicity of
+  # @return [Integer, nil] The multiplicity for the key, or nil if the key is
+  #   not present, or has a zero multiplicity
+  def [](key)
+    multiplicities[key]
+  end
+
+  # Set the multiplicity for a key.
+  #
+  # @param key [Object] The key to set the multiplicity of
+  # @param multiplicity [Integer] The desired multiplicity
+  # @return [Integer] The multiplicity for the key
+  def []=(key, multiplicity)
+    entries[key] = multiplicity
+    multiplicities[key]
+  end
+
+  # Increment the multiplicity for a key.
+  #
+  # @param key (see #[]=)
+  # @param value [Integer] The desired increment value, positive or negative
+  # @return (see #[]=)
+  def increment(key, value)
+    entries[key] ||= 0
+    entries[key] += value
+  end
+
+  # Increment multiplicity by 1 for a key. This method is chainable.
+  #
+  # @param key [Object] The key to increment the multiplicity of
+  # @return [self]
+  def <<(key)
+    increment(key, 1)
+    self
+  end
+
+  # Creates a new instance of equal to current instance
+  # @return [SignedMultiset]
+  def dup
+    self.class.new(multiplicities)
+  end
+
+  # Combine self with another SignedMultiset via addition to create a merged instance.
+  #
+  # @param other [SignedMultiset]
+  # @return [SignedMultiset]
+  def +(other)
+    other.multiplicities.reduce(self.dup) do |m, (k, v)|
+      m.increment(k,v); m
+    end
+  end
+
+  # Combine self with another SignedMultiset via subtraction to create a merged instance.
+  #
+  # @param other (see #+)
+  # @return (see #+)
+  def -(other)
+    other.multiplicities.reduce(self.dup) do |m, (k, v)|
+      m.increment(k,-v); m
+    end
+  end
+
+  # Combine self with another SignedMultiset via union to create a merged instance.
+  #
+  # @param other (see #+)
+  # @return (see #+)
+  def |(other)
+    (keys | other.keys).reduce(self.class.new) do |m, k|
+      m.increment(k, [self[k] || 0, other[k] || 0].max); m
+    end
+  end
+
+  # Combine self with another SignedMultiset via intersection to create a merged instance.
+  #
+  # @param other (see #+)
+  # @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
+    end
+  end
+
+  # Get the list of keys for self.
+  #
+  # @return [Array]
+  def keys
+    multiplicities.keys
+  end
+
+  # Get the multiplicity values for self.
+  #
+  # @return [Array]
+  def values
+    multiplicities.values
+  end
+
+  # Get the cardinality (sum of multiplicities) for self.
+  #
+  # @return [Integer]
+  def cardinality
+    values.inject(&:+)
+  end
+  alias_method :sum, :cardinality
+
+  # Get the count of unique keys in the SignedMultiset.
+  #
+  # @return [Integer]
+  def size
+    keys.size
+  end
+  alias_method :length, :size
+
+  # Compare self with another SignedMultiset
+  #
+  # @param other (see #+)
+  # @return [-1,0,1]
+  def <=>(other)
+    if [:multiplicities, :cardinality, :size].all? { |m| other.respond_to?(m) }
+      if multiplicities == other.multiplicities
+        0
+      elsif cardinality != other.cardinality
+        cardinality <=> other.cardinality
+      elsif size != other.size
+        size <=> other.size
+      else
+        multiplicities <=> other.multiplicities
+      end
+    end
+  end
+
+  def to_hash
+    multiplicities.dup
+  end
+
+  def to_a
+    multiplicities.to_a
+  end
+
+  def to_s
+    multiplicities.map{ |k,c| "#{k}: #{c}"}.join(', ')
+  end
+
+  def inspect
+    "<SignedMultiset #{to_s}>"
+  end
+
+  private
+
+  # Get the key-multiplicity pairs (even those with zero multiplicities).
+  #
+  # @return [Hash]
+  def entries
+    @entries ||= {}
+  end
+
+end

data/lib/signed_multiset/version.rb

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

data/signed_multiset.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'signed_multiset/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "signed_multiset"
+  spec.version       = SignedMultiset::VERSION
+  spec.authors       = ["Josh Lewis"]
+  spec.email         = ["josh.w.lewis@gmail.com"]
+  spec.description   = %q{Multisets with negative membership}
+  spec.summary       = %q{Signed Multiset is a Ruby implementation of a Multiset that allows negative membership. 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.}
+  spec.homepage      = "http://github.com/joshwlewis/signed_multiset"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+
+end

data/test/signed_multiset/signed_multiset_test.rb

@@ -0,0 +1,196 @@
+require 'test_helper'
+
+describe SignedMultiset do
+  subject { SignedMultiset.new(foo: 4, bar: 2, baz: 0) }
+  let(:other){ SignedMultiset.new(foo: -3, qux: 2) }
+
+  describe "#initialize" do
+    it "must accept a hash" do
+      subject.keys.must_equal([:foo, :bar])
+    end
+    it "must accept no arguments" do
+      set = SignedMultiset.new
+      set.keys.must_equal([])
+    end
+    it "must accept an Array" do
+      set = SignedMultiset.new([:a, :b, :c, :a, :b])
+      set.keys.must_equal([:a, :b, :c])
+    end
+    it "must accept a SignedMultiset" do
+      set = SignedMultiset.new(subject)
+      set.keys.must_equal([:foo, :bar])
+    end
+  end
+
+  describe "::[]" do
+    it "must create a new set" do
+      set = SignedMultiset[:a, :b, :b, :c]
+      set.keys.must_equal([:a, :b, :c])
+    end
+  end
+
+  describe "multiplicities" do
+    it "must be an Enumerable" do
+      subject.multiplicities.must_be_kind_of(Enumerable)
+    end
+    it "should delete keys with zero multiplicitys" do
+      subject.multiplicities.keys.must_equal([:foo, :bar])
+    end
+  end
+
+  describe "#[]" do
+    it "must find existing keys and return multiplicity" do
+      subject[:foo].must_equal(4)
+      subject[:bar].must_equal(2)
+    end
+    it "must return nil for missing keys" do
+      subject[:qux].must_be_nil
+    end
+    it "must return nil for keys with zero multiplicitys" do
+      subject[:bax].must_be_nil
+    end
+  end
+
+  describe "#[]=" do
+    it "must set multiplicity for exisiting keys" do
+      subject[:foo].must_equal(4)
+      subject[:foo] = -1
+      subject[:foo].must_equal(-1)
+    end
+
+    it "must increment key and set multiplicity for new keys" do
+      subject[:baz].must_be_nil
+      subject[:baz] = 3
+      subject[:baz].must_equal(3)
+    end
+  end
+
+  describe "increment" do
+    it "should increment existing keys" do
+      subject[:bar].must_equal(2)
+      subject.increment(:bar, -4)
+      subject[:bar].must_equal(-2)
+    end
+    it "should increment new keys" do
+      subject[:qux].must_be_nil
+      subject.increment(:qux, 2)
+      subject[:qux].must_equal(2)
+    end
+  end
+
+  describe "<<" do
+    it "should increment existing keys" do
+      subject[:bar].must_equal(2)
+      subject << :bar
+      subject[:bar].must_equal(3)
+    end
+    it "should increment new keys" do
+      subject[:qux].must_be_nil
+      subject << :qux
+      subject[:qux].must_equal(1)
+    end
+    it "should be chainable" do
+      subject << :foo << :baz << :foo
+      subject[:foo].must_equal(6)
+      subject[:baz].must_equal(1)
+    end
+  end
+
+  describe "#+" do
+    let(:merged) { subject + other }
+    it "should return a new set" do
+      merged.must_be_instance_of(SignedMultiset)
+      merged.wont_equal(subject)
+      merged.wont_equal(other)
+    end
+    it "should sum the keys" do
+      merged[:foo].must_equal(1)
+      merged[:bar].must_equal(2)
+      merged[:qux].must_equal(2)
+    end
+  end
+
+  describe "#-" do
+    let(:merged) { subject - other }
+    it "should return a new set" do
+      merged.must_be_instance_of(SignedMultiset)
+      merged.wont_equal(subject)
+      merged.wont_equal(other)
+    end
+    it "should sum the keys" do
+      merged[:foo].must_equal(7)
+      merged[:bar].must_equal(2)
+      merged[:qux].must_equal(-2)
+    end
+  end
+
+  describe "#&" do
+    let(:merged) { subject & other }
+    it "should reutrn a new set" do
+      subject.must_be_instance_of(SignedMultiset)
+      merged.wont_equal(subject)
+      merged.wont_equal(other)
+    end
+    it "should return the intersection" do
+      merged[:foo].must_equal(-3)
+      merged[:bar].must_be_nil
+      merged[:baz].must_be_nil
+      merged[:qux].must_be_nil
+    end
+  end
+
+  describe "#|" do
+    let(:merged) { subject | other }
+    it "should reutrn a new set" do
+      subject.must_be_instance_of(SignedMultiset)
+      merged.wont_equal(subject)
+      merged.wont_equal(other)
+    end
+    it "should return the union" do
+      merged[:foo].must_equal(4)
+      merged[:bar].must_equal(2)
+      merged[:baz].must_be_nil
+      merged[:qux].must_equal(2)
+    end
+  end
+
+  describe "#to_hash" do
+    it "should return a hash" do
+      subject.to_hash.must_equal(foo: 4, bar: 2)
+    end
+  end
+
+  describe "#to_a" do
+    it "should return an Array" do
+      subject.to_a.must_equal([[:foo, 4], [:bar, 2]])
+    end
+  end
+
+  describe "#cardinality" do
+    it "should return the total of all multiplicitys" do
+      subject.cardinality.must_equal(6)
+    end
+  end
+
+  describe "#size" do
+    it "should return the multiplicity of non-zero keys" do
+      subject.size.must_equal(2)
+    end
+  end
+
+  describe "#<=>" do
+    let(:small) { SignedMultiset[:foo, :bar] }
+    let(:large) { SignedMultiset[:foo, :bar, :baz, :foo, :bar, :qux, :foo, :bar] }
+    let(:equal) { subject.dup }
+
+    it "should return 1 when compared to a smaller set" do
+      (subject <=> small).must_equal(1)
+    end
+    it "should return -1 when compared to a larger set" do
+      (subject <=> large).must_equal(-1)
+    end
+    it "should return 0 when compared to an equal set" do
+      (subject <=> equal).must_equal(0)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'signed_multiset'
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'minitest/pride'

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: signed_multiset
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Josh Lewis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Multisets with negative membership
+email:
+- josh.w.lewis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/signed_multiset.rb
+- lib/signed_multiset/signed_multiset.rb
+- lib/signed_multiset/version.rb
+- signed_multiset.gemspec
+- test/signed_multiset/signed_multiset_test.rb
+- test/test_helper.rb
+homepage: http://github.com/joshwlewis/signed_multiset
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: Signed Multiset is a Ruby implementation of a Multiset that allows negative
+  membership. 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.
+test_files:
+- test/signed_multiset/signed_multiset_test.rb
+- test/test_helper.rb
+has_rdoc: