borel 0.0.1 → 0.1.0

data/README.md

@@ -1,6 +1,91 @@
 Borel
 =====
 
-Borelian sets are sets formed by the enumerable union and intersection, or the complement, of intervals in the Real line.
+Borelian sets are sets formed by enumerable union, intersection or complement, of intervals.
 
-**Borel** aims to make it really easy to make union and intersection operations of interval in any ordered set.
+**Borel** enables performing regular operations on any ordered set.
+
+**Borel** was mainly inspired on the **Intervals** [gem][1].
+
+[1]: http://intervals.rubyforge.org
+
+Usage
+-----
+
+### Initializing
+
+An Interval can be initialized with an empty, one or two sized array (respectively for an _empty_, _degenerate_ or _simple_ interval), or an array of one or two sized arrays (for a _multiple_ interval).
+
+```ruby
+Interval[]
+Interval[1]
+Interval[0,1]
+Interval[[0,1],[2,3],[5]]
+```
+
+Another way to initialize an Interval is by using the **to_interval** method on Ranges or Numbers.
+
+```ruby
+1.to_interval
+(0..1).to_interval
+(0...2).to_interval
+```
+
+The **Infinity** constant is available for specifying intervals with no upper or lower boundary.
+
+```ruby
+Interval[-Infinity, 0]
+Interval[1, Infinity]
+Interval[-Infinity, Infinity]
+```
+
+### Properties
+
+Some natural properties of intervals:
+
+```ruby
+Interval[1].degenerate?       # true
+Interval[[0,1],[2,3]].simple? # false
+Interval[].empty?             # true
+Interval[1,5].include?(3.4)   # true
+```
+
+### Operations
+
+* Complement
+
+__complement__ and __~__
+
+```ruby
+~Interval[0,5] == Interval[[-Infinity, 0], [5, Infinity]]
+```
+
+* Union
+
+__union__, __|__ and __+__
+
+```ruby
+Interval[0,5] | Interval[-1,3] == Interval[-1,5]
+```
+
+* Intersection
+
+__intersect__, __&__, __^__
+
+```ruby
+Interval[0,5] ^ Interval[-1,3] == Interval[0,3]
+```
+
+* Subtraction
+
+__minus__ and __-__
+
+```ruby
+Interval[0,5] - Interval[-1,3] == Interval[3,5]
+```
+
+### Remarks
+
+* At the moment there is no distinction between **open** and **closed** intervals.
+
+* There is limited support for non-numeric classes intervals

data/lib/borel/interval.rb

@@ -71,18 +71,6 @@ class Interval
     [other.to_interval, self]
   end
 
-  def +(other)
-    self | other
-  end
-
-  def ^(other)
-    self & other
-  end
-
-  def |(other)
-    Interval.union(other.to_interval, self)
-  end
-
   def empty?
     components.empty?
   end
@@ -99,9 +87,25 @@ class Interval
     end
   end
 
+  def union(other)
+    Interval.union(other.to_interval, self)
+  end
+
+  def +(other)
+    self | other
+  end
+
+  def ^(other)
+    self & other
+  end
+
+  def |(other)
+    self.union other.to_interval
+  end
+
   [[:&, :intersect]].each do |op, meth|
     define_method(op) {|other|
-      (other.to_interval.map{|y| map{|x| x.send(meth,y)}}.flatten).reduce(:|)
+      (other.to_interval.map{|y| map{|x| x.send(meth,y)}}.flatten).reduce(:|) || Interval[]
     }
   end
 
@@ -113,7 +117,11 @@ class Interval
 
   [[:-, :minus]].each do |op, meth|
     define_method(op) {|other|
-      map{|x| other.to_interval.map{|y| x.send(meth,y)}.reduce(:&)}.flatten.reduce(:|)
+      if other.empty?
+        self
+      else
+        map{|x| other.to_interval.map{|y| x.send(meth,y)}.reduce(:&)}.flatten.reduce(:|) || Interval[]
+      end
     }
   end
 end
@@ -180,7 +188,6 @@ class Interval::Simple < Interval
 end
 
 class Interval::Multiple < Interval
-
   attr :components
 
   def initialize(array)

data/lib/borel/nil_class.rb

@@ -0,0 +1,5 @@
+class NilClass
+  def to_interval
+    Interval[]
+  end
+end

data/lib/borel/version.rb

@@ -1,7 +1,7 @@
 module Borel
   MAJOR = 0
-  MINOR = 0
-  TINY = 1
+  MINOR = 1
+  TINY = 0
 
   VERSION = [MAJOR, MINOR, TINY].join('.')
 

data/spec/interval_spec.rb

@@ -3,13 +3,15 @@ require 'borel/interval'
 describe Interval do
   context '#intersection' do
 
+    it "[]^[] = []" do
+      (Interval[] ^ Interval[]).should eq Interval[]
+    end
+
     it "[]^[0,3] = []" do
-      pending
       (Interval[] ^ Interval[0,3]).should eq Interval[]
     end
 
     it "[0,3]^[] = []" do
-      pending
       (Interval[0,3] ^ Interval[]).should eq Interval[]
     end
 
@@ -31,6 +33,18 @@ describe Interval do
   end
 
   context '#union' do
+    it "[]U[] = []" do
+      (Interval[] | Interval[]).should eq Interval[]
+    end
+
+    it "[]U[1,2] = [1,2]" do
+      (Interval[] | Interval[1,2]).should eq Interval[1,2]
+    end
+
+    it "[1,2]U[] = [1,2]" do
+      (Interval[1,2] | Interval[]).should eq Interval[1,2]
+    end
+
     it "[0,3]U[1,2] = [0,3]" do
       (Interval[0,3] | Interval[1,2]).should eq Interval[0,3]
     end
@@ -53,6 +67,18 @@ describe Interval do
   end
 
   context '#minus' do
+    it "[]-[] = []" do
+      (Interval[] - Interval[]).should eq Interval[]
+    end
+
+    it "[1,2]-[] = [1,2]" do
+      (Interval[1,2] - Interval[]).should eq Interval[1,2]
+    end
+
+    it "[]-[1,2] = []" do
+      (Interval[] - Interval[1,2]).should eq Interval[]
+    end
+
     it "[2,3]-(0,1) = [2,3]" do
       (Interval[2,3] - Interval[0,1]).should eq Interval[2,3]
     end
@@ -70,7 +96,7 @@ describe Interval do
     end
 
     it '[0,1]-(0,1) = [0]U[1]' do
-      (Interval[0,1] - Interval[0,1]).should eq Interval[0] | Interval[1]
+      (Interval[0,1] - Interval[0,1]).should eq Interval[[0],[1]]
     end
 
     it '[1,2]-(2,3) = [1,2]' do
@@ -90,7 +116,7 @@ describe Interval do
     end
 
     it '[1,4]-(1,3) = [1]U[3,4]' do
-      (Interval[1,4] - Interval[1,3]).should eq Interval[3,4] | Interval[1]
+      (Interval[1,4] - Interval[1,3]).should eq Interval[[1],[3,4]]
     end
 
     it '[1,4]-(1,5) = [1]' do
@@ -98,7 +124,7 @@ describe Interval do
     end
 
     it '[1,3]-(2,3) = [1,2]U[3]' do
-      (Interval[1,3] - Interval[2,3]).should eq Interval[1,2] | Interval[3]
+      (Interval[1,3] - Interval[2,3]).should eq Interval[[1,2],[3]]
     end
 
     it '[1,3]-(0,3) = [3]' do
@@ -106,7 +132,7 @@ describe Interval do
     end
 
     it '[-infty,infty]-[0,1] = [-infty,0]U[1,infty]' do
-      (Interval[-Infinity,Infinity] - Interval[0,1]).should eq Interval[-Infinity,0]|Interval[1,Infinity]
+      (Interval[-Infinity,Infinity] - Interval[0,1]).should eq Interval[[-Infinity,0],[1,Infinity]]
     end
 
     it '[0,1]-[-infty,infty] = []' do

data/spec/nil_class_spec.rb

@@ -0,0 +1,10 @@
+require 'borel/interval'
+require 'borel/nil_class.rb'
+
+describe NilClass do
+  context "#to_interval" do
+    it "should be Interval[]" do
+      nil.to_interval.should eq Interval[]
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: borel
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-12 00:00:00.000000000 Z
+date: 2012-02-13 00:00:00.000000000 Z
 dependencies: []
 description: Borel sets are made of enumerable union and intersection of intervals.
   Borel performs regular set operations on any interval of a Comparable class.
@@ -27,10 +27,12 @@ files:
 - borel.gemspec
 - lib/borel.rb
 - lib/borel/interval.rb
+- lib/borel/nil_class.rb
 - lib/borel/numeric.rb
 - lib/borel/range.rb
 - lib/borel/version.rb
 - spec/interval_spec.rb
+- spec/nil_class_spec.rb
 - spec/range_spec.rb
 - tasks/gem.rb
 - tasks/rspec.rb