galaaz 0.4.0

data/specs/r_vector_functions.spec.rb

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+
+##########################################################################################
+# @author Rodrigo Botafogo
+#
+# Copyright © 2018 Rodrigo Botafogo. All Rights Reserved. Permission to use, copy, modify, 
+# and distribute this software and its documentation, without fee and without a signed 
+# licensing agreement, is hereby granted, provided that the above copyright notice, this 
+# paragraph and the following two paragraphs appear in all copies, modifications, and 
+# distributions.
+#
+# IN NO EVENT SHALL RODRIGO BOTAFOGO BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, 
+# INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF 
+# THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF RODRIGO BOTAFOGO HAS BEEN ADVISED OF THE 
+# POSSIBILITY OF SUCH DAMAGE.
+#
+# RODRIGO BOTAFOGO SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE 
+# SOFTWARE AND ACCOMPANYING DOCUMENTATION, IF ANY, PROVIDED HEREUNDER IS PROVIDED "AS IS". 
+# RODRIGO BOTAFOGO HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, 
+# OR MODIFICATIONS.
+##########################################################################################
+
+require 'galaaz'
+
+describe R::Vector do
+  
+  #--------------------------------------------------------------------------------------
+  #
+  #--------------------------------------------------------------------------------------
+  
+  it " should match two vectors with %in%" do
+    vec1 = R.c(1, 2, 3, 4)
+    vec2 = R.c(1, 2, 3, 4)
+    vec3 = R.c(3, 4, 5)
+    vec4 = R.c(4, 5, 6, 7)
+    
+    # R has functions defined with '%%' notation.  In order to access those functions
+    # from SciCom we use the '._' method with two arguments, the first argument is the
+    # name of the function, for instance, function %in%, the name of the method is ':in'
+    # Ex: vec1 %in% vec2 => vec1._ :in, vec2 
+    expect((vec1._ :in, vec2).identical(R.c(true, true, true, true))).to eq true
+    expect((vec1._ :in, vec3).identical(R.c(false, false, true, true))).to eq true
+    expect((vec2._ :in, vec4).identical(R.c(false, false, false, true))).to eq true
+    
+  end
+  
+end
+  
+=begin    
+it "should allow adding elements to the vector" do
+      R.eval(<<-R)
+         vec = c(2.1, 4.2, 3.3, 5.4);
+         print(order(vec));
+      R
+
+    end
+=end    
+

data/specs/r_vector_object.spec.rb

@@ -0,0 +1,94 @@
+# -*- coding: utf-8 -*-
+
+##########################################################################################
+# @author Rodrigo Botafogo
+#
+# Copyright © 2018 Rodrigo Botafogo. All Rights Reserved. Permission to use, copy, modify, 
+# and distribute this software and its documentation, without fee and without a signed 
+# licensing agreement, is hereby granted, provided that the above copyright notice, this 
+# paragraph and the following two paragraphs appear in all copies, modifications, and 
+# distributions.
+#
+# IN NO EVENT SHALL RODRIGO BOTAFOGO BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, 
+# INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF 
+# THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF RODRIGO BOTAFOGO HAS BEEN ADVISED OF THE 
+# POSSIBILITY OF SUCH DAMAGE.
+#
+# RODRIGO BOTAFOGO SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE 
+# SOFTWARE AND ACCOMPANYING DOCUMENTATION, IF ANY, PROVIDED HEREUNDER IS PROVIDED "AS IS". 
+# RODRIGO BOTAFOGO HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, 
+# OR MODIFICATIONS.
+##########################################################################################
+
+require 'galaaz'
+
+describe R::Vector do
+
+  context "When assigning attributes to a Vector" do
+
+    before(:each) do
+      @vect = R.c(1, 2, 3, 4, 5, 6)
+    end
+    
+    it "should assign names to vectors" do
+      # set names
+      @vect.names = R.c("a", "b", "c", "d", "e", "f")
+      expect(@vect.names.identical(R.c("a", "b", "c", "d", "e", "f"))).to eq true
+    end
+    
+    it "should assign a dim to vector" do
+      # set dim
+      @vect.dim = R.c(3, 2)
+      expect(@vect.dim[1]).to eq 3
+      expect(@vect.dim[2]).to eq 2
+    end
+
+    it "should assign row.names to a vector with dimention" do
+      @vect.dim = R.c(3, 2)
+      # set row.names
+      @vect.row__names = R.c("A", "B", "C")
+      expect(@vect.row__names.identical(R.c("A", "B", "C")))
+      # note that when accessing row__names[2] we are getting a native ruby object
+      # and not a vector.  This might change in future versions
+      expect(@vect.row__names[2]).to eq "B"
+    end
+
+    it "should set the class of the object using rclass" do
+      # set the R class.  Note that we need to use rclass instead of class, since
+      # class is a Ruby keyword 
+      @vect.rclass = "myClass"
+      expect(@vect.rclass).to eq "myClass"
+    end
+
+    it "should set the attribute of a Vector using attr" do
+      # the other alternative is to use method attr to change the attribute
+      @vect.attr = {which: "class", value: "newClass"}
+      expect(@vect.rclass).to eq "newClass"
+    end
+      
+    it "should allow changing an element of a vector attribute" do
+      # pending "Need to implement new function for this"
+      # set names
+      @vect.names = R.c("a", "b", "c", "d", "e", "f")
+      @vect.names[2] = "hello"
+      expect(@vect.names[2]).to eq "hello"
+    end
+    
+  end
+
+  context "When passing named arguments" do
+
+    it "Named arguments should become the names of the vector" do
+      vect = R.c(a: 1, b: 2, c: 3, d: 4)
+      expect(vect.names.identical(R.c("a", "b", "c", "d"))).to eq true
+    end
+    
+    it "should allow adding names to sub-vectors" do
+      vect = R.c(1, 2, 3, a: R.c(1, 2, 3), b: 5, c: 6)
+      expect(vect.names.identical(R.c("", "", "", "a1", "a2", "a3", "b", "c"))).to eq true
+    end
+
+  end
+
+end

data/specs/r_vector_operators.spec.rb

@@ -0,0 +1,174 @@
+# -*- coding: utf-8 -*-
+
+##########################################################################################
+# @author Rodrigo Botafogo
+#
+# Copyright © 2018 Rodrigo Botafogo. All Rights Reserved. Permission to use, copy, modify, 
+# and distribute this software and its documentation, without fee and without a signed 
+# licensing agreement, is hereby granted, provided that the above copyright notice, this 
+# paragraph and the following two paragraphs appear in all copies, modifications, and 
+# distributions.
+#
+# IN NO EVENT SHALL RODRIGO BOTAFOGO BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, 
+# INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF 
+# THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF RODRIGO BOTAFOGO HAS BEEN ADVISED OF THE 
+# POSSIBILITY OF SUCH DAMAGE.
+#
+# RODRIGO BOTAFOGO SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE 
+# SOFTWARE AND ACCOMPANYING DOCUMENTATION, IF ANY, PROVIDED HEREUNDER IS PROVIDED "AS IS". 
+# RODRIGO BOTAFOGO HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, 
+# OR MODIFICATIONS.
+##########################################################################################
+
+require 'galaaz'
+
+describe R::Vector do
+
+  #----------------------------------------------------------------------------------------
+   context "Arithmetic operators" do
+
+     before(:each) do
+       @vec1 = R.c(3, 5.7, 10, 12)
+       @vec2 = R.c(2.3, 3, 9, 17)
+     end
+     
+     it "should add two vectors" do
+       res = @vec1 + @vec2
+       expect(res.all__equal(R.c(5.3, 8.7, 19, 29))).to eq true
+     end
+
+     it "should subtract two vectors" do
+       res = @vec1 - @vec2
+       expect(res.all__equal(R.c(0.7, 2.7, 1.0, -5.0))).to eq true
+     end
+
+     it "should multiply two vectors" do
+       res = @vec1 * @vec2
+       expect(res.all__equal(R.c(6.9, 17.1, 90.0, 204.0))).to eq true
+     end
+
+     it "should exponentiate two vectors" do
+       res = @vec1 ** @vec2
+       expect(res.all__equal(R.c(3**2.3, 5.7**3, 10**9, 12**17))).to eq true
+     end
+
+     it "should divide two vectors" do
+       res = @vec1 / @vec2
+       expect(res.all__equal(R.c(3/2.3, 5.7/3, 10/9.0, 12.0/17))).to eq true
+     end
+
+     it "should calculate the modulus of two vectors" do
+       res = @vec1 % @vec2
+       expect(res.all__equal(R.c(3%2.3, 5.7%3, 10%9.0, 12.0%17))).to eq true
+     end
+
+     it "should apply unary minus to all elements of a vector" do
+       expect((-@vec1).all__equal(R.c(-3, -5.7, -10, -12))).to eq true
+     end
+
+     it "should operate with Numeric first" do
+       res = 10 + @vec1
+       expect(res == R.c(13, 15.7, 20, 22)).to eq true
+       res = 10 - @vec1
+       expect(res == R.c(7, 4.3, 0, -1)).to eq true
+       res = 10 / @vec1
+       expect(res == R.c(3.3333333, 1.7543860, 1, 0.8333333)).to eq true
+     end
+     
+   end
+
+   #----------------------------------------------------------------------------------------
+   context "Comparison operators" do
+
+     it "should check vectors for equality / inequality" do
+       vec1 = R.c(1, 2)
+       vec2 = R.c(1, 2)
+       vec3 = R.c(0, 2)
+
+       expect((vec1 == vec2).all__equal(R.c(true, true))).to eq true
+       expect((vec1 != vec2).all__equal(R.c(false, false))).to eq true
+       expect((vec1 == vec3).all__equal(R.c(false, true))).to eq true
+     end
+
+     it "should check vectors for <, <=, >, >=" do
+       vec1 = R.c(1, 2, 3)
+       vec2 = R.c(0, 4, 3)
+
+       expect((vec1 < vec2).all__equal(R.c(false, true, false))).to eq true
+       expect((vec1 <= vec2).all__equal(R.c(false, true, true))).to eq true
+       expect((vec1 > vec2).all__equal(R.c(true, false, false))).to eq true
+       expect((vec1 >= vec2).all__equal(R.c(true, false, true))).to eq true
+     end
+
+   end
+
+   #----------------------------------------------------------------------------------------
+   context "Logical operators" do
+
+     before(:each) do
+       @vec1 = R.c(true, true, false, true)
+       @vec2 = R.c(true, false, false, false)
+     end
+     
+     it "should negate a vector" do
+       expect((!@vec1).all__equal(R.c(false, false, true, false))).to eq true
+     end
+
+     it "should 'and' and 'or' two vectors" do
+       expect((@vec1 & @vec2).all__equal R.c(true, false, false, false)).to eq true
+       expect((@vec1 | @vec2).all__equal R.c(true, true, false, true)).to eq true
+     end
+     
+   end
+
+   #----------------------------------------------------------------------------------------
+   context "Access from Ruby" do
+     
+     before(:each) do
+       @vec1 = R.c(3, 5.7, 10, 12)
+       @vec2 = R.c(2.3, 3, 9, 17)
+     end
+
+     it "Should retrieve Numeric values from a vector with '<<'" do
+       # subsetting a vector with '[' and '[[' returns an R::Vector, not a Numeric object
+       # Use the '<<' operator to retrieve an element of the R::Vector as a Numeric
+       # object
+       expect(@vec1[1].is_a? R::Vector).to eq true
+       expect((@vec1 << 0).is_a? Numeric).to eq true
+
+       # Note, however, that indexing starts at 0
+       expect((@vec1 << 0)).to eq 3
+       expect((@vec1 << 2)).to eq 10
+     end
+
+     it "should treat R::Vector as an Enumerable" do
+       # each 'value' is an R::Vector, with only 1 element.  In order to use Ruby 'sum'
+       # we need to extract the value as a Ruby Numeric with << 1
+       expect(@vec1.sum { |value| value << 0 }).to eq 30.7
+     end
+
+     it "should implement 'pop' to extract the first element of an R::Vector" do
+       # pop is equivalent to '<< 1'
+       expect(@vec1.pop).to eq 3
+     end
+
+     it "should allow storage and retrieval of Ruby Objects in R data structure" do
+
+       class RData
+         def val
+           5
+         end
+       end
+
+       # Using 'c' to add an external element, transforms the vector into a list
+       vec3 = R.c(RData.new, RData.new)
+       
+       expect(vec3[[1]].is_a? RData).to eq true
+       expect(vec3[[1]].val == 5).to eq true
+       expect(vec3[[2]].val == 5).to eq true
+     end
+     
+   end
+   
+end

data/specs/r_vector_subsetting.spec.rb

@@ -0,0 +1,136 @@
+# -*- coding: utf-8 -*-
+
+##########################################################################################
+# @author Rodrigo Botafogo
+#
+# Copyright © 2018 Rodrigo Botafogo. All Rights Reserved. Permission to use, copy, modify, 
+# and distribute this software and its documentation, without fee and without a signed 
+# licensing agreement, is hereby granted, provided that the above copyright notice, this 
+# paragraph and the following two paragraphs appear in all copies, modifications, and 
+# distributions.
+#
+# IN NO EVENT SHALL RODRIGO BOTAFOGO BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, 
+# INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF 
+# THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF RODRIGO BOTAFOGO HAS BEEN ADVISED OF THE 
+# POSSIBILITY OF SUCH DAMAGE.
+#
+# RODRIGO BOTAFOGO SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE 
+# SOFTWARE AND ACCOMPANYING DOCUMENTATION, IF ANY, PROVIDED HEREUNDER IS PROVIDED "AS IS". 
+# RODRIGO BOTAFOGO HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, 
+# OR MODIFICATIONS.
+##########################################################################################
+
+require 'galaaz'
+
+describe R::Vector do
+
+  context "When subsetting a Vector" do
+
+    before(:all) do
+      @vect = R.c(1, 2, 3, 4, 5)
+    end
+    
+    it "should subset vector with integer obtaining a single element" do
+      # indexing a vector with a positive interger returns the value at the index
+      expect(@vect[1]).to eq 1
+      expect(@vect[3]).to eq 3
+      expect(@vect[5]).to eq 5
+    end
+
+    it "should subset a vector with a negative integer obtaining a Vector" do
+      # a vector when indexed with a negative integer, is a vector without the
+      # given element.  So, we are here removing the second element of the vector
+      # which leave us with the second element being 3
+      expect(@vect[-2].identical(R.c(1, 3, 4, 5))).to eq true
+      expect(@vect[-3].identical(R.c(1, 2, 4, 5))).to eq true
+    end
+      
+    it "should subset a vector with another integer vector" do
+      expect(@vect[R.c(2, 4)][1]).to eq 2
+      expect(@vect[R.c(2, 4)][2]).to eq 4
+      expect(@vect[R.c(3, 3)][2]).to eq 3
+    end
+    
+    it "should allow reordering of elements based on function" do
+      vect = R.c(2.1, 4.2, 3.3, 5.4)
+      expect(vect[R.order(vect)][2]).to eq 3.3
+      expect(vect[R.order(vect)][3]).to eq 4.2
+    end
+
+    it "should subset with another character vector" do
+      x = R.c("m", "f", "u", "f", "f", "m", "m")
+      lookup = R.c(m: "Male", f: "Female", u: R::NA)
+
+      res = R.c("Male", "Female", R::NA, "Female", "Female", "Male", "Male")
+      res.names = R.c("m", "f", "u", "f", "f", "m", "m") 
+
+      expect(lookup[x].all__equal res).to eq true
+    end
+
+    it "should subset with 'each'" do
+      i = 1
+      @vect.each do |elmt|
+        expect(elmt.typeof == 'integer').to eq true
+        expect(elmt == i).to eq true
+        i += 1
+      end
+    end
+
+    it "should subset with 'each_with_index'" do
+      # note that the index starts at 1, since we are getting back an R::Vector
+      # element
+      @vect.each_with_index do |elmt, i|
+        expect(elmt.typeof == 'integer').to eq true
+        expect elmt == i
+      end
+    end
+
+    it "should subset with 'each(:native)' getting back a native Ruby element (not R::Vector)" do
+      # in order to access the internal Ruby element from the R::Vector, use 'each' with
+      # the :native keyword
+      @vect.each(:native) do |elmt|
+        expect(elmt.is_a? Numeric).to eq true
+      end
+    end
+
+    it "should subset with 'each_with_index(:native)' getting a Ruby element" do
+      # when using the :native keyword, indexing starts at 0
+      @vect.each_with_index(:native) do |elmt, i|
+        expect elmt == i + 1
+      end
+    end
+    
+  end
+  
+  #----------------------------------------------------------------------------------------
+  context "When subseting with double square brackets" do
+    
+    it "should retrieve values the same way as single square brackets" do
+      vect = R.c(2.1, 4.2, 3.3, 5.4)
+      expect vect[[1]] == 2.1
+    end
+    
+  end
+  
+  #----------------------------------------------------------------------------------------
+  context "When subset assigning to a vector" do
+    
+    before(:all) do
+      @vect = R.c(1, 2, 3, 4, 5)
+    end
+
+    it "should subset assign with integer" do
+      expect(@vect[2]).to eq 2
+      @vect[2] = 1000
+      expect @vect[2] == 1000
+    end
+    
+    it "should subset assign to the elements given by another vector" do
+      @vect[R.c(2, 3)] = R.c(1000, 2000)
+      expect(@vect.identical(R.c(1, 1000, 2000, 4, 5))).to eq true
+    end
+    
+  end
+  
+end