adjacency_matrix 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 6fb2198c08ecf3cc1870acfb30419fbcfe90eb86b3bab6e42e586d3e0ca934bd
4
+ data.tar.gz: 613e04cf4ec172a0d65401e7e7bb6190c85242c7ab642a8c21532bfca2663d08
5
+ SHA512:
6
+ metadata.gz: 06f8ceaf1555d182c0e8517e05cfcdb5381ba6421ec44964d724d1ac6486059c668289d864011f3b1360d9181e0729c805bca6e40a17b39974cbb91ace6ac84b
7
+ data.tar.gz: a33fb2c9ac2381b2d76829658dc592773270b5d7e4ad27fe8dc0655e56ef81a43438ab587b10ea5a3b7d24afb75f652a82d4705503187092eb3b2b7158d902de
data/.gitignore ADDED
@@ -0,0 +1,11 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+
10
+ # rspec failure tracking
11
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.travis.yml ADDED
@@ -0,0 +1,6 @@
1
+ ---
2
+ language: ruby
3
+ cache: bundler
4
+ rvm:
5
+ - 2.7.2
6
+ before_install: gem install bundler -v 2.1.4
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at lukas.diener@hotmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [https://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: https://contributor-covenant.org
74
+ [version]: https://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,7 @@
1
+ source "https://rubygems.org"
2
+
3
+ # Specify your gem's dependencies in adjacency_matrix.gemspec
4
+ gemspec
5
+
6
+ gem "rake", "~> 12.0"
7
+ gem "rspec", "~> 3.0"
data/Gemfile.lock ADDED
@@ -0,0 +1,36 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ adjacency_matrix (0.1.0)
5
+ weighted_graph (~> 0.1.2)
6
+
7
+ GEM
8
+ remote: https://rubygems.org/
9
+ specs:
10
+ diff-lcs (1.4.4)
11
+ rake (12.3.3)
12
+ rspec (3.10.0)
13
+ rspec-core (~> 3.10.0)
14
+ rspec-expectations (~> 3.10.0)
15
+ rspec-mocks (~> 3.10.0)
16
+ rspec-core (3.10.1)
17
+ rspec-support (~> 3.10.0)
18
+ rspec-expectations (3.10.1)
19
+ diff-lcs (>= 1.2.0, < 2.0)
20
+ rspec-support (~> 3.10.0)
21
+ rspec-mocks (3.10.2)
22
+ diff-lcs (>= 1.2.0, < 2.0)
23
+ rspec-support (~> 3.10.0)
24
+ rspec-support (3.10.2)
25
+ weighted_graph (0.1.2)
26
+
27
+ PLATFORMS
28
+ ruby
29
+
30
+ DEPENDENCIES
31
+ adjacency_matrix!
32
+ rake (~> 12.0)
33
+ rspec (~> 3.0)
34
+
35
+ BUNDLED WITH
36
+ 2.1.4
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2021 Lukas_Skywalker
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,96 @@
1
+ # AdjacencyMatrix
2
+
3
+ Adjacency Matrix datastructure.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'adjacency_matrix'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle install
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install adjacency_matrix
20
+
21
+ ## Usage
22
+
23
+ ### Create a graph
24
+
25
+ ```ruby
26
+ nodes = ['A', 'B', 'C', 'D', 'E']
27
+
28
+ graph = WeightedGraph::PositiveWeightedGraph.new
29
+ graph.add_undirected_edge('A', 'B', 2)
30
+ graph.add_undirected_edge('B', 'C', 2)
31
+ graph.add_undirected_edge('C', 'D', 2)
32
+ graph.add_undirected_edge('A', 'D', 10)
33
+ graph.add_undirected_edge('B', 'E', 1)
34
+ ```
35
+
36
+ ### Create the matrix
37
+
38
+ ```ruby
39
+ matrix = AdjacencyMatrix::Matrix.new(nodes, graph)
40
+ ```
41
+
42
+ ### Accessors
43
+
44
+ Get the value of a specific edge:
45
+
46
+ ```ruby
47
+ matrix.get('A', 'D')
48
+ #=> 10
49
+ ```
50
+
51
+ Change the value of a specific edge:
52
+
53
+ ```ruby
54
+ matrix.set('A', 'D', 12)
55
+ matrix.get('A', 'D')
56
+ #=> 12
57
+ ```
58
+
59
+ Print the matrix
60
+
61
+ ```ruby
62
+ puts matrix
63
+
64
+ A B C D E
65
+ A 0 2 999999 10 999999
66
+ B 2 0 2 999999 1
67
+ C 999999 2 0 2 999999
68
+ D 10 999999 2 0 999999
69
+ E 999999 1 999999 999999 0
70
+ ```
71
+
72
+ Clone the matrix
73
+
74
+ ```ruby
75
+ copy = matrix.clone
76
+ ```
77
+
78
+
79
+ ## Development
80
+
81
+ 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.
82
+
83
+ 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).
84
+
85
+ ## Contributing
86
+
87
+ Bug reports and pull requests are welcome on GitHub at https://github.com/code-fabrik/adjacency_matrix. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/code-fabrik/adjacency_matrix/blob/master/CODE_OF_CONDUCT.md).
88
+
89
+
90
+ ## License
91
+
92
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
93
+
94
+ ## Code of Conduct
95
+
96
+ Everyone interacting in the AdjacencyMatrix project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/code-fabrik/adjacency_matrix/blob/master/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
@@ -0,0 +1,31 @@
1
+ require_relative 'lib/adjacency_matrix/version'
2
+
3
+ Gem::Specification.new do |spec|
4
+ spec.name = "adjacency_matrix"
5
+ spec.version = AdjacencyMatrix::VERSION
6
+ spec.authors = ["Lukas_Skywalker"]
7
+ spec.email = ["lukas.diener@hotmail.com"]
8
+
9
+ spec.summary = "Adjacency Matrix implementation"
10
+ spec.description = "Allows storing adjacency matrices"
11
+ spec.homepage = "https://github.com/code-fabrik/adjacency_matrix"
12
+ spec.license = "MIT"
13
+ spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
14
+
15
+ spec.metadata["allowed_push_host"] = "https://rubygems.org"
16
+
17
+ spec.metadata["homepage_uri"] = spec.homepage
18
+ spec.metadata["source_code_uri"] = "https://github.com/code-fabrik/adjacency_matrix"
19
+ spec.metadata["changelog_uri"] = "https://github.com/code-fabrik/adjacency_matrix"
20
+
21
+ # Specify which files should be added to the gem when it is released.
22
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
23
+ spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
24
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
25
+ end
26
+ spec.bindir = "exe"
27
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
28
+ spec.require_paths = ["lib"]
29
+
30
+ spec.add_runtime_dependency "weighted_graph", "~> 0.1.2"
31
+ end
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "adjacency_matrix"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,74 @@
1
+ require "adjacency_matrix/version"
2
+ require 'weighted_graph'
3
+
4
+ module AdjacencyMatrix
5
+ class Error < StandardError; end
6
+
7
+ class Matrix
8
+ attr_reader :nodes, :graph, :matrix
9
+
10
+ def initialize(nodes, graph, matrix = nil)
11
+ @nodes = nodes
12
+ @graph = graph
13
+ if matrix.nil?
14
+ @matrix = []
15
+ init_matrix
16
+ else
17
+ @matrix = matrix
18
+ end
19
+ end
20
+
21
+ # Get the distance between the two given nodes
22
+ def get(from, to)
23
+ fi = nodes.index(from)
24
+ ti = nodes.index(to)
25
+ matrix[fi][ti]
26
+ end
27
+
28
+ # Set the distance between the two given nodes
29
+ def set(from, to, value)
30
+ fi = nodes.index(from)
31
+ ti = nodes.index(to)
32
+ matrix[fi][ti] = value
33
+ end
34
+
35
+ def to_s
36
+ str = " \t" + nodes.join("\t") + "\n"
37
+ nodes.each do |from|
38
+ str += from
39
+ nodes.each do |to|
40
+ str += "\t#{get(from, to)}"
41
+ end
42
+ str += "\n"
43
+ end
44
+ return str
45
+ end
46
+
47
+ # Copy an existing matrix
48
+ def clone
49
+ Matrix.new(nodes, graph, Marshal.load(Marshal.dump(matrix)))
50
+ end
51
+
52
+ # Check for equality, i.e. if all values are the same
53
+ def ==(other)
54
+ matrix == other.matrix
55
+ end
56
+
57
+ private
58
+
59
+ def init_matrix
60
+ nodes.each_with_index do |from, fi|
61
+ matrix[fi] = []
62
+ nodes.each_with_index do |to, ti|
63
+ matrix[fi] << get_distance(from, to)
64
+ end
65
+ end
66
+ end
67
+
68
+ def get_distance(from, to)
69
+ return 0 if from == to
70
+ return 999999 if !graph.contains_edge?(from, to)
71
+ return graph.get_edge_weight(from, to)
72
+ end
73
+ end
74
+ end
@@ -0,0 +1,3 @@
1
+ module AdjacencyMatrix
2
+ VERSION = "0.1.0"
3
+ end
metadata ADDED
@@ -0,0 +1,75 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: adjacency_matrix
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Lukas_Skywalker
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2021-02-20 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: weighted_graph
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: 0.1.2
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: 0.1.2
27
+ description: Allows storing adjacency matrices
28
+ email:
29
+ - lukas.diener@hotmail.com
30
+ executables: []
31
+ extensions: []
32
+ extra_rdoc_files: []
33
+ files:
34
+ - ".gitignore"
35
+ - ".rspec"
36
+ - ".travis.yml"
37
+ - CODE_OF_CONDUCT.md
38
+ - Gemfile
39
+ - Gemfile.lock
40
+ - LICENSE.txt
41
+ - README.md
42
+ - Rakefile
43
+ - adjacency_matrix.gemspec
44
+ - bin/console
45
+ - bin/setup
46
+ - lib/adjacency_matrix.rb
47
+ - lib/adjacency_matrix/version.rb
48
+ homepage: https://github.com/code-fabrik/adjacency_matrix
49
+ licenses:
50
+ - MIT
51
+ metadata:
52
+ allowed_push_host: https://rubygems.org
53
+ homepage_uri: https://github.com/code-fabrik/adjacency_matrix
54
+ source_code_uri: https://github.com/code-fabrik/adjacency_matrix
55
+ changelog_uri: https://github.com/code-fabrik/adjacency_matrix
56
+ post_install_message:
57
+ rdoc_options: []
58
+ require_paths:
59
+ - lib
60
+ required_ruby_version: !ruby/object:Gem::Requirement
61
+ requirements:
62
+ - - ">="
63
+ - !ruby/object:Gem::Version
64
+ version: 2.3.0
65
+ required_rubygems_version: !ruby/object:Gem::Requirement
66
+ requirements:
67
+ - - ">="
68
+ - !ruby/object:Gem::Version
69
+ version: '0'
70
+ requirements: []
71
+ rubygems_version: 3.1.4
72
+ signing_key:
73
+ specification_version: 4
74
+ summary: Adjacency Matrix implementation
75
+ test_files: []