jblas-ruby 1.1.1

data/lib/jblas/mixin_class.rb

@@ -0,0 +1,80 @@
+# Mixin for class methods of the matrix classes. Defines JBLAS::MatrixClassMixin.
+
+# Copyright (c) 2009-2010, Mikio L. Braun and contributors
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#     * Redistributions of source code must retain the above copyright
+#       notice, this list of conditions and the following disclaimer.
+#
+#     * Redistributions in binary form must reproduce the above
+#       copyright notice, this list of conditions and the following
+#       disclaimer in the documentation and/or other materials provided
+#       with the distribution.
+#
+#     * Neither the name of the Technische Universität Berlin nor the
+#       names of its contributors may be used to endorse or promote
+#       products derived from this software without specific prior
+#       written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+module JBLAS
+  # Mixin for the Matrix classes. These basically add the [] construction
+  # method (such that you can say DoubleMatrix[1,2,3]
+  module MatrixClassMixin
+    # Create a new matrix. For example, you can say DoubleMatrix[1,2,3].
+    # 
+    # See also from_array.
+    def [](*data)
+      from_array data
+    end
+
+    # Create a new matrix. There are two ways to use this function
+    #
+    # <b>pass an array</b>::
+    #   Constructs a column vector. For example: DoubleMatrix.from_array 1, 2, 3
+    # <b>pass an array of arrays</b>::
+    #   Constructs a matrix, inner arrays are rows. For
+    #   example: DoubleMatrix.from_array [[1,2,3],[4,5,6]]
+    #
+    # See also [], JBLAS#mat
+    def from_array(data)
+      n = data.length
+      if data.reject{|l| Numeric === l}.size == 0
+        a = self.new(n, 1)
+        (0...data.length).each do |i|
+          a[i, 0] = data[i]
+        end
+        return a
+      else
+        begin
+          lengths = data.collect{|v| v.length}
+        rescue
+          raise "All columns must be arrays"
+        end
+        raise "All columns must have equal length!" if lengths.min < lengths.max
+        a = self.new(n, lengths.max)
+        for i in 0...n
+          for j in 0...lengths.max
+            a[i,j] = data[i][j]
+          end
+        end
+        return a
+      end
+    end
+  end
+end

data/lib/jblas/mixin_complex_matrix.rb

@@ -0,0 +1,64 @@
+# Some extra methods added to complex matrices. Defines JBLAS::ComplexMatrixMixin.
+
+# Copyright (c) 2009-2010, Mikio L. Braun and contributors
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#     * Redistributions of source code must retain the above copyright
+#       notice, this list of conditions and the following disclaimer.
+#
+#     * Redistributions in binary form must reproduce the above
+#       copyright notice, this list of conditions and the following
+#       disclaimer in the documentation and/or other materials provided
+#       with the distribution.
+#
+#     * Neither the name of the Technische Universität Berlin nor the
+#       names of its contributors may be used to endorse or promote
+#       products derived from this software without specific prior
+#       written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+module JBLAS
+  # Mixin defining some extra methods for complex matrices.
+  #
+  # Collected in MatrixMixin.
+  module ComplexMatrixMixin
+    # Compute the hermitian transpose (transpose and complex conjugate). See hermitian.
+    def h; hermitian; end
+
+    # Compute the hermitian transpose (transpoe and complex conjugate).
+    def hermitian; JAVA_METHOD; end if false
+
+    # Compute complex conjugate.
+    def conj; JAVA_METHOD; end if false
+
+    # Compute complex conjugate (in-place).
+    def conj!; JAVA_METHOD; end if false
+
+    # Compute complex conjugate scalar product (self.h * other).
+    def dotu(other); JAVA_METHOD; end if false
+
+    # Compute transposed scalar product (self.t * other).
+    def dotc; JAVA_METHOD; end if false
+
+    # Get only the real part.
+    def real; JAVA_METHOD; end if false
+
+    # Get only the imaginary part.
+    def imag; JAVA_METHOD; end if false
+  end
+end

data/lib/jblas/mixin_convert.rb

@@ -0,0 +1,104 @@
+# Methods added to the Java classes are encoded as mixins in this file.
+
+# Copyright (c) 2009-2010, Mikio L. Braun and contributors
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#     * Redistributions of source code must retain the above copyright
+#       notice, this list of conditions and the following disclaimer.
+#
+#     * Redistributions in binary form must reproduce the above
+#       copyright notice, this list of conditions and the following
+#       disclaimer in the documentation and/or other materials provided
+#       with the distribution.
+#
+#     * Neither the name of the Technische Universität Berlin nor the
+#       names of its contributors may be used to endorse or promote
+#       products derived from this software without specific prior
+#       written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+module JBLAS
+  # Mixin for conversion options.
+  #
+  # Collected in MatrixMixin.
+  module MatrixConvertMixin
+    # Convert this matrix to a string.
+    #
+    # This methods takes a few extra arguments to control how the result looks
+    # like.
+    #
+    # +fmt+ is a format as used by sprintf, +coljoin+ is the string used to
+    # join column, +rowjoin+ is what is used to join rows. For example,
+    #
+    #    x.to_s('%.1f', ' ', "\n")
+    #
+    # Returns a matrix where columns are separated by spaces, rows by newlines
+    # and each element is shown with one digit after the comma.
+    def to_s(fmt=nil, coljoin=', ', rowjoin='; ')
+      if fmt
+        x = rows_to_a
+        '[' + x.map do |r|
+          if Enumerable === r
+            r.map {|e| sprintf(fmt, e)}.join(coljoin)
+          else
+            sprintf(fmt, r)
+          end
+        end.join(rowjoin) + ']'
+      else
+        toString
+      end
+    end
+
+    # Return an a representation of this object.
+    def inspect
+      s = "<#{self.class} of size #{rows} #{columns}: #{to_s}>"
+    end
+
+    def rows_to_a
+      (0...rows).map do |i|
+        row(i).to_a
+      end
+    end
+
+    def columns_to_a
+      (0...columns).map do |j|
+        column(j).to_a
+      end
+    end
+    
+    # Convert the matrix to an array.
+    #
+    # If the matrix
+    def to_ary
+      to_a
+    end
+
+    # Return the matrix as an Enumerable (just returns self).
+    def to_a #:nodoc:
+      data.to_a
+    end
+
+    def to_mat #:nodoc:
+      self
+    end
+
+    def to_matrix
+      self
+    end
+  end
+end

data/lib/jblas/mixin_enum.rb

@@ -0,0 +1,83 @@
+# Mixin for making matrices behave like enumerables. Defines JBLAS::MatrixEnumMixin.
+
+# Copyright (c) 2009-2010, Mikio L. Braun and contributors
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#     * Redistributions of source code must retain the above copyright
+#       notice, this list of conditions and the following disclaimer.
+#
+#     * Redistributions in binary form must reproduce the above
+#       copyright notice, this list of conditions and the following
+#       disclaimer in the documentation and/or other materials provided
+#       with the distribution.
+#
+#     * Neither the name of the Technische Universität Berlin nor the
+#       names of its contributors may be used to endorse or promote
+#       products derived from this software without specific prior
+#       written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+module JBLAS
+  # Mixin for collecting enumerable operations.
+  #
+  # Collected in MatrixMixin.
+  module MatrixEnumMixin
+    include Enumerable
+    
+    # Iterate over rows. 
+    def each_row
+      (0...rows).each do |i|
+        yield row(i)
+      end
+    end
+
+    # Iterate over columns.
+    def each_column
+      (0...columns).each do |j|
+        yield column(j)
+      end
+    end
+
+    # Each iterates over each element, going down rows first.
+    def each
+      (0...length).each do |i|
+        yield get(i)
+      end
+    end
+
+    # Map each element.
+    #
+    # Returns a new matrix of the same type. This means that the block
+    # must return something which can again be stored in the matrix.
+    def map(&block)
+      return dup.map!(&block)
+    end
+
+    # Map each element and store the result in the matrix.
+    #
+    # Note that the result must be again something
+    # which can be stored in the matrix. Otherwise you should do an
+    # to_a first.
+    def map!(&block)
+      (0...length).each do |i|
+        put(i, block.call(get(i)))
+      end
+      self
+    end
+  end
+end

data/lib/jblas/mixin_general.rb

@@ -0,0 +1,202 @@
+# General matrix operations. Defines the JBLAS::MatrixGeneralMixin.
+
+# Copyright (c) 2009-2010, Mikio L. Braun and contributors
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#     * Redistributions of source code must retain the above copyright
+#       notice, this list of conditions and the following disclaimer.
+#
+#     * Redistributions in binary form must reproduce the above
+#       copyright notice, this list of conditions and the following
+#       disclaimer in the documentation and/or other materials provided
+#       with the distribution.
+#
+#     * Neither the name of the Technische Universität Berlin nor the
+#       names of its contributors may be used to endorse or promote
+#       products derived from this software without specific prior
+#       written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+require 'jblas/proxies'
+
+module JBLAS
+  # Mixin for general operations not fitting in any other category.
+  #
+  # Collected in MatrixMixin.
+  module MatrixGeneralMixin
+    # Transpose the matrix. You obtain a transposed view of the matrix.
+    # Some operations are not possible on such views, for example
+    # most in-place operations. For such, do a +compact+ first.
+    def t; transpose; end
+
+    if false
+      # Transpose the matrix. See t.
+      def transpose
+        JAVA_METHOD
+      end
+    end
+
+    # Get the size of the matrix as <tt>[rows, columns]</tt>
+    def dims
+      [rows, columns]
+    end
+
+    # Get the total number of elements. Synonymous to length.
+    def size
+      length
+    end
+
+
+    # Check whether the column index +i+ is valid.
+    def check_column_index(i)
+      unless 0 <= i and i < columns
+        raise IndexError, "column index out of bounds"
+      end
+    end
+
+    # Check whether the row index +i+ is valid.
+    def check_row_index(i)
+      unless 0 <= i and i < rows
+        raise IndexError, "column index out of bounds"
+      end
+    end
+
+    # Returns true if the matrix is square and symmetric.
+    def symmetric?
+      square? and self.sub(self.t).normmax < 1e-6
+    end
+
+    # Compute the inverse of self.
+    def inv
+      unless square?
+        raise ArgumentError, 'Inverses can only be computed from square ' +
+          'matrices. Use solve instead!'
+      end
+      self.solve(self.class.eye(rows))
+    end
+
+    # Solve the linear equation self * x = b.
+    def solve(b)
+      if symmetric?
+        Solve.solve_symmetric(self, b)
+      else
+        Solve.solve(self, b)
+      end
+    end
+
+    # Return a new matrix which consists of the _self_ and _y_ side by
+    # side.  In general the hcat method should be used sparingly as it
+    # creates a new matrix and copies everything on each use. You
+    # should always ask yourself if an array of vectors or matrices
+    # doesn't serve you better. That said, you _can_ do funny things
+    # with +inject+. For example,
+    #
+    #   a = mat[1,2,3]
+    #   [a, 2*a, 3*a].inject {|s,x| s = s.hcat(x)}
+    #   => 1.0  2.0  3.0
+    #      2.0  4.0  6.0
+    #      3.0  6.0  9.0
+    def hcat(y)
+      unless self.dims[0] == y.dims[0]
+        raise ArgumentError, "Matrices must have same number of rows"
+      end
+      DoubleMatrix.concat_horizontally(self, y)
+    end
+
+    # Return a new matrix which consists of the _self_ on top of _y_.
+    # In general the hcat methods should be used sparingly. You
+    # should always ask yourself if an array of vectors or matrices
+    # doesn't serve you better. See also hcat.
+    def vcat(y)
+      unless self.dims[1] == y.dims[1]
+        raise ArgumentError, "Matrices must have same number of columns"
+      end
+      DoubleMatrix.concat_vertically(self, y)
+    end
+
+    # Returns a proxy of the matrix for which '*' is defined as elementwise.
+    #
+    # That is:
+    # * a * b => matrix multiplication
+    # * a.e * b => element wise multiplication
+    #
+    # For extra coolness, try writing it as "a .e* b", such that it looks
+    # more like the ".e" belongs to the operator, not the object. (Not sure
+    # whether this is really worth it, though ;) )
+    def e
+      JBLAS::MatrixElementWiseProxy.new(self)
+    end
+
+    # Returns a proxy for the matrix for which '*' is defined as the scalar
+    # product. See also +e+
+    #
+    # * a * b => matrix multiplication (a.mmul(b))
+    # * a .d* b => scalar product (a.dot(b))
+    def d
+      MatrixDotProxy.new(self)
+    end
+
+    if false
+      # Returns true if self is a vector
+      def vector?; JAVA_METHOD; end
+
+      # Returns true if self is a row vector.
+      def row_vector?; JAVA_METHOD; end
+
+      # Returns true if self is a column vector.
+      def column_vector?; JAVA_METHOD; end
+
+      # Returns true if self is a scalar.
+      def scalar?; JAVA_METHOD; end
+
+      # Returns the first entry of self.
+      def scalar; JAVA_METHOD; end
+    end
+
+    # Return a vector as row vector.
+    def as_row
+      unless vector?
+        self
+      else
+        row_vector? ? self : self.t
+      end
+    end
+
+    # Return a column vector.
+    def as_column
+      unless vector?
+        self
+      else
+        column_vector? ? self : self.t
+      end
+    end
+
+    # Save as ascii (tab-separated list, every row is a line)
+    def save_ascii(fn)
+      o = open(fn, 'w')
+      rows.times do |i|
+        columns.times do |j|
+          o.print get(i,j)
+          o.print "\t" if j < columns - 1
+        end
+        o.puts
+      end
+      o.close
+    end
+  end
+end