abstract_graph 1.0.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.swp
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Austin Lee ~D4L
+
+MIT License
+
+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.rdoc

@@ -0,0 +1,43 @@
+= This is AbstractGraph.
+
+-n a graph is an abstract representation of a set of objects where pairs of objects are connected. Not to be confused with the 2 dimensional plane that plots correlation
+
+== How to Install
+
+Add this line to your application's Gemfile:
+
+    gem 'abstract_graph'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install abstract_graph
+
+Or you can compile the project yourself:
+    
+    $ git clone https://github.com/D4L/abstractGraph.git
+    $ rake build
+
+== Usage
+
+TODO: Write usage instructions here
+
+== Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+== Authors
+
+Austin.L <b>~D4L</b>
+
+ 
+
+---
+noli umquam oblivisci: cogito ergo sum

data/Rakefile

@@ -0,0 +1,14 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+    t.rspec_opts = %w(-fs --color)
+end
+
+task :default => :spec
+
+desc "Run tests (same as rake spec)"
+task :test => :spec

data/abstract_graph.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/abstract_graph/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "abstract_graph"
+  gem.version       = AbstractGraph::VERSION
+
+  gem.authors       = ["Austin Lee ~D4L"]
+  gem.email         = ["Austin.Lee.D4L@gmail.com"]
+  gem.description   = %q{Abstract Graph is a graphing library that can create
+                         mathematical graphs and perform operatations on them.}
+  gem.summary       = %q{Mathmatical graph analysis software.}
+  gem.homepage      = "https://github.com/D4L/abstractGraph"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rspec', '~> 2.5'
+end

data/lib/abstract_graph.rb

@@ -0,0 +1,10 @@
+require "abstract_graph/version"
+require "abstract_graph/composition"
+require "abstract_graph/graph"
+
+module AbstractGraph
+
+  def self.version_string
+    "AbstractGraph version #{AbstractGraph::VERSION}"
+  end
+end

data/lib/abstract_graph/composition.rb

@@ -0,0 +1,11 @@
+# required in "abstract_graph"
+
+require "abstract_graph/composition/vertex"
+require "abstract_graph/composition/edge"
+require "abstract_graph/composition/uniquenamecollection"
+
+module AbstractGraph
+  module Composition
+
+  end
+end

data/lib/abstract_graph/composition/edge.rb

@@ -0,0 +1,21 @@
+# required in "abstract_graph/composition"
+
+module AbstractGraph
+  module Composition
+
+    # public Edge class
+    class Edge
+      attr_reader :name
+      attr_accessor :vertices
+
+      def name=(name)
+        raise ArgumentError if name.class != String
+        @name = name
+      end
+
+    end
+  end
+end
+
+require "abstract_graph/composition/edge/initialize"
+require "abstract_graph/composition/edge/is_coincident"

data/lib/abstract_graph/composition/edge/initialize.rb

@@ -0,0 +1,18 @@
+# required in "abstract_graph/composition/edge"
+
+module AbstractGraph
+  module Composition
+    class Edge
+
+      def initialize ( *args )
+        if args[0].class == String
+          @name = args[0]
+        else
+          @name = ""
+        end
+        @vertices = args[-2, 2]
+      end
+
+    end
+  end 
+end

data/lib/abstract_graph/composition/edge/is_coincident.rb

@@ -0,0 +1,15 @@
+# required in "abstract_graph/composition/edge"
+
+module AbstractGraph
+  module Composition
+    class Edge
+
+      # returns whether or not e covers the same two vertices
+      # p: Edge e is the comparing edge
+      def is_coincident? e
+        return ( ( e.vertices | @vertices ) - ( e.vertices & @vertices ) ).empty?
+      end
+
+    end
+  end
+end

data/lib/abstract_graph/composition/uniquenamecollection.rb

@@ -0,0 +1,21 @@
+# required in "abstract_graph/composition"
+
+module AbstractGraph
+  module Composition
+
+    # public UniqueNameCollection class
+    # Note that the collection of this
+    #   class must implement #name
+    class UniqueNameCollection
+      attr_accessor :collection
+      attr_accessor :otherUnique
+    end
+
+  end
+end
+
+require "abstract_graph/composition/uniquenamecollection/initialize"
+require "abstract_graph/composition/uniquenamecollection/add"
+require "abstract_graph/composition/uniquenamecollection/dup"
+require "abstract_graph/composition/uniquenamecollection/method_missing"
+require "abstract_graph/composition/uniquenamecollection/link"

data/lib/abstract_graph/composition/uniquenamecollection/add.rb

@@ -0,0 +1,19 @@
+# required in "abstract_graph/composition/uniquenamecollection"
+
+module AbstractGraph
+  module Composition
+    class UniqueNameCollection
+
+      # adds an object o into the collection
+      # p: Object o that implements #name
+      def add( o )
+        # note that otherUnique includes ourself
+        @otherUnique.each do |unc|
+          raise IndexError if unc[o.name]
+        end
+        @collection[o.name] = o
+      end
+
+    end
+  end
+end

data/lib/abstract_graph/composition/uniquenamecollection/dup.rb

@@ -0,0 +1,20 @@
+# required in "abstract_graph/composition/uniquenamecollection"
+
+module AbstractGraph
+  module Composition
+    class UniqueNameCollection
+
+      # does a deep copy of the object, in otherwords
+      #   copies every object in the collection
+      def dup
+        other = UniqueNameCollection.new
+        # copy each object in our collection over
+        @collection.each_value do |o|
+          other.add o
+        end
+        other
+      end
+
+    end
+  end
+end

data/lib/abstract_graph/composition/uniquenamecollection/initialize.rb

@@ -0,0 +1,14 @@
+# required in "abstract_graph/composition/uniquenamecollection"
+
+module AbstractGraph
+  module Composition
+    class UniqueNameCollection
+
+      def initialize
+        @collection = Hash.new
+        @otherUnique = [self]
+      end
+
+    end
+  end
+end

data/lib/abstract_graph/composition/uniquenamecollection/link.rb

@@ -0,0 +1,32 @@
+# required in "abstract_graph/composition/uniquenamecollection"
+
+module AbstractGraph
+  module Composition
+    class UniqueNameCollection
+
+      # links two collections together so that their names
+      #   will be mutually unique
+      # p: UniqueNameCollection unc is the other collection
+      #      we want to link
+      # r: false if the two collections are not already
+      #      mutually unique
+      def link( unc )
+        # note that either otherUnique may be alot
+        combinedUnique = @otherUnique | unc.otherUnique
+
+        # check if there are already any duplicates
+        allNames = []
+        combinedUnique.each do |tunc|
+          return nil if not ( tunc.keys & allNames ).empty?
+          allNames |= tunc.keys
+        end
+
+        # set each one to have the same uniquespace
+        combinedUnique.each do |tunc|
+          tunc.otherUnique = combinedUnique
+        end
+      end
+
+    end
+  end
+end

data/lib/abstract_graph/composition/uniquenamecollection/method_missing.rb

@@ -0,0 +1,14 @@
+# required in "abstract_graph/composition/uniquenamecollection"
+
+module AbstractGraph
+  module Composition
+    class UniqueNameCollection
+
+      # pass all methods into the hash
+      def method_missing( m, *args, &block )
+        @collection.send( m.to_sym, *args, &block )
+      end
+
+    end
+  end
+end

data/lib/abstract_graph/composition/vertex.rb

@@ -0,0 +1,21 @@
+# required in "abstract_graph/composition"
+
+module AbstractGraph
+  module Composition
+
+    # public Vertex class
+    class Vertex
+      attr_reader :name
+      attr_accessor :value
+
+      def name=(name)
+        raise ArgumentError if name.class != String
+        @name = name
+      end
+
+    end
+  end
+end
+
+require "abstract_graph/composition/vertex/initialize"
+require "abstract_graph/composition/vertex/delete"

data/lib/abstract_graph/composition/vertex/delete.rb

@@ -0,0 +1,12 @@
+# required in "abstract_graph/composition/vertex"
+
+module AbstractGraph
+  module Composition
+    class Vertex
+
+      def delete
+      end
+
+    end
+  end
+end

data/lib/abstract_graph/composition/vertex/initialize.rb

@@ -0,0 +1,14 @@
+# required in "abstract_graph/composition/vertex"
+
+module AbstractGraph
+  module Composition
+    class Vertex
+
+      def initialize (name="", value=nil)
+        @name = name
+        @value = value
+      end
+
+    end
+  end
+end

data/lib/abstract_graph/graph.rb

@@ -0,0 +1,25 @@
+# required in "abstract_graph"
+
+module AbstractGraph
+
+  # public Graph class
+  class Graph
+
+    # Add the vertex and edge classes
+    include Composition
+
+    attr_accessor :vertices
+    attr_accessor :edges
+
+  end
+
+end
+
+require "abstract_graph/graph/initialize"
+require "abstract_graph/graph/add_vertex"
+require "abstract_graph/graph/has_vertex"
+require "abstract_graph/graph/dup"
+require "abstract_graph/graph/delete_vertex"
+require "abstract_graph/graph/add_edge"
+require "abstract_graph/graph/has_edge"
+require "abstract_graph/graph/delete_edge"

data/lib/abstract_graph/graph/add_edge.rb

@@ -0,0 +1,30 @@
+# required in "abstract_graph/graph"
+
+module AbstractGraph
+  class Graph
+
+    # add a vertex named s to the graph joining
+    #   the vertices named v1 and v2
+    # p: String s represents name
+    #    Vertex name v1 and v2 are the two vertices
+    # r: errors when v1, v2 doesn't exist, loop, or multiple edge
+    def add_edge( s, v1, v2 )
+      v1 = @vertices[v1] or return nil
+      v2 = @vertices[v2] or return nil
+
+      raise Exception if v1 == v2
+
+      # create the edge
+      edge = Edge.new s, v1, v2
+
+      # check if it's an multiple edge
+      @edges.each_value do |e|
+        raise Exception if e.is_coincident? edge
+      end
+
+      @edges.add edge
+      self
+    end
+
+  end
+end