borel 0.3.3 → 0.3.4

data/Gemfile

@@ -3,7 +3,9 @@ source "http://www.rubygems.org"
 gemspec
 
 group :development do
-  gem 'yard', '~> 0.7.5'
   gem 'rspec', '~> 2.8.0'
-  gem 'guard', '~> 1.0.0'
+  gem 'guard-rspec', '~> 0.7.0'
+  gem 'yard', '~> 0.7.5'
+  gem 'redcarpet'
+  gem 'fivemat'
 end

data/lib/borel/array.rb

@@ -3,6 +3,12 @@ class Array
 
   # Initializes an interval with the calling array as argument
   # @return [Interval]
+  # @example
+  #   [].to_interval              # -> Interval[]
+  # @example
+  #   [1,2].to_interval           # -> Interval[1,2]
+  # @example
+  #   [[1,2],[3,4]].to_interval   # -> Interval[[1,2],[3,4]]
   def to_interval
     Interval[*self]
   end

data/lib/borel/interval.rb

@@ -1,13 +1,33 @@
 require 'borel/errors'
 
-# Exposes infinity for initializing unbounded intervals
-Infinity = 1/0.0
+# Exposes `Infinity` and `-Infinity` for initializing unbounded intervals
+#
+# @example
+#   Interval[-Infinity, 0]
+# @example
+#   Interval[1, Infinity]
+# @example
+#   Interval[-Infinity, Infinity]
+Infinity = Float::INFINITY
 
 # Retains all non-specific Interval logic
 class Interval
   include Enumerable
 
+  # Initializes an Interval
+  #
+  # @param [Array<Comparable>,Array<Array<Comparable>>] array none, one or
+  #  multiple 1,2-length arrays
   # @return [Interval]
+  #
+  # @example Empty interval
+  #   Interval[]
+  # @example An interval with only one point
+  #   Interval[1]
+  # @example A simple interval
+  #   Interval[0,1]
+  # @example A non simple interval
+  #   Interval[[0,1],[2,3],[5]]
   def self.[](*array)
     union(*
       if array.empty?
@@ -25,6 +45,8 @@ class Interval
     raise
   end
 
+  # Performs the union of Intervals
+  # @param Array<Interval> array the intervals to be united
   # @return [Interval]
   def self.union(*array)
     intervals = []
@@ -40,7 +62,11 @@ class Interval
     intervals.size == 1 ? intervals.first : Multiple.new(intervals)
   end
 
+  # Performs the operation of union with other interval
+  # @param [#to_interval] other the other interval-compatible object
   # @return [Interval]
+  # @example
+  #   Interval[1,2].union(3..4) == Interval[[1,2],[3,4]] # true
   def union(other)
     Interval.union(other.to_interval, self)
   end
@@ -83,7 +109,8 @@ class Interval
     components.empty?
   end
 
-  # @return [Interval]
+  # Implemented for establishing obvious interval-compatibility
+  # @return [Interval] returns `self`
   def to_interval
     self
   end
@@ -98,7 +125,15 @@ class Interval
     inspect
   end
 
-  # @return [Interval]
+  # The convex hull of the Interval
+  # Note that for simple Intervals it is itself
+  #
+  # @example
+  #   Interval[].hull == Interval[] # true
+  # @example
+  #   Interval[[1,2],[3,4]].hull == Interval[1,4] # true
+  #
+  # @return [Interval] a simple Interval composed by the inf and sup points
   def hull
     if empty? then Interval[] else Interval[inf, sup] end
   end

data/lib/borel/interval_simple.rb

@@ -6,7 +6,7 @@ class Interval::Simple < Interval
 
   def initialize (a, b = a)
     if (a.respond_to?(:nan?) && a.nan?) || (b.respond_to?(:nan?) && b.nan?)
-      @inf, @sup = -Infinity, Infinity
+      @inf, @sup = -Float::INFINITY, Float::INFINITY
     else
       @inf, @sup = a, b
     end
@@ -26,7 +26,7 @@ class Interval::Simple < Interval
 
   # @return [Interval::Multiple]
   def complement
-    Interval[[-Infinity, inf], [sup, Infinity]]
+    Interval[[-Float::INFINITY, inf], [sup, Float::INFINITY]]
   end
 
   # @return [Interval]
@@ -49,16 +49,26 @@ class Interval::Simple < Interval
     extrema.uniq
   end
 
+  # Verifies that a point is inside the interval
+  #
+  # @param [Comparable] x the point to be verified
   # @return [Boolean]
+  # @example
+  #   Interval[1,5].include?(3.4)   # -> true
   def include?(x)
     inf <= x && x <= sup
   end
 
+  # Verifies that the Interval is degenerate, i.e. the extrema are equal
+  # @example
+  #   Interval[1,2].degenerate?     # -> false
+  #   Interval[1].degenerate?       # -> true
   # @return [Boolean]
   def degenerate?
     inf == sup
   end
 
+  # Verifies that this class represents simple intervals
   # @return [Boolean]
   def simple?
     true

data/lib/borel/math_extensions/interval_arithmetic.rb

@@ -3,7 +3,10 @@ require 'borel'
 module Borel
   # Includes numeric intervals related methods
   module IntervalArithmetic
+
     # @return [Number] the width of the interval
+    # @example
+    #   Interval[1,5].width # -> 5-1
     def width
       raise NonSimple, self unless respond_to?(:simple?) and simple?
       extrema.last - extrema.first

data/lib/borel/math_extensions/randomizable.rb

@@ -3,6 +3,9 @@ require 'borel/math_extensions/interval_arithmetic'
 module Borel
   # Includes methods for picking random elements on intervals
   module Randomizable
+
+    # @example
+    #   Interval[1,5].rand  # -> Random.new.rand 1..5
     # @return [Object] a random element of the interval
     def rand
       raise EmptyInterval if respond_to?(:empty?) and empty?

data/lib/borel/nil_class.rb

@@ -3,6 +3,8 @@ class NilClass
 
   # Initializes an empty interval
   # @return [Interval]
+  # @example
+  #   nil.to_interval     # -> Interval[]
   def to_interval
     Interval[]
   end

data/lib/borel/range.rb

@@ -2,6 +2,10 @@
 class Range
 
   # @return [Interval]
+  # @example
+  #   (1..2).to_interval  # -> Interval[1,2]
+  # @example
+  #   (1...3).to_interval # -> Interval[1,2]
   def to_interval
     Interval[first,
       if exclude_end?

data/lib/borel/version.rb

@@ -5,7 +5,7 @@ module Borel
   # Minor version number
   MINOR = 3
   # Tiny version number
-  TINY = 3
+  TINY = 4
 
   # Joins the version numbers
   VERSION = [MAJOR, MINOR, TINY].join('.')

data/spec/interval_spec.rb

@@ -20,8 +20,8 @@ describe Interval do
     end
 
     specify "Interval[-Infinity, Infinity] -> [-Infinity, Infinity]" do
-      Interval[-Infinity, Infinity].construction.
-        should eq [-Infinity, Infinity]
+      Interval[-Float::INFINITY, Float::INFINITY].construction.
+        should eq [-Float::INFINITY, Float::INFINITY]
     end
   end
 
@@ -57,7 +57,7 @@ describe Interval do
     end
 
     specify "[-infty, infty]^[0,1] = [0,1]" do
-      (Interval[-Infinity, Infinity] ^ Interval[0,1]).
+      (Interval[-Float::INFINITY, Float::INFINITY] ^ Interval[0,1]).
         construction.should eq [0,1]
     end
 
@@ -196,12 +196,12 @@ describe Interval do
     end
 
     specify '[-infty,infty]-[0,1] = [-infty,0]U[1,infty]' do
-      (Interval[-Infinity,Infinity] - Interval[0,1]).construction.
-        should eq [[-Infinity,0], [1,Infinity]]
+      (Interval[-Float::INFINITY,Float::INFINITY] - Interval[0,1]).construction.
+        should eq [[-Float::INFINITY,0], [1,Float::INFINITY]]
     end
 
     specify '[0,1]-[-infty,infty] = []' do
-      (Interval[0,1] - Interval[-Infinity,Infinity]).construction.
+      (Interval[0,1] - Interval[-Float::INFINITY,Float::INFINITY]).construction.
         should eq []
     end
   end

data/spec/numeric_spec.rb

@@ -21,11 +21,11 @@ describe Numeric do
     end
 
     it "1/0 should be [Infinity]" do
-      (1/0.0).to_interval.should eq Interval[Infinity]
+      (1/0.0).to_interval.should eq Interval[Float::INFINITY]
     end
 
     it "Infinity should be [Infinity]" do
-      (-1/0.0).to_interval.should eq Interval[-Infinity]
+      (-1/0.0).to_interval.should eq Interval[-Float::INFINITY]
     end
 
   end

data/spec/range_spec.rb

@@ -11,20 +11,21 @@ describe Range do
       (1...3).to_interval.should eq Interval[1,2]
     end
 
-    it '(1..Infinity) should be [1,infty]' do
-      (1..Infinity).to_interval.should eq Interval[1,Infinity]
+    it '(1..Float::INFINITY) should be [1,infty]' do
+      (1..Float::INFINITY).to_interval.should eq Interval[1,Float::INFINITY]
     end
 
-    it '(1...Infinity) should raise OpenRight' do
-      expect{(1...Infinity).to_interval}.to raise_error Borel::OpenRight
+    it '(1...Float::INFINITY) should raise OpenRight' do
+      expect{(1...Float::INFINITY).to_interval}.to raise_error Borel::OpenRight
     end
 
-    it '(-Infinity..1) should be [-infty,1]' do
-      (-Infinity..1).to_interval.should eq Interval[-Infinity,1]
+    it '(-Float::INFINITY..1) should be [-infty,1]' do
+      (-Float::INFINITY..1).to_interval.should eq Interval[-Float::INFINITY,1]
     end
 
-    it '(-Infinity..Infinity) should be [-infty,infty]' do
-      (-Infinity..Infinity).to_interval.should eq Interval[-Infinity,Infinity]
+    it '(-Float::INFINITY..Float::INFINITY) should be [-infty,infty]' do
+      (-Float::INFINITY..Float::INFINITY).to_interval.
+        should eq Interval[-Float::INFINITY,Float::INFINITY]
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: borel
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-13 00:00:00.000000000 Z
+date: 2013-02-24 00:00:00.000000000 Z
 dependencies: []
 description: ! 'Borel sets are made of enumerable union and intersection of
 
@@ -73,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: borel
-rubygems_version: 1.8.21
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Interval operation on Comparable classes