borel 0.1.0 → 0.1.1

data/README.md

@@ -1,42 +1,60 @@
 Borel
 =====
 
-Borelian sets are sets formed by enumerable union, intersection or complement, of intervals.
+Borelian sets are formed by enumerable union, intersection or
+ complement, of intervals.
 
-**Borel** enables performing regular operations on any ordered set.
+**Borel** enables performing regular operations on intervals
+ of any comparable class.
 
-**Borel** was mainly inspired on the **Intervals** [gem][1].
+**Borel** borrows many of the ideas _(and code)_
+ from the  **Intervals** [gem][1].
 
 [1]: http://intervals.rubyforge.org
 
+Installation
+------------
+
+You may install it traditionally, for interactive sessions:
+
+    gem install borel
+
+Or just put this somewhere on your application's `Gemfile`
+
+    gem 'borel'
+
 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).
+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]]
+  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.
+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
+  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.
+The **Infinity** constant is available for specifying intervals
+ with no upper or lower boundary.
 
 ```ruby
-Interval[-Infinity, 0]
-Interval[1, Infinity]
-Interval[-Infinity, Infinity]
+  Interval[-Infinity, 0]
+  Interval[1, Infinity]
+  Interval[-Infinity, Infinity]
 ```
 
 ### Properties
@@ -44,10 +62,10 @@ Interval[-Infinity, Infinity]
 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
+  Interval[1].degenerate?       # -> true
+  Interval[[0,1],[2,3]].simple? # -> false
+  Interval[].empty?             # -> true
+  Interval[1,5].include?(3.4)   # -> true
 ```
 
 ### Operations
@@ -57,7 +75,7 @@ Interval[1,5].include?(3.4)   # true
 __complement__ and __~__
 
 ```ruby
-~Interval[0,5] == Interval[[-Infinity, 0], [5, Infinity]]
+    ~Interval[0,5]             # -> Interval[[-Infinity, 0], [5, Infinity]]
 ```
 
 * Union
@@ -65,7 +83,7 @@ __complement__ and __~__
 __union__, __|__ and __+__
 
 ```ruby
-Interval[0,5] | Interval[-1,3] == Interval[-1,5]
+Interval[0,5] | Interval[-1,3] # -> Interval[-1,5]
 ```
 
 * Intersection
@@ -73,7 +91,7 @@ Interval[0,5] | Interval[-1,3] == Interval[-1,5]
 __intersect__, __&__, __^__
 
 ```ruby
-Interval[0,5] ^ Interval[-1,3] == Interval[0,3]
+Interval[0,5] ^ Interval[-1,3] # -> Interval[0,3]
 ```
 
 * Subtraction
@@ -81,11 +99,19 @@ Interval[0,5] ^ Interval[-1,3] == Interval[0,3]
 __minus__ and __-__
 
 ```ruby
-Interval[0,5] - Interval[-1,3] == Interval[3,5]
+Interval[0,5] - Interval[-1,3] # -> Interval[3,5]
 ```
 
-### Remarks
+### Classes of Intervals
 
-* At the moment there is no distinction between **open** and **closed** intervals.
+You may use any comparable class
+
+```ruby
+Interval['a','c'] ^ Interval['b','d'] # -> Interval['b','c']
+Interval['a','c'] | Interval['b','d'] # -> Interval['a','d']
+```
+
+### Remarks
 
-* There is limited support for non-numeric classes intervals
+* There is no distinction between **open** and **closed** intervals
+* Complement and Minus operations are not supported on any class

data/borel.gemspec

@@ -1,4 +1,4 @@
-require 'borel/version.rb'
+require './lib/borel/version.rb'
 
 Gem::Specification.new do |s|
   s.name = "borel"

data/lib/borel/version.rb

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

data/spec/interval_spec.rb

@@ -1,142 +1,263 @@
 require 'borel/interval'
 
 describe Interval do
-  context '#intersection' do
 
-    it "[]^[] = []" do
-      (Interval[] ^ Interval[]).should eq Interval[]
+  context '#construction' do
+    specify "Interval[] -> []" do
+      Interval[].construction.should eq []
+    end
+
+    specify "Interval[1,1] -> [1]" do
+      Interval[1,1].construction.should eq [1]
+    end
+
+    specify "Interval[1,2] -> [1,2]" do
+      Interval[1,2].construction.should eq [1,2]
+    end
+
+    specify "Interval[[1,2],[3,4],[5]] -> [[1,2],[3,4],[5]]" do
+      Interval[[1,2],[3,4],[5]].construction.should eq [[1,2],[3,4],[5]]
+    end
+
+    specify "Interval[-Infinity, Infinity] -> [-Infinity, Infinity]" do
+      Interval[-Infinity, Infinity].construction.
+        should eq [-Infinity, Infinity]
+    end
+  end
+
+  context '#empty?' do
+    specify "Interval[] -> true" do
+      Interval[].should be_empty
+    end
+
+    specify "Interval[1] -> false" do
+      Interval[1].should_not be_empty
+    end
+  end
+
+  context '#intersection' do
+    specify "[]^[] = []" do
+      (Interval[] ^ Interval[]).
+        construction.should eq []
     end
 
-    it "[]^[0,3] = []" do
-      (Interval[] ^ Interval[0,3]).should eq Interval[]
+    specify "[]^[0,3] = []" do
+      (Interval[] ^ Interval[0,3]).
+        construction.should eq []
     end
 
-    it "[0,3]^[] = []" do
-      (Interval[0,3] ^ Interval[]).should eq Interval[]
+    specify "[0,3]^[] = []" do
+      (Interval[0,3] ^ Interval[]).
+        construction.should eq []
     end
 
-    it "[0,2]^[1] = [1]" do
-      (Interval[0,2] ^ Interval[1]).should eq Interval[1]
+    specify "[0,2]^[1] = [1]" do
+      (Interval[0,2] ^ Interval[1]).
+        construction.should eq [1]
     end
 
-    it "[-infty, infty]^[0,1] = [0,1]" do
-      (Interval[-Infinity, Infinity] ^ Interval[0,1]).should eq Interval[0,1]
+    specify "[-infty, infty]^[0,1] = [0,1]" do
+      (Interval[-Infinity, Infinity] ^ Interval[0,1]).
+        construction.should eq [0,1]
     end
 
-    it "[0,3]^[1,2] = [1,2]" do
-      (Interval[0,3] ^ Interval[1,2]).should eq Interval[1,2]
+    specify "[0,3]^[1,2] = [1,2]" do
+      (Interval[0,3] ^ Interval[1,2]).
+        construction.should eq [1,2]
     end
 
-    it "[[-2,-1],[1,2]]^[[0,3],[4,5]] = [1,2]" do
-      (Interval[[-2,-1],[1,2]] ^ Interval[[0,3],[4,5]]).should eq Interval[1,2]
+    specify "[[-2,-1],[1,2]]^[[0,3],[4,5]] = [1,2]" do
+      (Interval[[-2,-1],[1,2]] ^ Interval[[0,3],[4,5]]).
+        construction.should eq [1,2]
     end
   end
 
   context '#union' do
-    it "[]U[] = []" do
-      (Interval[] | Interval[]).should eq Interval[]
+    specify "[]U[] = []" do
+      (Interval[] | Interval[]).construction.
+        should eq []
     end
 
-    it "[]U[1,2] = [1,2]" do
-      (Interval[] | Interval[1,2]).should eq Interval[1,2]
+    specify "[]U[1,2] = [1,2]" do
+      (Interval[] | Interval[1,2]).construction.
+        should eq [1,2]
     end
 
-    it "[1,2]U[] = [1,2]" do
-      (Interval[1,2] | Interval[]).should eq Interval[1,2]
+    specify "[1,2]U[] = [1,2]" do
+      (Interval[1,2] | Interval[]).construction.
+        should eq [1,2]
     end
 
-    it "[0,3]U[1,2] = [0,3]" do
-      (Interval[0,3] | Interval[1,2]).should eq Interval[0,3]
+    specify "[0,3]U[1,2] = [0,3]" do
+      (Interval[0,3] | Interval[1,2]).construction.
+        should eq [0,3]
     end
 
-    it "[1,2]U[0,3] = [0,3]" do
-      (Interval[1,2] | Interval[0,3]).should eq Interval[0,3]
+    specify "[1,2]U[0,3] = [0,3]" do
+      (Interval[1,2] | Interval[0,3]).construction.
+        should eq [0,3]
     end
 
-    it "[1,2]U[1,2] = [1,2]" do
-      (Interval[1,2] | Interval[1,2]).should eq Interval[1,2]
+    specify "[1,2]U[1,2] = [1,2]" do
+      (Interval[1,2] | Interval[1,2]).construction.
+        should eq [1,2]
     end
 
-    it "[1,2]U[2,3] = [1,3]" do
-      (Interval[1,2] | Interval[2,3]).should eq Interval[1,3]
+    specify "[1,2]U[2,3] = [1,3]" do
+      (Interval[1,2] | Interval[2,3]).construction.
+        should eq [1,3]
     end
 
-    it "[1,2]U[3,4] = [[1,2],[3,4]]" do
-      (Interval[1,2] | Interval[3,4]).should eq Interval[[1,2],[3,4]]
+    specify "[1,2]U[3,4] = [[1,2],[3,4]]" do
+      (Interval[1,2] | Interval[3,4]).construction.
+        should eq [[1,2],[3,4]]
     end
   end
 
   context '#minus' do
-    it "[]-[] = []" do
-      (Interval[] - Interval[]).should eq Interval[]
+    specify "[]-[] = []" do
+      (Interval[] - Interval[]).construction.
+        should eq []
+    end
+
+    specify "[1,2]-[] = [1,2]" do
+      (Interval[1,2] - Interval[]).construction.
+        should eq [1,2]
     end
 
-    it "[1,2]-[] = [1,2]" do
-      (Interval[1,2] - Interval[]).should eq Interval[1,2]
+    specify "[]-[1,2] = []" do
+      (Interval[] - Interval[1,2]).construction.
+        should eq []
     end
 
-    it "[]-[1,2] = []" do
-      (Interval[] - Interval[1,2]).should eq Interval[]
+    specify "[2,3]-(0,1) = [2,3]" do
+      (Interval[2,3] - Interval[0,1]).construction.
+        should eq [2,3]
     end
 
-    it "[2,3]-(0,1) = [2,3]" do
-      (Interval[2,3] - Interval[0,1]).should eq Interval[2,3]
+    specify '[0,1]-(2,3) = [0,1]' do
+      (Interval[0,1] - Interval[2,3]).construction.
+        should eq [0,1]
     end
 
-    it '[0,1]-(2,3) = [0,1]' do
-      (Interval[0,1] - Interval[2,3]).should eq Interval[0,1]
+    specify '[1,2]-(0,3) = []' do
+      (Interval[1,2] - Interval[0,3]).construction.
+        should eq []
     end
 
-    it '[1,2]-(0,3) = []' do
-      (Interval[1,2] - Interval[0,3]).should be_empty
+    specify '[0,3]-(1,2) = [0,1]U[2,3]' do
+      (Interval[0,3] - Interval[1,2]).construction.
+        should eq [[0,1],[2,3]]
     end
 
-    it '[0,3]-(1,2) = [0,1]U[2,3]' do
-      (Interval[0,3] - Interval[1,2]).should eq Interval[[0,1],[2,3]]
+    specify '[0,1]-(0,1) = [0]U[1]' do
+      (Interval[0,1] - Interval[0,1]).construction.
+        should eq [[0],[1]]
     end
 
-    it '[0,1]-(0,1) = [0]U[1]' do
-      (Interval[0,1] - Interval[0,1]).should eq Interval[[0],[1]]
+    specify '[1,2]-(2,3) = [1,2]' do
+      (Interval[1,2] - Interval[2,3]).construction.
+        should eq [1,2]
     end
 
-    it '[1,2]-(2,3) = [1,2]' do
-      (Interval[1,2] - Interval[2,3]).should eq Interval[1,2]
+    specify '[2,3]-(1,2) = [2,3]' do
+      (Interval[2,3] - Interval[1,2]).construction.
+        should eq [2,3]
     end
 
-    it '[2,3]-(1,2) = [2,3]' do
-      (Interval[2,3] - Interval[1,2]).should eq Interval[2,3]
+    specify '[1,4]-(0,3) = [3,4]' do
+      (Interval[1,4] - Interval[0,3]).construction.
+        should eq [3,4]
     end
 
-    it '[1,4]-(0,3) = [3,4]' do
-      (Interval[1,4] - Interval[0,3]).should eq Interval[3,4]
+    specify '[1,3]-(2,4) = [1,2]' do
+      (Interval[1,3] - Interval[2,4]).construction.
+        should eq [1,2]
     end
 
-    it '[1,3]-(2,4) = [1,2]' do
-      (Interval[1,3] - Interval[2,4]).should eq Interval[1,2]
+    specify '[1,4]-(1,3) = [1]U[3,4]' do
+      (Interval[1,4] - Interval[1,3]).construction.
+        should eq [[1],[3,4]]
     end
 
-    it '[1,4]-(1,3) = [1]U[3,4]' do
-      (Interval[1,4] - Interval[1,3]).should eq Interval[[1],[3,4]]
+    specify '[1,4]-(1,5) = [1]' do
+      (Interval[1,4] - Interval[1,5]).construction.
+        should eq [1]
     end
 
-    it '[1,4]-(1,5) = [1]' do
-      (Interval[1,4] - Interval[1,5]).should eq Interval[1]
+    specify '[1,3]-(2,3) = [1,2]U[3]' do
+      (Interval[1,3] - Interval[2,3]).construction.
+        should eq [[1,2],[3]]
     end
 
-    it '[1,3]-(2,3) = [1,2]U[3]' do
-      (Interval[1,3] - Interval[2,3]).should eq Interval[[1,2],[3]]
+    specify '[1,3]-(0,3) = [3]' do
+      (Interval[1,3] - Interval[0,3]).construction.
+        should eq [3]
     end
 
-    it '[1,3]-(0,3) = [3]' do
-      (Interval[1,3] - Interval[0,3]).should eq Interval[3]
+    specify '[-infty,infty]-[0,1] = [-infty,0]U[1,infty]' do
+      (Interval[-Infinity,Infinity] - Interval[0,1]).construction.
+        should eq [[-Infinity,0], [1,Infinity]]
     end
 
-    it '[-infty,infty]-[0,1] = [-infty,0]U[1,infty]' do
-      (Interval[-Infinity,Infinity] - Interval[0,1]).should eq Interval[[-Infinity,0],[1,Infinity]]
+    specify '[0,1]-[-infty,infty] = []' do
+      (Interval[0,1] - Interval[-Infinity,Infinity]).construction.
+        should eq []
     end
+  end
+end
+
+describe "Generic Interval" do
+  describe "when I use String Intervals" do
+    it "should initialize ['a']" do
+      Interval["a"].construction.should eq ["a"]
+    end
+
+    it "should initialize ['a','b']" do
+      Interval["a","b"].construction.should eq ["a","b"]
+    end
+
+    it "should initialize [['a','c'],['b','d'],['e']] as [['a','d'],['e']]" do
+      Interval[["a","c"],["b","d"],["e"]].
+        construction.should eq [["a","d"],["e"]]
+    end
+
+    specify "['c','e']|['d','f']|['g']|[] = [['c','f'],['g']]" do
+      (Interval['c','e'] | Interval['d','f'] | Interval['g'] | Interval[]).
+        construction.should eq [['c','f'],['g']]
+    end
+
+    specify "['a','c']^[] = []" do
+      (Interval['a','c'] ^ Interval[]).
+        construction.should eq []
+    end
+
+    specify "['a','b']^['c','d'] = []" do
+      (Interval['a','b'] ^ Interval['c','d']).
+        construction.should eq []
+    end
+
+    specify "['a','c']^['b','d'] = ['b','c']" do
+      (Interval['a','c'] ^ Interval['b','d']).
+        construction.should eq ['b','c']
+    end
+
+    specify "['a','c']^['b','d']^['f'] = []" do
+      (Interval['a','c'] ^ Interval['b','d'] ^ Interval['f']).
+        construction.should eq []
+    end
+
+    describe "when upper bound is 'a' and lower bound is 'z'" do
+      specify "~['d','f'] = ['a','d']|['f','z']" do
+        pending
+        (~Interval['d','f']).construction.should eq [['a','d'],['f','z']]
+      end
 
-    it '[0,1]-[-infty,infty] = []' do
-      (Interval[0,1] - Interval[-Infinity,Infinity]).should eq Interval[]
+      specify "['d','f']-['a','e'] = ['e','f']" do
+        pending
+        (Interval['d','f']-Interval['a','e']).
+          construction.should eq ['e','f']
+      end
     end
   end
 end

data/spec/numeric_spec.rb

@@ -0,0 +1,33 @@
+require 'borel/interval'
+require 'borel/numeric'
+
+describe Numeric do
+  context "#to_interval" do
+
+    it "-1 should be [-1]" do
+      -1.to_interval.should eq Interval[-1]
+    end
+
+    it "0 should be [0]" do
+      0.to_interval.should eq Interval[0]
+    end
+
+    it "1 should be [1]" do
+      1.to_interval.should eq Interval[1]
+    end
+
+    it "-3.23 should be [-3.23]" do
+      -3.23.to_interval.should eq Interval[-3.23]
+    end
+
+    it "1/0 should be [Infinity]" do
+      (1/0.0).to_interval.should eq Interval[Infinity]
+    end
+
+    it "Infinity should be [Infinity]" do
+      (-1/0.0).to_interval.should eq Interval[-Infinity]
+    end
+
+  end
+end
+

data/tasks/rspec.rb

@@ -1,4 +1,6 @@
 require 'rspec/core/rake_task'
 
 desc "Run specifications"
-RSpec::Core::RakeTask.new(:rspec)
+RSpec::Core::RakeTask.new {|r|
+  r.rspec_opts = %w(--format documentation)
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: borel
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-13 00:00:00.000000000 Z
+date: 2012-02-18 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.
@@ -33,6 +33,7 @@ files:
 - lib/borel/version.rb
 - spec/interval_spec.rb
 - spec/nil_class_spec.rb
+- spec/numeric_spec.rb
 - spec/range_spec.rb
 - tasks/gem.rb
 - tasks/rspec.rb