Sha256: cb669a7108a484b0577d76b337c3de512ebbe22340b5e68eec5dfe210c3fbd52
Contents?: true
Size: 1.71 KB
Versions: 1
Compression:
Stored size: 1.71 KB
Contents
# Haversack Haversack is an enumerable abstraction of a [Knapsack](https://en.wikipedia.org/wiki/Knapsack_problem). ## Usage #### Basic Usage: ```ruby require 'haversack' haversack = Sack.new(capacity: 10, weight: 10) items = Array.new(10) { Haversack::Item.new(weight: 1, size: 1) } haversack.contents = items ``` Only objects of the `Haversack::Item` class may be added to a haversack's contents. #### Haversack provides constraints upon what items may be set as the knapsack contents: ```ruby too_large = Array.new(haversack.capacity + 1) { Haversack::Item.new } haversack.contents = too_large # => Haversack::KnapsackCapacityExceededError ``` #### Or you may add one item at a time ```ruby item = Haversack::Item.new haversack.push item if haversack.fits_item? item ``` ## Installation Add this line to your application's Gemfile: ```ruby gem 'haversack' ``` And then execute: $ bundle Or install it yourself as: $ gem install haversack ## 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). ## Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/haversack. ## License The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
Version data entries
1 entries across 1 versions & 1 rubygems
Version | Path |
---|---|
haversack-0.3.0 | README.md |