sparse_matrix 1.5.0 → 1.6.0

data/lib/sparse_matrix.rb

@@ -1,7 +1,27 @@
+# = Fichero que contiene la gema para el trabajo con matrices.
+# 
+#  Operaciones con matrices *dispersas* y *densas*.
+# 
+#  Authors: KEVIN ISAAC ROBAYNA HERNANDEZ, JOSE ANTONIO RODRIGUEZ LEANDRO
+# 
+#  Email:  kevinirobaynahdez@gmail.com, alu0100696691@ull.edu.es
+# 
+
 require "sparse_matrix/version"
 
+
+# == Modulo que contiene la gema para el trabajo con matrices.
+# 
+#  Para la realizacion de esta practica se ha creado una jeraquia de clases. Todo esta integrado en un module llamado SparseMatrix,
+#  el cual contiene la clase madre abstracta AbstractMatrix con la que creamos las clases SparseMatrix y DenseMatrix. 
+#  Para almacenar los datos de la matriz dispersa usamos un vector de duplas usando la clase SparseVector.
+#  Los metodos implementados usando metodologia funcional son:
+# 
+#  * suma
+#  * multiplicacion
+# 
 module SparseMatrix
-    class AbstractMatrix
+    class AbstractMatrix #clase abstracta matrix
         
         def initialize(r=0,c=0)
             @row = r
@@ -23,15 +43,14 @@ module SparseMatrix
         end
         
         def +(b)
-        raise "Error. metodo no definido."
+            raise "Error. metodo no definido."
+        end
+        def *(b)
+            raise "Error. metodo no definido."
+        end
     end
-    
-    def *(b)
-    raise "Error. metodo no definido."
-end
-end
 
-class SparseVector
+class SparseVector #clase para guardar vector de tuplas
     def initialize(i=0,j=0,v=0)
         @i = i
         @j = j
@@ -45,7 +64,7 @@ class SparseVector
     
 end
 
-class SparseMatrix < AbstractMatrix
+class SparseMatrix < AbstractMatrix #matrix dispersa
     
     def initialize(*args)
         @n,@m=args[0],args[1]
@@ -67,7 +86,7 @@ class SparseMatrix < AbstractMatrix
         @MAT<<vector
     end
     
-    def to_s
+    def to_s #devuelve una cadena string
         cadena=""
         for i in 0...@n
             cadena+="["
@@ -83,7 +102,7 @@ class SparseMatrix < AbstractMatrix
         
     end
     
-    def valor(k,j)
+    def valor(k,j)  #para buscar un valor especifico
         dev=0
         for i in 0...@MAT.size
             if(@MAT[i].i==k) && (@MAT[i].j==j)
@@ -93,8 +112,7 @@ class SparseMatrix < AbstractMatrix
         dev
     end
     
-    
-    def max
+    def max  #elemento maximo de la matrix
         maximo=@MAT[0].value
         for i in 0...@m do
             if maximo < @MAT[i].value
@@ -102,56 +120,56 @@ class SparseMatrix < AbstractMatrix
             end
         end
         return maximo
-        end
+    end
         
-        def min
-            minimo=@MAT[0].value
-            for i in (0...@m) do
-                if minimo > @MAT[i].value
-                    minimo=@MAT[i].value
-                end
-            end
-            return minimo
+    def min  #elemento minimo de la matrix
+        minimo=@MAT[0].value
+        for i in (0...@m) do
+            if minimo > @MAT[i].value
+                minimo=@MAT[i].value
             end
+        end
+        return minimo
+    end
             
-            def +(other)
-            if other.instance_of? SparseMatrix
-                o=DenseMatrix.new(@n,@m,Array.new(@n){Array.new(@m)})
-                for i in 0...@MAT.size
-                    for j in 0...@MAT.size
-                        o.mat[i][j]=self.valor(i,j)+other.valor(i,j)
-                    end
+    def +(other)  #metodo para sumar matrices, dispersa como densa
+        if other.instance_of? SparseMatrix
+            o=DenseMatrix.new(@n,@m,Array.new(@n){Array.new(@m)})
+            0.upto @MAT.size-1 do |i|
+                0.upto @MAT.size-1 do |j|
+                    o.mat[i][j]=self.valor(i,j)+other.valor(i,j)
                 end
-                return SparseMatrix.new(@n,@m,o.mat)                       #SparseMatrix.new(@n,@m,o)
-                else
-                o=DenseMatrix.new(@n,@m,Array.new(@n){Array.new(@m)})
-                for i in 0...@n
-                    for j in 0...@m
-                        o.mat[i][j]=self.valor(i,j)+other.mat[i][j]
-                    end
+            end
+            return SparseMatrix.new(@n,@m,o.mat)                       #SparseMatrix.new(@n,@m,o)
+        else
+            o=DenseMatrix.new(@n,@m,Array.new(@n){Array.new(@m)})
+            0.upto @n-1 do |i|
+                0.upto @m-1 do |j|
+                    o.mat[i][j]=self.valor(i,j)+other.mat[i][j]
                 end
-                return o
             end
+            return o
         end
+    end
         
-        def *(b)
+    def *(b)  #metodo para multiplicar matrices, dispersa como densas
         if b.instance_of? SparseMatrix
             c = DenseMatrix.new(2,2,[[0.0,0.0],[0.0,0.0]])
-            for i in(0...@MAT.size)
-                for j in(0...@MAT.size)
+            0.upto @MAT.size-1 do |i|
+                0.upto @MAT.size-1 do |j|
                     c.mat[i][j]=0
-                    for k in (0...@MAT.size)
+                    0.upto @MAT.size-1 do |k|
                         c.mat[i][j] += self.valor(i,k)*b.valor(k,j)
                     end
                 end
             end
             c
-            else
+        else
             c = DenseMatrix.new(2,2,[[0.0,0.0],[0.0,0.0]])
-            for i in(0...@MAT.size)
-                for j in(0...@MAT.size)
+            0.upto @MAT.size-1 do |i|
+                0.upto @MAT.size-1 do |j|
                     c.mat[i][j]=0
-                    for k in (0...@MAT.size)
+                    0.upto @MAT.size-1 do |k|
                         c.mat[i][j] += self.valor(i,k)*b.mat[k][j]
                     end
                 end
@@ -159,11 +177,10 @@ class SparseMatrix < AbstractMatrix
             c
         end
     end
-    
 end
 
 
-class DenseMatrix < AbstractMatrix
+class DenseMatrix < AbstractMatrix  #clase para matrices densas
     @mat
     def initialize(r=0,c=0,matrix=[])
         super(r,c)
@@ -172,7 +189,7 @@ class DenseMatrix < AbstractMatrix
     
     attr_accessor :mat,:r,:c
     
-    def to_s()
+    def to_s() #devuelve cadena string
         s="| "
         for i in (0... @mat.length)
             for j in (0... @mat.length)
@@ -188,7 +205,7 @@ class DenseMatrix < AbstractMatrix
         s += "|"
     end
     
-    def print_matrix()
+    def print_matrix()  #metodo que imprime la matrix en pantalla
         printf "| "
         for i in (0... @mat.length)
             for j in (0... @mat.length)
@@ -204,53 +221,53 @@ class DenseMatrix < AbstractMatrix
         printf "|"
     end
     
-    def +(b)
-    c = DenseMatrix.new(2,2,[[0.0,0.0],[0.0,0.0]])
-    if b.instance_of? SparseMatrix
-    for i in (0...@mat.length)
-    for j in (0...@mat.size)
-    c.mat[i][j] = self.mat[i][j]+b.valor(i,j)
-end
-end
-c
-else
-for i in (0...mat.length)
-    for j in (0...@mat.size)
-        c.mat[i][j] = self.mat[i][j]+b.mat[i][j]
+    def +(b)  #suma de matrices, tando densas como dispersas
+        c = DenseMatrix.new(2,2,[[0.0,0.0],[0.0,0.0]])
+        if b.instance_of? SparseMatrix
+            0.upto @mat.size-1 do |i|
+                0.upto @mat.size-1 do |j|
+                    c.mat[i][j] = self.mat[i][j]+b.valor(i,j)
+                end
+            end
+            c
+        else
+            0.upto @mat.size-1 do |i|
+                0.upto @mat.size-1 do |j|
+                    c.mat[i][j] = self.mat[i][j]+b.mat[i][j]
+                end
+            end
+            c
+        end
     end
-end
-c
-end
-end
 
-def *(b)
-if b.instance_of? SparseMatrix
-    c = DenseMatrix.new(2,2,[[0.0,0.0],[0.0,0.0]])
-    for i in(0...@mat.length)
-        for j in(0...@mat.length)
-            c.mat[i][j]=0
-            for k in (0...@mat.length)
-                c.mat[i][j] += @mat[i][k]*b.valor(k,j)
+    def *(b)  #multiplicacion de matrices, dispersas y densas
+    if b.instance_of? SparseMatrix
+        c = DenseMatrix.new(2,2,[[0.0,0.0],[0.0,0.0]])
+        0.upto @mat.length-1 do |i|
+            0.upto @mat.length-1 do |j|
+                c.mat[i][j]=0
+                0.upto @mat.length-1 do |k|
+                    c.mat[i][j] += @mat[i][k]*b.valor(k,j)
+                end
             end
         end
-    end
-    c
+        c
     else
-    c = DenseMatrix.new(2,2,[[0.0,0.0],[0.0,0.0]])
-    for i in(0...@mat.length)
-        for j in(0...@mat.length)
-            c.mat[i][j]=0
-            for k in (0...@mat.length)
-                c.mat[i][j] += @mat[i][k]*b.mat[k][j]
+        c = DenseMatrix.new(2,2,[[0.0,0.0],[0.0,0.0]])
+        0.upto @mat.length-1 do |i|
+            0.upto @mat.length-1 do |j|
+                c.mat[i][j]=0
+                0.upto @mat.length-1 do |k|
+                    c.mat[i][j] += @mat[i][k]*b.mat[k][j]
+                end
             end
         end
+        c
+    end
     end
-    c
-end
-end
 end
 
-class Fraction
+class Fraction  #clase para operaciones de numeros fraccionales
     include Comparable
     def  initialize (*args)
         if args.size == 2
@@ -264,97 +281,112 @@ class Fraction
     end
     attr_accessor :num_,:den_
     
-    def to_s
+    def to_s #devuelve string
         "#{@num_}/#{@den_}"
     end
-    def to_f
+    def to_f #devuelve float
         @num_.to_f/@den_.to_f
     end
     
-    def ==(b)
-    return @num_.eql?(b.num_) && @den_.eql?(b.den_)
-end
-
-def abs
-    c = @num_.to_f/@den_.to_f
-    return c.abs
-end
-
-def reciprocal
-    f=Fraction.new
-    f.num_=@den_
-    f.den_ = @num_
-    f
-end
+    def ==(b) #comparar
+        return @num_.eql?(b.num_) && @den_.eql?(b.den_)
+    end
 
-def -@
-Fraction.new(-@num_,@den_)
-end
+    def abs  #valor absoluto
+        c = @num_.to_f/@den_.to_f
+        return c.abs
+    end
 
-def +(b)
-r=Fraction.new
-if (@den_==b.den_)
-    r.num_ = @num_ + b.num_
-    r.den_ = @den_
-    else
-    r.num_ = @num_ * b.den_ + b.num_ * @den_
-    r.den_ = @den_ * b.den_
-end
-r.num_,r.den_ = minimiza(r.num_,r.den_)
-return r
-end
+    def reciprocal #devuelve fraccion dada la vuelta
+        f=Fraction.new
+        f.num_=@den_
+        f.den_ = @num_
+        f
+    end
 
-def -(b)
-r =Fraction.new
-if (@den_ == b.den_)
-    r.num_=@num_- b.num_
-    r.den_=@den_
-    else
-    r.num_=@num_ * b.den_ - b.num_ * @den_
-    r.den_ = @den_ * b.den_
-end
-r.num_,r.den_ = minimiza(r.num_,r.den_)
-r
-end
+    def -@  #opuesto
+        Fraction.new(-@num_,@den_)
+    end
+    
+    def +(b) #suma de numeros fraccionarios
+        r=Fraction.new
+        if b.instance_of? Fraction
+            if (@den_==b.den_)
+                r.num_ = @num_ + b.num_
+                r.den_ = @den_
+            else
+                r.num_ = @num_ * b.den_ + b.num_ * @den_
+                r.den_ = @den_ * b.den_
+            end
+        else
+            r=self+Fraction.new(b,1)
+        end
+        r.num_,r.den_ = minimiza(r.num_,r.den_)
+        r
+    end
 
-def *(b)
-r =Fraction.new
-r.num_=@num_ * b.num_
-r.den_=@den_ * b.den_
-r.num_,r.den_ = minimiza(r.num_,r.den_)
-return r
-end
+    def -(b) #resta de numeros fraccionarios
+        r =Fraction.new
+        if b.instance_of? Fraction
+            if (@den_==b.den_)
+                r.num_ = @num_ - b.num_
+                r.den_ = @den_
+            else
+                r.num_ = @num_ * b.den_ - b.num_ * @den_
+                r.den_ = @den_ * b.den_
+            end
+        else
+            r=self-Fraction.new(b,1)
+        end
+        r.num_,r.den_ = minimiza(r.num_,r.den_)
+        r
+    end
 
-def /(b)
-r =Fraction.new
-r.num_=@num_ / b.num_
-r.den_=@den_ * b.den_
-r.num_,r.den_ = minimiza(r.num_,r.den_)
-r
-end
+    def *(b)  #multiplicacion de numeros fraccionarios
+        r =Fraction.new
+        if b.instance_of? Fraction
+            r.num_=@num_ * b.num_
+            r.den_=@den_ * b.den_
+            r.num_,r.den_ = minimiza(r.num_,r.den_)
+            r
+        else
+            r=self*Fraction.new(b,1)
+        end
+    end
 
-def <=>(b)
-self.to_f <=> b.to_f
-end
+    def /(b)  #division de numeros fraccionarios
+        r =Fraction.new
+        if b.instance_of? Fraction
+            r.num_=@num_ / b.num_
+            r.den_=@den_ * b.den_
+            r.num_,r.den_ = minimiza(r.num_,r.den_)
+            r
+        else
+            r=self/Fraction.new(b,1)
+        end
+    end
 
-def minimiza(x,y)
-    d = gcd(x,y)
-    x = x/d
-    y = y/d
-    return x,y
-end
+    def <=>(b)  #comparar
+        self.to_f <=> b.to_f
+    end
 
-def coerce(other)
-    [self,other]
-end
-end
+    def minimiza(x,y) #minimizar fraccion
+        d = gcd(x,y)
+        x = x/d
+        y = y/d
+        return x,y
+    end
 
-def gcd(u, v)
-    u, v = u.abs, v.abs
-    while v != 0
-        u, v = v, u % v
+    def coerce(b)
+        [self,Fraction.new(b,1)]
     end
-    u
 end
 
+    def gcd(u, v) #maximo comun divisor
+        u, v = u.abs, v.abs
+        while v != 0
+            u, v = v, u % v
+        end
+        u
+    end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sparse_matrix
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - KevinRobayna
@@ -108,6 +108,56 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- documentacion/Gemfile.html
+- documentacion/Gemfile_lock.html
+- documentacion/Guardfile.html
+- documentacion/LICENSE_txt.html
+- documentacion/Object.html
+- documentacion/README_md.html
+- documentacion/Rakefile.html
+- documentacion/SparseMatrix.html
+- documentacion/SparseMatrix/AbstractMatrix.html
+- documentacion/SparseMatrix/DenseMatrix.html
+- documentacion/SparseMatrix/Fraction.html
+- documentacion/SparseMatrix/SparseMatrix.html
+- documentacion/SparseMatrix/SparseVector.html
+- documentacion/created.rid
+- documentacion/documentacion/created_rid.html
+- documentacion/images/add.png
+- documentacion/images/arrow_up.png
+- documentacion/images/brick.png
+- documentacion/images/brick_link.png
+- documentacion/images/bug.png
+- documentacion/images/bullet_black.png
+- documentacion/images/bullet_toggle_minus.png
+- documentacion/images/bullet_toggle_plus.png
+- documentacion/images/date.png
+- documentacion/images/delete.png
+- documentacion/images/find.png
+- documentacion/images/loadingAnimation.gif
+- documentacion/images/macFFBgHack.png
+- documentacion/images/package.png
+- documentacion/images/page_green.png
+- documentacion/images/page_white_text.png
+- documentacion/images/page_white_width.png
+- documentacion/images/plugin.png
+- documentacion/images/ruby.png
+- documentacion/images/tag_blue.png
+- documentacion/images/tag_green.png
+- documentacion/images/transparent.png
+- documentacion/images/wrench.png
+- documentacion/images/wrench_orange.png
+- documentacion/images/zoom.png
+- documentacion/index.html
+- documentacion/js/darkfish.js
+- documentacion/js/jquery.js
+- documentacion/js/navigation.js
+- documentacion/js/search.js
+- documentacion/js/search_index.js
+- documentacion/js/searcher.js
+- documentacion/rdoc.css
+- documentacion/sparse_matrix_gemspec.html
+- documentacion/table_of_contents.html
 - lib/sparse_matrix.rb
 - lib/sparse_matrix/version.rb
 - sparse_matrix.gemspec