knapsacker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c9762687759b11f1d92bb9a0e54e44ed81850656fe3e4390728cf0fcf58241f9
+  data.tar.gz: c22a6b28e5d07062ff5ca2fc62d39fc421e5fb5b8b27cb77582c545cebb6a750
+SHA512:
+  metadata.gz: b069dd7a9f8d9048f9a6c13be447d58a8cf8f0d08ab139304a88906a8809dc42e87b0c983cfab14c68a2fa931909880a70e7d4a063f6cfaca79e4ba3e2d2335c
+  data.tar.gz: 1cc61dd7367d7806b2b4046562a7f94197ff9cd069a8415d8917faada9b61e0858a227698b8d82ad0264235f317693dde97c06e44cbd0c228089ab3690f1b056

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.6.3

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at irohiroki@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    knapsacker (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  knapsacker!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Hiroki Yoshioka
+
+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,81 @@
+# Knapsacker
+
+Knapsacker is a [Knapsack problem](https://en.wikipedia.org/wiki/Knapsack_problem) solver in Ruby, using branch and bound algorithm.
+
+It has a simple API and may solve problems in your holiday programming. (That is, it's not optimized. Yet.)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'knapsacker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install knapsacker
+
+## Usage
+
+First, instanciate Knapsacker with an array of your items. The items must respond to `value` and `cost`. And a keyword argument `capacity` is mandatory. e.g.:
+
+```ruby
+Item = Struct.new(:value, :cost)
+knapsacker = Knapsacker.new([Item.new(3, 4), Item.new(4, 5)], capacity: 5)
+```
+
+Then call `pack`:
+
+```ruby
+items_to_take = knapsacker.pack
+```
+
+It will return items you should take.
+
+### Similar projects
+
+There are some knapsack problem solver in Ruby but none has API. (Some of them accepts items as command line arguments or data in file.)
+
+* [danielsellergren/ruby-knapsack](https://github.com/danielsellergren/ruby-knapsack) ... Accepts command line arguments
+* [sucanjan/knapsack-solver](https://github.com/sucanjan/knapsack-solver) ... Accepts data files, Gnuplot-able
+* [soulcutter/no_change_please](https://github.com/soulcutter/no_change_please) ... Accepts a data file
+* [mertbulan/knapsack-problem](https://github.com/mertbulan/knapsack-problem) ... No API
+* [pedroperrone/knapsack-problem](https://github.com/pedroperrone/knapsack-problem) ... No API
+* [shouheiyamauchi/KnapsackProblemSolver](https://github.com/shouheiyamauchi/KnapsackProblemSolver) ... No API
+* [Adacchi3/KnapsackProblem](https://github.com/Adacchi3/KnapsackProblem) ... No API
+* [sas145alex/knapsack_greedy](https://github.com/sas145alex/knapsack_greedy) ... No API
+* [bsmlima/connected-knapsack](https://github.com/bsmlima/connected-knapsack) ... No README
+* [mhartman4/fanduel-scrape](https://github.com/mhartman4/fanduel-scrape) ... No README
+
+### Roadmap
+
+* 1.0
+  * Interface to support the general form of Knapsack problem, including:
+    * Multiple inequality constraints
+    * Multiple equality constraints
+  * Spport for items that have interface other than `value` and `cost`
+* 1.1
+  * Some optimization, maybe. Either in C, either with some smarter algorithm.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/irohiroki/knapsacker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Knapsacker project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/irohiroki/knapsacker/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "knapsacker"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/knapsacker.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "knapsacker/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "knapsacker"
+  spec.version       = Knapsacker::VERSION
+  spec.authors       = ["Hiroki Yoshioka"]
+  spec.email         = ["irohiroki@gmail.com"]
+
+  spec.summary       = %q{Knapsack problem solver with a simple API}
+  spec.description   = %q{Knapsacker is a Knapsack (combinatorial opimization) problem solver with Branch and bound algorithm.}
+  spec.homepage      = "https://github.com/irohiroki/knapsacker"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/knapsacker.rb

@@ -0,0 +1,80 @@
+require "set"
+
+require "knapsacker/node"
+require "knapsacker/version"
+
+class Knapsacker
+  def initialize(items, capacity:)
+    @items = items.sort {|a, b| b.value.to_f / b.cost <=> a.value.to_f / a.cost } # TODO assert cost
+    @capacity = capacity
+    @candidates = SortedSet.new
+  end
+
+  def pack
+    make_initial_node
+
+    loop do
+      node = select_node_to_grow
+      if node
+        grow(node, node.item_index + 1)
+      else
+        return node_with_highest_value.items
+      end
+    end
+  end
+
+  def grow(node, next_index)
+    next_item = @items[next_index]
+
+    if node.positive_child_growable?
+      if next_item && node.cost + next_item.cost <= @capacity
+        upper_bound = node.value + next_item.value + upper_bound_beyond(next_index, capacity: @capacity - node.cost - next_item.cost)
+        node.positive_child = Node.new(next_index, next_item, upper_bound, node)
+        @candidates << node.positive_child
+      else
+        node.cap_positive_child!
+      end
+    elsif node.negative_child_growable?
+      if next_item
+        upper_bound = node.value + upper_bound_beyond(next_index, capacity: @capacity - node.cost)
+        node.negative_child = Node.new(next_index, nil, upper_bound, node)
+        @candidates << node.negative_child
+        @candidates.delete(node)
+      else
+        node.cap_negative_child!
+      end
+    end
+  end
+
+  def upper_bound_beyond(prev_index, capacity: capacity)
+    index = prev_index + 1
+    item = @items[index]
+
+    return 0 unless item
+
+    if item.cost > capacity
+      item.value.to_f * capacity / item.cost
+    else
+      item.value + upper_bound_beyond(index, capacity: capacity - item.cost)
+    end
+  end
+
+  private
+    def make_initial_node
+      @candidates << Node.new(-1, nil, upper_bound_beyond(-1, capacity: @capacity), nil)
+    end
+
+    def select_node_to_grow
+      hopeful_node = @candidates.first
+
+      unless hopeful_node.leaf?
+        hopeful_node
+      end
+    end
+
+    def node_with_highest_value
+      @candidates.reduce do |provisional, candidate|
+        provisional.value >= candidate.value ? provisional : candidate
+      end
+    end
+end

data/lib/knapsacker/node.rb

@@ -0,0 +1,71 @@
+class Knapsacker
+  class Node
+    attr_accessor :negative_child
+    attr_accessor :positive_child
+    attr_reader :item_index
+    attr_reader :upper_bound
+
+    def initialize(item_index, item, upper_bound, parent)
+      @item_index  = item_index
+      @item        = item
+      @upper_bound = upper_bound
+      @parent      = parent
+    end
+
+    def <=>(other)
+      if other.upper_bound == upper_bound
+        other.item_index <=> item_index
+      else
+        other.upper_bound <=> upper_bound
+      end
+    end
+
+    def cap_negative_child!
+      @negative_child = :cap
+    end
+
+    def cap_positive_child!
+      @positive_child = :cap
+    end
+
+    def cost
+      if @parent
+        @parent.cost + (@item ? @item.cost : 0)
+      else
+        0
+      end
+    end
+
+    def items
+      if @parent
+        if @item
+          @parent.items << @item
+        else
+          @parent.items
+        end
+      else
+        []
+      end
+    end
+
+    def leaf?
+      @negative_child == :cap && @positive_child == :cap
+    end
+
+    def negative_child_growable?
+      @negative_child.nil?
+    end
+
+    def positive_child_growable?
+      @positive_child.nil?
+    end
+
+    def value
+      if @parent
+        @parent.value + (@item ? @item.value : 0)
+      else
+        0
+      end
+    end
+  end
+end

data/lib/knapsacker/version.rb

@@ -0,0 +1,3 @@
+class Knapsacker
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: knapsacker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hiroki Yoshioka
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Knapsacker is a Knapsack (combinatorial opimization) problem solver with
+  Branch and bound algorithm.
+email:
+- irohiroki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- knapsacker.gemspec
+- lib/knapsacker.rb
+- lib/knapsacker/node.rb
+- lib/knapsacker/version.rb
+homepage: https://github.com/irohiroki/knapsacker
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Knapsack problem solver with a simple API
+test_files: []