nmatrix_extras 0.0.4.1 → 0.0.4.2

data/lib/nmatrix_extras.rb

@@ -24,6 +24,5 @@ require "nmatrix_extras/version"
 require "nmatrix_extras/nmatrix"
 
 class NMatrix
-	include Enumerable
 	include NMatrixExtras
 end

data/lib/nmatrix_extras/nmatrix.rb

@@ -24,132 +24,175 @@ require 'nmatrix'
 
 module NMatrixExtras
 
-	##
-	# Successively yields submatrices at each coordinate along a specified dimension.  Each submatrix will have the same number of dimensions as the matrix being iterated,
-	# but with the specified dimension's size equal to 1.
-	#
-	# @param [Integer] dim the dimension being iterated over.
-	#
-	def each_along_dim(dim=0) 
-		dims = shape
-		shape.each_index { |i| dims[i] = 0...(shape[i]) unless i == dim }
-		0.upto(shape[dim]-1) do |i|
-			dims[dim] = i
-			yield self[*dims]
-		end
-	end
-
-	##
-	# Reduces an NMatrix using a supplied block over a specified dimension.  The block should behave the same way as for Enumerable#reduce.
-	#
-	# @param [Integer] dim the dimension being reduced
-	# @param [Numeric] initial the initial value for the reduction (i.e. the usual parameter to Enumerable#reduce).  Note that unlike Enumerable#reduce, if not specified, this will default to 0.0.
-	#
-	# @return [NMatrix] an NMatrix with the same number of dimensions as the input, but with the input dimension now having size 1.  
-	#    Each element is the result of the reduction at that position along the specified dimension.
-	#
-	def reduce_along_dim(dim=0, initial=0.0, &bl)
-
-		if dim > shape.size then
-			raise ArgumentError, "Requested dimension does not exist.  Requested: #{dim}, shape: #{shape}"
-		end
-
-		new_shape = shape
-		new_shape[dim] = 1
-
-		acc = NMatrix.new(new_shape, initial)
-
-		each_along_dim(dim) do |sub_mat|
-			acc = bl.call(acc, sub_mat)
-		end
-
-		acc
-
-	end
-
-	##
-	# Calculates the mean along the specified dimension.
-	#
-	# @see #reduce_along_dim
-	#
-	def mean(dim=0)
-		reduce_along_dim(dim, 0.0) do |mean, sub_mat|
-			mean + sub_mat/shape[dim]
-		end
-	end
-
-	##
-	# Calculates the minimum along the specified dimension.
-	#
-	# @see #reduce_along_dim
-	#
-	def min(dim=0)
-		reduce_along_dim(dim, Float::MAX) do |min, sub_mat|
-			min * (min <= sub_mat) + ((min)*0.0 + (min > sub_mat)) * sub_mat
-		end
-	end
-
-	##
-	# Calculates the maximum along the specified dimension.
-	#
-	# @see #reduce_along_dim
-	#
-	def max(dim=0)
-		reduce_along_dim(dim, -1.0*Float::MAX) do |max, sub_mat|
-			max * (max >= sub_mat) + ((max)*0.0 + (max < sub_mat)) * sub_mat
-		end
-	end
-
-	##
-	# Calculates the median along the specified dimension.
-	#
-	# Not yet implemented.
-	#
-	# @see #reduce_along_dim
-	#
-	def median(dim=0)
-		raise NotImplementedError, "median not yet implemented"
-	end
-
-	##
-	# Calculates the sample variance along the specified dimension.
-	#
-	# @see #reduce_along_dim
-	#
-	def variance(dim=0)
-		m = mean(dim)
-		reduce_along_dim(dim, 0.0) do |var, sub_mat|
-			var + (m - sub_mat)*(m - sub_mat)/(shape[dim]-1)
-		end
-	end
-
-	##
-	# Converts an nmatrix with a single element (but any number of dimensions) to a float.
-	#
-	# Raises an IndexError if the matrix does not have just a single element.
-	#
-	def to_f
-		raise IndexError, 'to_f only valid for matrices with a single element' unless shape.all? { |e| e == 1 }
-		self[*Array.new(shape.size, 0)]
-	end
-
-	##
-	# See Enumerable#map
-	#
-	def map(&bl)
-		cp = self.dup
-		cp.map! &bl
-		cp
-	end
-
-	##
-	# Maps in place.
-	# See #map
-	#
-	def map!
-		self.each_stored_with_indices do |e, *i|
-			self[*i] = (yield e)
-		end
-	end
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  ##
+  # Successively yields submatrices at each coordinate along a specified dimension.  Each submatrix will have the same number of dimensions as the matrix being iterated,
+  # but with the specified dimension's size equal to 1.
+  #
+  # @param [Integer] dim the dimension being iterated over.
+  #
+  def each_along_dim(dim=0) 
+    dims = shape
+    shape.each_index { |i| dims[i] = 0...(shape[i]) unless i == dim }
+    0.upto(shape[dim]-1) do |i|
+      dims[dim] = i
+      yield self[*dims]
+    end
+  end
+
+  ##
+  # Reduces an NMatrix using a supplied block over a specified dimension.  The block should behave the same way as for Enumerable#reduce.
+  #
+  # @param [Integer] dim the dimension being reduced
+  # @param [Numeric] initial the initial value for the reduction (i.e. the usual parameter to Enumerable#reduce).  Supply nil or do not supply
+  #  this argument to have it follow the usual Enumerable#reduce behavior of using the first element as the initial value.
+  # @return [NMatrix] an NMatrix with the same number of dimensions as the input, but with the input dimension now having size 1.  
+  #    Each element is the result of the reduction at that position along the specified dimension.
+  #
+  def reduce_along_dim(dim=0, initial=nil, &bl)
+
+    if dim > shape.size then
+      raise ArgumentError, "Requested dimension does not exist.  Requested: #{dim}, shape: #{shape}"
+    end
+
+    new_shape = shape
+    new_shape[dim] = 1
+
+    first_as_acc = false
+
+    if initial then
+      acc = NMatrix.new(new_shape, initial)
+    else
+      each_along_dim(dim) do |sub_mat|
+        acc = sub_mat
+        break
+      end
+      first_as_acc = true
+    end
+
+    each_along_dim(dim) do |sub_mat|
+      if first_as_acc then
+        first_as_acc = false
+        next
+      end
+      acc = bl.call(acc, sub_mat)
+    end
+
+    acc
+
+  end
+
+  alias_method :inject_along_dim, :reduce_along_dim
+
+  ##
+  # Calculates the mean along the specified dimension.
+  #
+  # @see #reduce_along_dim
+  #
+  def mean(dim=0)
+    reduce_along_dim(dim, 0.0) do |mean, sub_mat|
+      mean + sub_mat/shape[dim]
+    end
+  end
+
+  ##
+  # Calculates the sum along the specified dimension.
+  #
+  # @see #reduce_along_dim
+  def sum(dim=0)
+    reduce_along_dim(dim, 0.0) do |sum, sub_mat|
+      sum + sub_mat
+    end
+  end
+
+
+  ##
+  # Calculates the minimum along the specified dimension.
+  #
+  # @see #reduce_along_dim
+  #
+  def min(dim=0)
+    reduce_along_dim(dim, Float::MAX) do |min, sub_mat|
+      min * (min <= sub_mat) + ((min)*0.0 + (min > sub_mat)) * sub_mat
+    end
+  end
+
+  ##
+  # Calculates the maximum along the specified dimension.
+  #
+  # @see #reduce_along_dim
+  #
+  def max(dim=0)
+    reduce_along_dim(dim, -1.0*Float::MAX) do |max, sub_mat|
+      max * (max >= sub_mat) + ((max)*0.0 + (max < sub_mat)) * sub_mat
+    end
+  end
+
+
+  ##
+  # Calculates the sample variance along the specified dimension.
+  #
+  # @see #reduce_along_dim
+  #
+  def variance(dim=0)
+    m = mean(dim)
+    reduce_along_dim(dim, 0.0) do |var, sub_mat|
+      var + (m - sub_mat)*(m - sub_mat)/(shape[dim]-1)
+    end
+  end
+
+  ##
+  # Calculates the sample standard deviation along the specified dimension.
+  #
+  # @see #reduce_along_dim
+  #
+  def std(dim=0)
+    variance(dim).map! { |e| Math.sqrt(e) }
+  end
+
+  ##
+  # Converts an nmatrix with a single element (but any number of dimensions) to a float.
+  #
+  # Raises an IndexError if the matrix does not have just a single element.
+  #
+  def to_f
+    raise IndexError, 'to_f only valid for matrices with a single element' unless shape.all? { |e| e == 1 }
+    self[*Array.new(shape.size, 0)]
+  end
+
+  ##
+  # See Enumerable#map
+  #
+  def map(&bl)
+    cp = self.dup
+    cp.map! &bl
+    cp
+  end
+
+  ##
+  # Maps in place.
+  # See #map
+  #
+  def map!
+    self.each_stored_with_indices do |e, *i|
+      self[*i] = (yield e)
+    end
+    self
+  end
+
+  module ClassMethods
+
+    def ones_like(nm)
+      NMatrix.ones(nm.shape, nm.dtype)
+    end
+
+    def zeros_like(nm)
+      NMatrix.zeros(nm.stype, nm.shape, nm.dtype)
+    end
+
+  end
 
 end

data/lib/nmatrix_extras/version.rb

@@ -1,3 +1,3 @@
 module NmatrixExtras
-  VERSION = "0.0.4.1"
+  VERSION = "0.0.4.2"
 end

data/spec/nmatrix_extras_spec.rb

@@ -25,95 +25,88 @@ require 'nmatrix_extras'
 
 describe NMatrix do
 
-	before :each do
-		@nm_1d = N[5.0,0.0,1.0,2.0,3.0]
-		@nm_2d = N[[0.0,1.0],[2.0,3.0]]
-	end
-
-	context "_like constructors" do
-
-		it "should create an nmatrix of ones with dimensions and type the same as its argument" do
-			pending
-		end
-
-		it "should create an nmatrix of zeros with dimensions and type the same as its argument" do 
-			pending
-		end
-
-	end
-
-	it "should calculate the mean along the specified dimension" do
-		@nm_1d.mean.should eq N[2.2]
-		@nm_2d.mean.should eq N[[1.0,2.0]]
-	end
-
-	it "should calculate the minimum along the specified dimension" do 
-		@nm_1d.min.should eq N[0.0]
-		@nm_2d.min.should eq N[[0.0, 1.0]]
-		@nm_2d.min(1).should eq N[[0.0], [2.0]]
-
-	end
-
-	it "should calculate the maximum along the specified dimension" do
-		@nm_1d.max.should eq N[5.0]
-		@nm_2d.max.should eq N[[2.0, 3.0]]
-	end
-
-	it "should calculate the median along the specified dimension" do
-		@nm_1d.median.should eq N[2.0]
-		@nm_2d.median(1).should eq N[[0.5], [2.5]]
-	end
-
-	it "should calculate the variance along the specified dimension" do
-		@nm_1d.variance.should eq N[3.7]
-		@nm_2d.variance(1).should eq N[[0.5], [0.5]]
-	end
-
-	it "should calculate the sum along the specified dimension" do
-		pending
-	end
-
-	it "should calculate the standard deviation along the specified dimension" do
-		pending 
-	end
-
-	it "should calculate the correlation coefficient with another same-sized nmatrix" do
-		pending
-	end
-
-	it "should calculate the covariance with another same-sized nmatrix" do 
-		pending
-	end
-
-	it "should raise an ArgumentError when any invalid dimension is provided" do 
-		pending
-	end
-
-	it "should convert to float if it contains only a single element" do 
-		N[4.0].to_f.should eq 4.0
-		N[[[[4.0]]]].to_f.should eq 4.0
-	end
-
-	it "should raise an index error if it contains more than a single element" do
-		expect { @nm_1d.to_f }.to raise_error(IndexError)
-	end
-
-	it "should map a block to all elements" do 
-		@nm_1d.map { |e| e ** 2 }.should eq N[25.0,0.0,1.0,4.0,9.0]
-		@nm_2d.map { |e| e ** 2 }.should eq N[[0.0,1.0],[4.0,9.0]]
-	end
-
-	it "should map! a block to all elements in place" do
-		fct = Proc.new { |e| e ** 2 }
-		expected1 = @nm_1d.map &fct
-		expected2 = @nm_2d.map &fct
-		@nm_1d.map! &fct
-		@nm_1d.should eq expected1
-		@nm_2d.map! &fct
-		@nm_2d.should eq expected2
-	end
-
-
+  before :each do
+    @nm_1d = N[5.0,0.0,1.0,2.0,3.0]
+    @nm_2d = N[[0.0,1.0],[2.0,3.0]]
+  end
+
+  context "_like constructors" do
+
+    it "should create an nmatrix of ones with dimensions and type the same as its argument" do
+      NMatrix.ones_like(@nm_1d).should eq N[1.0, 1.0, 1.0, 1.0, 1.0]
+      NMatrix.ones_like(@nm_2d).should eq N[[1.0, 1.0], [1.0, 1.0]]
+    end
+
+    it "should create an nmatrix of zeros with dimensions and type the same as its argument" do 
+      NMatrix.zeros_like(@nm_1d).should eq N[0.0, 0.0, 0.0, 0.0, 0.0]
+      NMatrix.zeros_like(@nm_2d).should eq N[[0.0, 0.0], [0.0, 0.0]]
+    end
+
+  end
+
+  it "behaves like Enumerable#reduce with no argument to reduce" do
+    @nm_1d.reduce_along_dim(0) { |acc, el| acc + el }.to_f.should eq 11
+    @nm_2d.reduce_along_dim(1) { |acc, el| acc + el }.should eq N[[1, 5]]
+  end
+
+  it "should calculate the mean along the specified dimension" do
+    @nm_1d.mean.should eq N[2.2]
+    @nm_2d.mean.should eq N[[1.0,2.0]]
+  end
+
+  it "should calculate the minimum along the specified dimension" do 
+    @nm_1d.min.should eq N[0.0]
+    @nm_2d.min.should eq N[[0.0, 1.0]]
+    @nm_2d.min(1).should eq N[[0.0], [2.0]]
+  end
+
+  it "should calculate the maximum along the specified dimension" do
+    @nm_1d.max.should eq N[5.0]
+    @nm_2d.max.should eq N[[2.0, 3.0]]
+  end
+
+  it "should calculate the variance along the specified dimension" do
+    @nm_1d.variance.should eq N[3.7]
+    @nm_2d.variance(1).should eq N[[0.5], [0.5]]
+  end
+
+  it "should calculate the sum along the specified dimension" do
+    @nm_1d.sum.should eq N[11]
+    @nm_2d.sum.should eq N[[2], [4]]
+  end
+
+  it "should calculate the standard deviation along the specified dimension" do
+    @nm_1d.std.should eq N[Math.sqrt(3.7)]
+    @nm_2d.std(1).should eq N[[Math.sqrt(0.5)], [Math.sqrt(0.5)]]
+  end
+
+  it "should raise an ArgumentError when any invalid dimension is provided" do 
+    expect { @nm_1d.mean(3) }.to raise_exception(ArgumentError)
+  end
+
+  it "should convert to float if it contains only a single element" do 
+    N[4.0].to_f.should eq 4.0
+    N[[[[4.0]]]].to_f.should eq 4.0
+  end
+
+  it "should raise an index error if it contains more than a single element" do
+    expect { @nm_1d.to_f }.to raise_error(IndexError)
+  end
+
+  it "should map a block to all elements" do 
+    @nm_1d.map { |e| e ** 2 }.should eq N[25.0,0.0,1.0,4.0,9.0]
+    @nm_2d.map { |e| e ** 2 }.should eq N[[0.0,1.0],[4.0,9.0]]
+  end
+
+  it "should map! a block to all elements in place" do
+    fct = Proc.new { |e| e ** 2 }
+    expected1 = @nm_1d.map &fct
+    expected2 = @nm_2d.map &fct
+    @nm_1d.map! &fct
+    @nm_1d.should eq expected1
+    @nm_2d.map! &fct
+    @nm_2d.should eq expected2
+  end
 
 end
 

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: nmatrix_extras
 version: !ruby/object:Gem::Version
-  version: 0.0.4.1
+  version: 0.0.4.2
+  prerelease: 
 platform: ruby
 authors:
 - Colin J. Fuller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-02 00:00:00.000000000 Z
+date: 2013-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -27,6 +30,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -41,6 +46,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -48,6 +54,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -55,6 +62,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: nmatrix
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,6 +70,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -87,26 +96,27 @@ files:
 homepage: ''
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Adds a number of basic functions present in numpy to nmatrix and adds mapping
   and reduction.
 test_files:

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YWQ1N2MxY2ExZTI5YTg0MzNmMTI5M2FmY2NmYjI4ZDRmZDZlMmVhYw==
-  data.tar.gz: !binary |-
-    MGQ2NjRiYmY4ZDg0YzE2YzFhYmIxMzU5Yzc4YWRjMjk3NGViZDg0Mg==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    NzIwMWY3MzRiMTUzMzdjNDQwMDkwMmIzZjEzNTQxMDU1NWU3ZTc1ZWYzODk4
-    ZTNiNTI5YzM4YWRlNDAyYWFjYTg3ZmVjN2QzODViM2YxNzkwY2RkNGQ0NWRl
-    ZGY5YTcyMDdkMDdhMWZmMTY0YTk5MGIwZjVjMDA3ODRlMTU0ZmM=
-  data.tar.gz: !binary |-
-    MjZkZmYzYTczYTI5YjdlNmYwYTU1ODE4ZTMwZTkwZDg2MzNiOTdkNGUxYzQx
-    YzljZDI1MjRmZjZkODE0NmMyZTM5M2ZjNTkxZmFmNGU0MzMxYzhiYWU1MzMy
-    OWFkZjYyMDAwMGE4NWM2OGFjYjZjZjZmYmUzMmZkMjFlZDQ0NTg=