borel 0.3.2 → 0.3.3

data/Gemfile

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

data/Guardfile

@@ -3,4 +3,3 @@ guard 'rspec', :version => 2 do
   watch(%r{^lib/borel/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')    { "spec" }
 end
-

data/borel.gemspec

@@ -7,12 +7,12 @@ Gem::Specification.new do |s|
   s.authors = ["Amadeus Folego"]
   s.email = ["amadeusfolego@gmail.com"]
   s.homepage = "http://github.com/badosu/borel"
-  s.summary = "Generic ordered set's operations"
+  s.summary = "Interval operation on Comparable classes"
   s.description = "Borel sets are made of enumerable union and intersection of
-intervals. Borel performs regular operations on any interval of any
+intervals. Borel performs regular operations on intervals of any
 Comparable class."
   s.rubyforge_project = s.name
-  s.required_ruby_version = ">= 1.9.3"
+  s.required_ruby_version = ">= 1.9.2"
   s.required_rubygems_version = ">= 1.3.6"
   s.files = `git ls-files`.split("\n")
   s.require_path = 'lib'

data/lib/borel/array.rb

@@ -1,4 +1,8 @@
+# Extends {#to_interval} for the {Array} class
 class Array
+
+  # Initializes an interval with the calling array as argument
+  # @return [Interval]
   def to_interval
     Interval[*self]
   end

data/lib/borel/errors.rb

@@ -1,4 +1,5 @@
 module Borel
+  # Raised when an interval is not properly initialized
   class Construction < ArgumentError
     def initialize(array)
       super(
@@ -8,24 +9,30 @@ module Borel
     end
   end
 
+  # Raised when a non-degenerate interval calls a method supported only for
+  # degenerate intervals
   class NonDegenerate < ArgumentError
     def initialize(i)
       super("#{i.inspect} is not degenerate.")
     end
   end
 
+  # Raised when a non simple interval calls a method supported only for simple
+  # intervals
   class NonSimple < ArgumentError
     def initialize(i)
       super("#{i.inspect} is not simple.")
     end
   end
 
+  # Raised when a method is not supported for empty intervals
   class EmptyInterval < ArgumentError
     def initialize
       super("The interval is empty.")
     end
   end
 
+  # Raised when the {Range#to_interval} is not called properly
   class OpenRight < ArgumentError
     def initialize(range)
       super(

data/lib/borel/interval.rb

@@ -1,10 +1,13 @@
 require 'borel/errors'
 
+# Exposes infinity for initializing unbounded intervals
 Infinity = 1/0.0
 
+# Retains all non-specific Interval logic
 class Interval
   include Enumerable
 
+  # @return [Interval]
   def self.[](*array)
     union(*
       if array.empty?
@@ -22,39 +25,45 @@ class Interval
     raise
   end
 
+  # @return [Interval]
   def self.union(*array)
-    l = []
-    array.map(&:components).flatten.sort_by(&:inf).each do |x|
-      if x.sup < x.inf
+    intervals = []
+    array.map(&:components).flatten.sort_by(&:inf).each do |component|
+      if component.sup < component.inf
         next
-      elsif l.empty? || x.inf > l.last.sup
-        l <<= x
-      elsif x.sup > l.last.sup
-        l[-1] = Simple.new(l.last.inf, x.sup)
+      elsif intervals.empty? || component.inf > intervals.last.sup
+        intervals <<= component
+      elsif component.sup > intervals.last.sup
+        intervals[-1] = Simple.new(intervals.last.inf, component.sup)
       end
     end
-    if l.size == 1 then l.first else Multiple.new(l) end
+    intervals.size == 1 ? intervals.first : Multiple.new(intervals)
   end
 
+  # @return [Interval]
   def union(other)
     Interval.union(other.to_interval, self)
   end
 
+  # @return [Interval]
   def intersect(other)
     other.to_interval.map{|y| map{|x| x.intersect(y)}}.
       flatten.reduce(:union) || Interval[]
   end
 
+  # @return [Interval]
   def complement
     map{|x| x.to_interval.map(&:complement).reduce(:intersect)}.
       flatten.reduce(:union)
   end
 
+  # @return [Interval]
   def intersect(other)
     other.to_interval.map{|y| map{|x| x.intersect(y)}}.
       flatten.reduce(:union) || Interval[]
   end
 
+  # @return [Interval]
   def minus(other)
     if other.empty?
       self
@@ -64,32 +73,34 @@ class Interval
     end
   end
 
+  # @return [Boolean]
   def ==(other)
     construction == other.construction
   end
 
+  # @return [Boolean]
   def empty?
     components.empty?
   end
 
+  # @return [Interval]
   def to_interval
     self
   end
 
+  # @return [String]
   def inspect
     "Interval" + construction.inspect
   end
 
+  # @return [String]
   def to_s
     inspect
   end
 
+  # @return [Interval]
   def hull
-    if empty?
-      Interval[]
-    else
-      Interval[inf, sup]
-    end
+    if empty? then Interval[] else Interval[inf, sup] end
   end
 
   alias_method :+, :union

data/lib/borel/interval_multiple.rb

@@ -1,36 +1,45 @@
+# Retains the logic specific for intervals with multiple components
 class Interval::Multiple < Interval
   attr :components
 
+  # @return [Interval]
   def initialize(array)
     @components = array
     freeze
   end
 
+  # @return [Interval]
   def each
     components.each{|o| yield(o)}
     self
   end
 
+  # @return [Object]
   def inf
     components.first.inf
   end
 
+  # @return [Object]
   def sup
     components.last.sup
   end
 
+  # @return [Array]
   def construction
     map &:construction
   end
 
+  # @return [Boolean]
   def include?(x)
     any?{|i| i.include? x}
   end
 
+  # @return [Boolean]
   def degenerate?
     all? &:degenerate?
   end
 
+  # @return [Boolean]
   def simple?
     false
   end

data/lib/borel/interval_simple.rb

@@ -1,5 +1,8 @@
+# Retains the logic specific for intervals with a single component
+# in the form [inf,sup]
 class Interval::Simple < Interval
-  attr :inf, :sup
+  attr :inf
+  attr :sup
 
   def initialize (a, b = a)
     if (a.respond_to?(:nan?) && a.nan?) || (b.respond_to?(:nan?) && b.nan?)
@@ -10,43 +13,53 @@ class Interval::Simple < Interval
     freeze
   end
 
+  # @return [Simple]
   def each
     yield(self)
     self
   end
 
+  # @return [Interval]
   def intersect(other)
     Interval[[inf, other.inf].max, [sup, other.sup].min]
   end
 
+  # @return [Interval::Multiple]
   def complement
     Interval[[-Infinity, inf], [sup, Infinity]]
   end
 
+  # @return [Interval]
   def minus(other)
     other.complement.intersect self
   end
 
+  # @return [Array<Interval>]
   def components
     [self]
   end
 
+  # @return [Array]
   def extrema
     [inf, sup]
   end
 
+  # @return [Array]
   def construction
     extrema.uniq
   end
 
+  # @return [Boolean]
   def include?(x)
     inf <= x && x <= sup
   end
 
+  # @return [Boolean]
   def degenerate?
     inf == sup
   end
 
+  # @return [Boolean]
   def simple?
     true
   end

data/lib/borel/math_extensions/interval_arithmetic.rb

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

data/lib/borel/math_extensions/randomizable.rb

@@ -1,16 +1,18 @@
 require 'borel/math_extensions/interval_arithmetic'
 
 module Borel
+  # Includes methods for picking random elements on intervals
   module Randomizable
+    # @return [Object] a random element of the interval
     def rand
-      raise EmptyInterval if self.respond_to?(:empty?) and self.empty?
+      raise EmptyInterval if respond_to?(:empty?) and empty?
 
-      if self.simple?
-        Random.new.rand Range.new *self.extrema
+      if simple?
+        Random.new.rand Range.new *extrema
       else
-        total_weight = self.map(&:width).reduce(:+)
+        total_weight = map(&:width).reduce(:+)
         selected_weight = Random.new.rand 0..total_weight
-        rand_interval = self.find{|c| (selected_weight -= c.width) <= 0}
+        rand_interval = find{|c| (selected_weight -= c.width) <= 0}
         Random.new.rand Range.new *rand_interval.extrema
       end
     end

data/lib/borel/nil_class.rb

@@ -1,4 +1,8 @@
+# Extends {#to_interval} for the {Array} class
 class NilClass
+
+  # Initializes an empty interval
+  # @return [Interval]
   def to_interval
     Interval[]
   end

data/lib/borel/numeric.rb

@@ -1,4 +1,7 @@
+# Extends {#to_interval} for the {Numeric} class
 class Numeric
+  # Initializes an interval with the calling number as the only point
+  # @return [Interval]
   def to_interval
     Interval[self]
   end

data/lib/borel/range.rb

@@ -1,4 +1,7 @@
+# Extends {#to_interval} for the {Array} class
 class Range
+
+  # @return [Interval]
   def to_interval
     Interval[first,
       if exclude_end?

data/lib/borel/version.rb

@@ -1,10 +1,17 @@
+# Namespace for all interval related classes
 module Borel
+  # Major version number
   MAJOR = 0
+  # Minor version number
   MINOR = 3
-  TINY = 2
+  # Tiny version number
+  TINY = 3
 
+  # Joins the version numbers
   VERSION = [MAJOR, MINOR, TINY].join('.')
 
+  # Returns {VERSION}
+  # @return [String]
   def self.version
     VERSION
   end

data/tasks/rspec.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: borel
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-09 00:00:00.000000000 Z
+date: 2012-04-13 00:00:00.000000000 Z
 dependencies: []
 description: ! 'Borel sets are made of enumerable union and intersection of
 
-  intervals. Borel performs regular operations on any interval of any
+  intervals. Borel performs regular operations on intervals of any
 
   Comparable class.'
 email:
@@ -23,7 +23,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .rspec
 - Gemfile
 - Guardfile
 - LICENSE
@@ -65,7 +64,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -74,9 +73,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: borel
-rubygems_version: 1.8.17
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
-summary: Generic ordered set's operations
+summary: Interval operation on Comparable classes
 test_files: []
 has_rdoc: 

data/.rspec

@@ -1 +0,0 @@
---colour