RubyStructures

Simple, useful data structures written in pure Ruby.

Installation

Add this line to your application's Gemfile:

gem 'rubystructures'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rubystructures

RubyStructures::Stack provides a First in, Last out stack implementation.

Create a new Stack:

require 'rubystructures'

@stack = RubyStructures::Stack.new

Note: by requiring rubystructures/stack instead, you can drop the RubyStructures:: prefix.

Add a value to the Stack:

@stack.push(42)
# => true

Pop a value off the Stack:

@stack.pop
# => 42

Check the size of the Stack:

@stack.size
# => 1

Take a peek at the value on the top of the Stack:

@stack.top
# => 42

Is the Stack empty?

@stack.empty?
# => false

RubyStructures::Queue implements a First in, First out queue.

Create a new Queue:

require 'rubystructures'

@queue = RubyStructures::Queue.new

Push a value onto the Queue:

@queue.push(42)
# => true

You can also use enqueue as an alias for push:

@queue.enqueue(42)
# => true

Pop a value off the Queue:

@queue.pop
# => 42

You can also use dequeue as an alias for pop:

@queue.dequeue
# => 42

Take a peek at the values at the front of back of the Queue without removing them:

@queue.front
# => 42

@queue.back
# => 7

Get the size of the Queue:

@queue.size
# => 4

Check whether or not the Queue is empty:

@queue.empty?
# => false