nmatrix_extras 0.0.4.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!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=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nmatrix_extras.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Colin J. Fuller
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# NmatrixExtras
+
+Convenience functions for NMatrix, including some like mean, min, max, present in numpy, as well as mapping and reduction functions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'nmatrix_extras'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nmatrix_extras
+
+## Usage
+
+    require 'nmatrix_extras'
+
+This will add the extra methods to the NMatrix class.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+##License
+
+Licensed under the MIT/X11 license.  See LICENSE.txt for the full license text.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => [:spec]
+

data/lib/nmatrix_extras.rb

@@ -0,0 +1,29 @@
+#--
+# Copyright (c) 2013 Colin J. Fuller
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the Software), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#++
+
+require "nmatrix_extras/version"
+require "nmatrix_extras/nmatrix"
+
+class NMatrix
+	include Enumerable
+	include NMatrixExtras
+end

data/lib/nmatrix_extras/nmatrix.rb

@@ -0,0 +1,155 @@
+#--
+# Copyright (c) 2013 Colin J. Fuller
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the Software), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#++
+
+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
+
+end

data/lib/nmatrix_extras/version.rb

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

data/nmatrix_extras.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nmatrix_extras/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nmatrix_extras"
+  spec.version       = NmatrixExtras::VERSION
+  spec.authors       = ["Colin J. Fuller"]
+  spec.email         = ["cjfuller@gmail.com"]
+  spec.description   = %q{Extra functions for nmatrix}
+  spec.summary       = %q{Adds a number of basic functions present in numpy to nmatrix and adds mapping and reduction.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_runtime_dependency "nmatrix", ">= 0.0.4"
+end

data/spec/nmatrix_extras_spec.rb

@@ -0,0 +1,120 @@
+#--
+# Copyright (c) 2013 Colin J. Fuller
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the Software), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#++
+
+require 'nmatrix'
+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
+
+
+
+end
+
+

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: nmatrix_extras
+version: !ruby/object:Gem::Version
+  version: 0.0.4.1
+platform: ruby
+authors:
+- Colin J. Fuller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nmatrix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+description: Extra functions for nmatrix
+email:
+- cjfuller@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/nmatrix_extras.rb
+- lib/nmatrix_extras/nmatrix.rb
+- lib/nmatrix_extras/version.rb
+- nmatrix_extras.gemspec
+- spec/nmatrix_extras_spec.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Adds a number of basic functions present in numpy to nmatrix and adds mapping
+  and reduction.
+test_files:
+- spec/nmatrix_extras_spec.rb