overlap 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3d4dabbb1d2f5b4271c383006c00cd3b5da83e7
+  data.tar.gz: 30234480bf410c5f2df3440cb658a3d9561b823b
+SHA512:
+  metadata.gz: a41667c84d3e2cb30bd77f7ef5eff2d6288fb0b889ec3226a0a9b6471ecc4e81903bf3a5f36ee9dbeb5284ca6d075beaaffe77531f05bfd012ffc7a7d5043a1d
+  data.tar.gz: 3ab1286d13326784599e917903718bac56f361bfacf570d4b9b0d76f4110a4a2bea82aaeef63c87a33c07bfae057b18da2e8ad8cda9c3c63b5aee63f4e637858

data/.byebug_history

@@ -0,0 +1,8 @@
+exit
+      ).collection
+        ]
+          [2, 4]
+          [1, 3],
+        [
+Collection.new(
+collection

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+### VERSION 0.2.0
+
+  * First version was wrong, algorithm didn't take in account merge
+
+### VERSION 0.1.0
+
+  * First version

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at joel.azemar@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in overlap.gemspec
+gemspec
+
+group :test do
+  gem 'byebug'
+  gem 'pry-byebug'
+  gem 'coveralls', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Joel AZEMAR
+
+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,118 @@
+# Overlap
+
+[![Code Climate](https://codeclimate.com/github/FinalCAD/overlap.png)](https://codeclimate.com/github/FinalCAD/overlap)
+
+[![Dependency Status](https://gemnasium.com/FinalCAD/overlap.svg)](https://gemnasium.com/FinalCAD/overlap)
+
+[![Build Status](https://travis-ci.org/FinalCAD/overlap.svg?branch=master)](https://travis-ci.org/FinalCAD/overlap) (Travis CI)
+
+[![Coverage Status](https://coveralls.io/repos/FinalCAD/overlap/badge.svg?branch=master&service=github)](https://coveralls.io/github/FinalCAD/overlap?branch=master)
+
+[![Gem Version](https://badge.fury.io/rb/overlap.svg)](https://badge.fury.io/rb/overlap)
+
+The Overlap module provides methods to remove overlapping for linear segments, also provide some informations about them:
+
+You can give a collection of object with a start position and end position and Overlap give you Unions, Overlap spot overlapped segments and merge them to one continuous segment, and provide to you some informations like intersection quantities, new quantity/distance of your segment
+
+The main purpose of Overlaps -- given a set of Segment objects -- is to find all possible overlaps and merge overlapped segment to ones.
+
+This gem is inspired by [overlaps](https://github.com/h0tl33t/overlaps) so thanks [Ryan Stenberg](https://github.com/h0tl33t)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'overlap'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install overlap
+
+## Usage
+
+Require the Overlap module and call #find on a collection. You can feed them two main types of input:
+
+Array of Array objects
+
+    input_data = [ [1,4], [2,3], [5,6] ]
+    Overlaps.find(input_data)
+
+Array of whatever object where each object is of the same class and the start and end point attribute/accessors are passed as values in an options hash to the :start and :end keys:
+
+    DataObject = Struct.new(:start_point, :end_point)
+
+    input_data = [ DataObject.new(1,10), DataObject.new(1,5), DataObject.new(3,6) ]
+    analysis = Overlaps.find(input_data, start: :start_point, end: :end_point)
+
+Overlaps.find returns an Object Analysis, this contains all unions and informations about the global data analysis
+
+  New Segment
+
+    analysis.unions.each do |union|
+      union.segment => Overlap::Segment#... [1, 4]
+      union.segment => Overlap::Segment#... [5, 6]
+    end
+    analysis.segments => [ Overlap::Segment#... [1, 4], Overlap::Segment#... [5, 6] ]
+
+  All Segments overlapped
+
+    analysis.unions.each do |union|
+      union.segments => [ Overlap::Segment#... [1, 4], Overlap::Segment#... [2, 3] ]
+      union.segments => [ Overlap::Segment#... [5, 6] ]
+    end
+
+  Intersections
+
+    analysis.unions.each do |union|
+      union.intersections => [1]
+      union.intersections => []
+    end
+    analysis.intersections => [ 1, 0 ]
+
+  Quantity/Distance
+
+    analysis.unions.each do |union|
+      union.quantity => 3
+      union.quantity => 1
+    end
+    analysis.quantities => [ 3, 1 ]
+    analysis.quantity => 4
+
+  Quantity/Distance With Intersections
+
+    analysis.unions.each do |union|
+      union.quantity_with_intersections => 4
+      union.quantity_with_intersections => 1
+    end
+    analysis.quantities_with_intersections => [ 4, 1 ]
+    analysis.quantity_with_intersections => 5
+
+  Intersections Quantity/Distance
+
+    analysis.unions.each do |union|
+      union.intersection_quantity => 1
+      union.intersection_quantity => 0
+    end
+    analysis.intersections => [ 1, 0 ]
+    analysis.intersection_quantity => 1
+
+## 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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/FinalCAD/overlap. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source 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/UPGRADE.md

@@ -0,0 +1,3 @@
+### VERSION 0.1.0 => 0.2.0
+
+  Really important change, last version was wrong for complicated case

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "overlap"
+
+# 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

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/overlap.rb

@@ -0,0 +1,13 @@
+require 'overlap/version'
+require 'overlap/union'
+require 'overlap/segment'
+require 'overlap/collection'
+require 'overlap/detect'
+require 'overlap/analysis'
+
+module Overlap
+
+  def self.find(data, options = {})
+    Analysis.new(data, options)
+  end
+end

data/lib/overlap/analysis.rb

@@ -0,0 +1,30 @@
+module Overlap
+  class Analysis
+
+    attr_reader :unions, :segments, :intersections, :quantity_with_intersections, :quantities_with_intersections,
+      :intersection_quantity, :quantities, :quantity
+
+    def initialize(input_data, options={})
+      @input_data = input_data
+      @options = options
+      build!
+    end
+
+    private
+
+    def build!
+      @unions = Detect.new(
+        Collection.new(@input_data, @options).collection
+      ).overlaps.map do |overlapped_segments|
+        Union.new(overlapped_segments)
+      end
+      @segments = unions.map { |union| union.segment.to_a }
+      @intersections = unions.map { |union| union.intersection_quantity }
+      @intersection_quantity = intersections.reduce(:+)
+      @quantities_with_intersections = unions.map { |union| union.quantity_with_intersections }
+      @quantity_with_intersections = quantities_with_intersections.reduce(:+)
+      @quantities = unions.map { |union| (union.quantity&.round(3) || 0) }
+      @quantity = quantities.reduce(:+)&.round(3) || 0
+    end
+  end
+end

data/lib/overlap/collection.rb

@@ -0,0 +1,27 @@
+module Overlap
+  class Collection
+
+    attr_reader :collection
+
+    def initialize(input_collection, options={})
+      @input_collection = input_collection
+      @options = options
+      build!
+    end
+
+    def to_a
+      collection.map { |e| e.to_a }
+    end
+
+    private
+
+    def build!
+      _collection = @input_collection.map do |entry|
+        _start = entry.send(@options.fetch(:start, :first))
+        _end   = entry.send(@options.fetch(:end, :last))
+        [ _start, _end ].sort if _start && _end
+      end.compact.sort { |x,y| x[0] <=> y[0] }
+      @collection = _collection.map { |x, y| Segment.new(x, y) }
+    end
+  end
+end

data/lib/overlap/detect.rb

@@ -0,0 +1,38 @@
+module Overlap
+  class Detect
+
+    attr_reader :overlaps
+
+    def initialize(collection)
+      @collection = collection
+      @overlaps = []
+      build!
+    end
+
+    private
+
+    def build!
+      destructive_collection = @collection.dup.to_a
+      current_segment = nil
+
+      while (one = destructive_collection.shift) do
+        current_segment = Segment.new(one.start_position, one.end_position)
+        segments = []
+        segments << one
+
+        @collection.map do |other|
+          next if current_segment.same?(other)
+          if current_segment.overlap?(other)
+            current_segment.merge!(other)
+            segments << other
+          end
+        end.compact
+
+        segments.each { |e| @collection.delete(e) }
+        segments.each { |e| destructive_collection.delete(e) }
+
+        @overlaps << { union: current_segment, segments: segments }
+      end
+    end
+  end
+end

data/lib/overlap/segment.rb

@@ -0,0 +1,75 @@
+module Overlap
+  class Segment
+
+    attr_reader :center, :radius, :start_position, :end_position, :quantity, :key
+
+    def initialize(start_position, end_position)
+      @start_position = start_position
+      @end_position   = end_position
+      build!
+    end
+
+    def merge!(other)
+      if other.start_position < start_position
+        @start_position = other.start_position
+      end
+
+      if end_position < other.end_position
+        @end_position = other.end_position
+      end
+
+      build!
+    end
+
+    def to_s
+      "[#{start_position.to_f}, #{end_position.to_f}]"
+    end
+    alias_method :inspect, :to_s
+
+    def inspect
+      "#{self.class.name}##{self.object_id} #{to_s}"
+    end
+
+    def to_a
+      [ start_position, end_position ]
+    end
+
+    def same?(other)
+      self == other
+    end
+
+    def overlap?(other)
+      (center - other.center).abs.round(3) <= (radius + other.radius).round(3)
+    end
+
+    def ==(other)
+      self.class == other.class && to_a == other.to_a
+    end
+    alias :eql? :==
+
+    def hash
+      to_a.hash
+    end
+
+    def intersection(other)
+      end_position - other.start_position
+    end
+
+    def <=>(other)
+      if start_position == other.start_position
+        end_position <=> other.end_position
+      else
+        start_position <=> other.start_position
+      end
+    end
+
+    private
+
+    def build!
+      @quantity = end_position - start_position
+      @radius   = quantity / 2
+      @center   = start_position + radius
+      @key      = [ start_position, end_position ]
+    end
+  end
+end

data/lib/overlap/union.rb

@@ -0,0 +1,32 @@
+module Overlap
+  class Union
+
+    attr_reader :segment, :quantity, :intersections, :quantity_with_intersections, :intersection_quantity, :segments
+
+    def initialize(overlapped_segments)
+      @overlapped_segments = overlapped_segments
+      @segments = overlapped_segments[:segments].sort
+      build!
+    end
+
+    private
+
+    def build!
+      @segment = @overlapped_segments[:union]
+      @quantity = segment.quantity
+
+      previous_value = nil
+      @intersections = segments.sort.map do |_segment|
+        intersection = nil
+        if previous_value
+          intersection = previous_value - _segment.start_position
+        end
+        previous_value = _segment.end_position
+        intersection
+      end.compact
+
+      @intersection_quantity = intersections.reduce(:+)&.round(3) || 0
+      @quantity_with_intersections = segments.map(&:quantity).reduce(:+)&.round(3) || 0
+    end
+  end
+end

data/lib/overlap/version.rb

@@ -0,0 +1,3 @@
+module Overlap
+  VERSION = '0.2.0'
+end

data/overlap.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'overlap/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "overlap"
+  spec.version       = Overlap::VERSION
+  spec.authors       = ["Joel AZEMAR"]
+  spec.email         = ["joel.azemar@gmail.com"]
+
+  spec.summary       = %q{Detect Overlaps}
+  spec.description   = %q{Overlaps Tool}
+  spec.homepage      = "https://github.com/FinalCAD/overlap"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: overlap
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Joel AZEMAR
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: Overlaps Tool
+email:
+- joel.azemar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".byebug_history"
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- UPGRADE.md
+- bin/console
+- bin/setup
+- lib/overlap.rb
+- lib/overlap/analysis.rb
+- lib/overlap/collection.rb
+- lib/overlap/detect.rb
+- lib/overlap/segment.rb
+- lib/overlap/union.rb
+- lib/overlap/version.rb
+- overlap.gemspec
+homepage: https://github.com/FinalCAD/overlap
+licenses:
+- MIT
+metadata: {}
+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.6
+signing_key: 
+specification_version: 4
+summary: Detect Overlaps
+test_files: []