nsphere 0.1.0 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1d92024f76898a3e73d06ddcd095735d40bbc3f8
+  data.tar.gz: cfb5fa03364c9c89c3901605b3761a3368b57e16
+SHA512:
+  metadata.gz: 9ead903c0cfe27d7d5115e4686a9eda710ac78fd73370e7665bf27b3dffb96c0a5925c051363207d52a74326483f1f1f1d9340d75c34ab3aab7d9512e002f924
+  data.tar.gz: ba084b8222f84c80dc25eb0150a2ea1abb7484f11e6d65ba972b204f08422bcef8e5c950d4228d7c7064cb6eb8b9f13e34f957880b56cd3a5b505e83a5f8c881

data/lib/nsphere.rb

@@ -1,7 +1,28 @@
 # encoding: utf-8
 
+# The program define the NSphere in any dimensional
+# space, and offer the +, -, *, / operator for vector
+# operation in the space.
+#
+# Author::      m00nlight (mailto:dot_wangyushi@yeah.net)
+# Copyright::   Copyright(c) 2014 m00nlight
+# License::     Distributed under the MIT-License
+
+
 class NSphere
-  attr_reader :radius, :thetas, :coordinates
+  attr_reader :radius, :thetas, :coordinates, :dim
+
+  # A implementation of the n-sphere in any dimensional space
+  # In two dimensional, it is a circle to origin point(0, 0), in
+  # three dimensional space, it is a sphere to origin(0, 0, 0).
+  #
+  # === Attributes
+  #
+  # * +radius+          - Radius of the object
+  # * +thetas+          - angles value in radians
+  # * +coordinates+     - coordinates of the object
+  # * +dim+             - dimension of the space
+
 
   def initialize(args)
     if not (args[:radius].nil? or args[:thetas].nil?)
@@ -19,6 +40,8 @@ class NSphere
     end
   end
 
+  # Check argument of radius and thetas, the last theta must in range [0, 2PI],
+  # while the rest thetas values must be in the range of [0, PI]
   def check_argument(radius, thetas)
     radius >= 0.0 and thetas[0..-2].all? { |x| x >= 0 and x <= Math::PI} and
       thetas[-1] >= 0 and thetas[-1] <= 2 * Math::PI
@@ -27,9 +50,9 @@ class NSphere
   def build_by_radius_thetas(radius, thetas)
     @radius = radius
     @thetas = thetas
-    dim = @thetas.size + 1
-    @coordinates = [0.0] * dim
-    (0..(dim - 2)).to_a.each do |idx|
+    @dim = @thetas.size + 1
+    @coordinates = [0.0] * @dim
+    (0..(@dim - 2)).to_a.each do |idx|
       tmp = @radius
       (0..(idx - 1)).to_a { |j| tmp = tmp * Math.sin(@thetas[j])}
       @coordinates[idx] = tmp * Math.cos(@thetas[idx])
@@ -39,20 +62,34 @@ class NSphere
 
   def build_by_coordinate(coordinates)
     @coordinates = coordinates
-    dim = @coordinates.size
+    @dim = @coordinates.size
     coord_square = coordinates.map { |x| x ** 2}
     @radius = Math.sqrt(coord_square.inject(:+))
-    sum = [0] * (dim + 1)
+    sum = [0] * (@dim + 1)
     coord_square.each_with_index do |elem, idx|
       sum[idx + 1] = sum[idx] + elem
     end
-    @thetas = [0.0] * (dim - 1)
-    @thetas[dim - 2] = Math.atan2(coordinates[dim - 1], coordinates[dim - 2])
-    (0..(dim - 3)).to_a.reverse.each do |idx|
-      @thetas[idx] = atan((sum[dim - 1] - sum[idx]) , coordinates[idx])
+    @thetas = [0.0] * (@dim - 1)
+    @thetas[@dim - 2] = normalize_angle(Math.atan2(coordinates[@dim - 1],
+                                                   coordinates[@dim - 2]),
+                                        2 * Math::PI)
+    (0..(@dim - 3)).to_a.reverse.each do |idx|
+      @thetas[idx] = normalize_angle(atan((sum[@dim - 1] - sum[idx]) ,
+                                          coordinates[idx]),
+                                     Math::PI)
     end
   end
 
+  # atan wrapper for the Math.atan method to avoid produce 0 / 0 as NaN
+  #
+  # ==== Attributes
+  #
+  # * +y+       - denominator of the atan function
+  # * +x+       - numerator of the atan function
+  #
+  # ==== Example
+  #   atan(0, 0) => 0.0
+  #   atan(3, 4) => 0.6435011087932844
   def atan(y, x)
     if x.abs <= 10e-6 && y.abs <= 10e-6
       return 0.0
@@ -61,38 +98,70 @@ class NSphere
     end
   end
 
+
+  # normalize an angle value to [0..range]
+  def normalize_angle(angle, range)
+    (angle + range) % range
+  end
+
+  # negate the object
   def negate
-    NSphere.new(radius: -self.radius,
-                thetas: self.thetas.map { |x| -x})
+    NSphere.new(coord: @coordinates.map { |x| -x})
   end
 
+  # help function for doing vector multiplication and division
+  def add_angles(thetas1, thetas2)
+
+    res = []
+    res = thetas1[0..-2].zip(thetas2[0..-2]) { |x|
+      (x.inject(:+) + Math::PI) % Math::PI
+    } || res
+
+    res << ((thetas1[-1] + thetas2[-1] + 2 * Math::PI) % (2 * Math::PI))
+    res
+  end
+
+  # add operator for two vectors
   def +(a)
+    raise "Dimension not match" if @dim != a.dim
     tmp = self.coordinates.zip(a.coordinates).map { |x|
       x.inject(:+)
     }
     NSphere.new(coord: tmp)
   end
 
+  # minus operator for two vectors
   def -(a)
+    raise "Dimension not match" if @dim != a.dim
     self + a.negate
   end
 
+  # multiply operator for two vectors
   def *(a)
-    tmp = self.coordinates.zip(a.coordinates).map { |x|
-      x.inject(:+)
-    }
+    tmp = add_angles(@thetas, a.thetas)
     NSphere.new(radius: self.radius * a.radius,
                 thetas: tmp)
   end
 
+  # divide operator for two vectors
   def /(a)
-    tmp = self.coordinates.zip(a.coordinates).map { |x|
-      x[0] - x[1]
-    }
-    NSphere.new(radius: self.radius / a.radius,
+    tmp = add_angles(@thetas, a.thetas.map { |x| -x})
+
+    p @thetas
+    p a.thetas.map { |x| -x}
+    p tmp
+    NSphere.new(radius: @radius / a.radius,
                 thetas: tmp)
   end
 
+  # Class method, generate a random vector in any dimensional space
+  #
+  # ==== Attributes
+  #
+  # * +dim+     - dimension of the generate vector
+  # * +radius+  - radius with default value set to 1.0
+  #
+  # An random NSphere object is returned as result.
   def self.random_vector(dim, radius = 1.0)
     thetas = [0.0] * (dim - 1)
     thetas[-1] = Random.rand(0..(2 * Math::PI))
@@ -102,4 +171,9 @@ class NSphere
     NSphere.new(radius: radius,
                 thetas: thetas)
   end
+
+  # override to string method of NSphere object
+  def to_s
+    "radius: #{radius}, thetas: #{thetas}, coordinates: #{coordinates}"
+  end
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nsphere
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - m00nlight
@@ -21,26 +20,25 @@ files:
 homepage: https://github.com/m00nlight/nsphere
 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: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: NSphere
 test_files: []