No description, website, or topics provided.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
docs
lib
perf
spec
tasks
.codeclimate.yml
.editorconfig
.gitignore
.rspec
.rubocop.yml
.travis.yml
.yardopts
Dockerfile
Gemfile
LICENSE.txt
README.md
Rakefile
data_structures_101.gemspec

README.md

DataStructures101 Build Status Gem Version Code Climate Test Coverage

DataStructures101 is a simple gem that groups several implementations of common data structures usually taught in Computer Science courses. The overall goal of the gem is to provide easy to use functionality (trying to match the behavior of existing structures in Ruby) while providing the user with a framework to test and compare their implementations against.

Installation

Add this line to your application's Gemfile:

gem 'data_structures_101'

And then execute:

$ bundle

Or install it yourself as:

$ gem install data_structures_101

Usage

require 'data_structures_101'

LinkedList example

To create a LinkedList

list = DataStructures101::LinkedList.new

HashTable example

To create a hash table using separate chaining strategy:

hash = DataStructures101::ChainedHashTable.new

Heap example

To create a min heap Heap object

heap = DataStructures101::Heap.new(2,3,1, -10, min_heap: true)

Documentation

The documentation lives at the github pages. For the nitty gritty details of the implementation go to http://www.rubydoc.info/gems/data_structures_101.

You can also go through several posts on https://bitsofknowledge.net where I have discussed the implementations.

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add specs for any new or changed functionality and tests it using RSpec.

Bug reports and pull requests are welcome on GitHub at https://github.com/renehernandez/data_structures_101.

License

The gem is available as open source under the terms of the MIT License.