weighted_graph 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 41020baf8d67aa652af02d9f7a5068c297a3cb8a
+  data.tar.gz: f8e571e67392eae819f7275ff7c4ad3ffa421e52
+SHA512:
+  metadata.gz: 991a975216c7a5395bd4af8d4a26edb4ce7f7bb839d0cf71762975a4f97d3530a3e4d34332e195bb7b8599b953ca6b22e989ca69d098f63f8a99c087f93085f7
+  data.tar.gz: 98de78724c26e51f49f7dbf1b9747508667f0150ddc814f241cd23f303d19a99265bc011626870bb6f3cfb84f59eed37661015a3dc7b216cff06bbb59b8360d7

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop

@@ -0,0 +1,2 @@
+--rails
+--display-cop-names

data/.rubocop.yml

@@ -0,0 +1,11 @@
+Style/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+cache: bundler
+
+before_install: gem install bundler -v 1.14.6
+before_script: bundle install
+script: bundle exec rake spec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Mark Sayson
+
+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,54 @@
+# weighted_graph
+
+weighted_graph is a simple Ruby library for working on graphs with weighted edges.
+
+## WeightedGraph::Graph API
+
+```ruby
+# Add directed edge (source, destination) to the graph with given weight
+add_edge(source, destination, weight)
+
+# Add undirected edge (vertex_a, vertex_b) to the graph with given weight
+add_undirected_edge(vertex_a, vertex_b, weight)
+
+# Remove directed edge (source, destination) from the graph
+remove_edge(source, destination)
+
+# Remove undirected edge (vertex_a, vertex_b) from the graph
+remove_undirected_edge(vertex_a, vertex_b)
+
+# Return true iff the graph contains directed edge (source, destination)
+contains_edge?(source, destination)
+
+# Returns the weight of directed edge (source, destination),
+# or returns Float::INFINITY if no such edge exists
+get_edge_weight(source, destination)
+
+# Returns the set of vertices v_i where edge (source, v_i) is in the graph
+get_adjacent_vertices(source)
+```
+
+<!-- TODO: Add installation section after publishing the gem.
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'weighted_graph'
+```
+
+Or install it yourself as:
+
+    $ gem install weighted_graph -->
+
+## 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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/msayson/weighted_graph.
+
+## License
+
+The weighted_graph library is open source and available under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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 'weighted_graph'
+
+# 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/lib/weighted_graph.rb

@@ -0,0 +1,6 @@
+require 'weighted_graph/version'
+require_relative './weighted_graph/graph'
+
+# A simple graph with weighted edges
+module WeightedGraph
+end

data/lib/weighted_graph/graph.rb

@@ -0,0 +1,62 @@
+require 'set'
+
+# A simple graph with weighted edges
+module WeightedGraph
+  # Graph API
+  class Graph
+    # Initialize a graph with an optional adjacency list
+    def initialize(edges = Hash.new(0))
+      @edges = edges
+    end
+
+    # Add directed edge (source, destination) to the graph with given weight
+    def add_edge(source, destination, weight)
+      if @edges.key?(source)
+        @edges[source][destination] = weight
+      else
+        @edges[source] = { destination => weight }
+      end
+    end
+
+    # Add undirected edge (vertex_a, vertex_b) to the graph with given weight
+    def add_undirected_edge(vertex_a, vertex_b, weight)
+      add_edge(vertex_a, vertex_b, weight)
+      add_edge(vertex_b, vertex_a, weight)
+    end
+
+    # Remove directed edge (source, destination) from the graph
+    def remove_edge(source, destination)
+      @edges[source].delete(destination) if @edges.key?(source)
+    end
+
+    # Remove undirected edge (vertex_a, vertex_b) from the graph
+    def remove_undirected_edge(vertex_a, vertex_b)
+      remove_edge(vertex_a, vertex_b)
+      remove_edge(vertex_b, vertex_a)
+    end
+
+    # Return true iff the graph contains directed edge (source, destination)
+    def contains_edge?(source, destination)
+      @edges.key?(source) && @edges[source].key?(destination)
+    end
+
+    # Returns the weight of directed edge (source, destination),
+    # or returns Float::INFINITY if no such edge exists
+    def get_edge_weight(source, destination)
+      if contains_edge?(source, destination)
+        @edges[source][destination]
+      else
+        Float::INFINITY
+      end
+    end
+
+    # Returns the set of vertices v_i where edge (source, v_i) is in the graph
+    def get_adjacent_vertices(source)
+      adjacent_array = []
+      if @edges.key?(source)
+        adjacent_array = @edges[source].map { |dst, _weight| dst }
+      end
+      Set.new(adjacent_array)
+    end
+  end
+end

data/lib/weighted_graph/version.rb

@@ -0,0 +1,3 @@
+module WeightedGraph
+  VERSION = '0.1.1'.freeze
+end

data/weighted_graph.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'weighted_graph/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'weighted_graph'
+  spec.version       = WeightedGraph::VERSION
+  spec.authors       = ['Mark Sayson']
+  spec.email         = ['masayson@gmail.com']
+
+  spec.summary       = 'A simple weighted graph implementation.'
+  spec.description   = 'A simple weighted graph implementation that stores ' \
+                       'edges in an adjacency list.'
+  spec.homepage      = 'https://github.com/msayson/weighted_graph'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org.
+  # To allow pushes either set the 'allowed_push_host' to allow pushing to
+  # a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org/gems/weighted_graph'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |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', '~> 1.14'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: weighted_graph
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Mark Sayson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !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: A simple weighted graph implementation that stores edges in an adjacency
+  list.
+email:
+- masayson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/weighted_graph.rb
+- lib/weighted_graph/graph.rb
+- lib/weighted_graph/version.rb
+- weighted_graph.gemspec
+homepage: https://github.com/msayson/weighted_graph
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/gems/weighted_graph
+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.6.11
+signing_key: 
+specification_version: 4
+summary: A simple weighted graph implementation.
+test_files: []