mageo 0.0.1 → 0.0.2

data/CHANGES

@@ -1,6 +1,12 @@
 = vasputils changelog
 
 == Master (for 0.0.2)
+  - Make a namespace 'Mageo'.
+  - Most of classes are included into the namespace 'Mageo'.
+  - Adjust to malge-0.0.8
+  - Move Tetrahedron to Mageo::Tetrahedron
+  - Set default value of tolerance=0.0 in argument of Polyhedron#include?
+  - Adjust to builtinextension-0.1.0.
 
 == Version (for 0.0.1)
   - Change indent style from tab char to two spaces.

data/Gemfile

@@ -6,11 +6,11 @@ source "http://rubygems.org"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "builtinextension", ">= 0"
-  gem "bundler", "~> 1.2.2"
+  gem "builtinextension", ">= 0.1.0"
+  gem "bundler", "~> 1.3.5"
   gem "jeweler", "~> 1.8.3"
-  gem "malge", ">= 0.0.2"
-  gem "psych", ">= 0"
+  gem "malge", ">= 0.0.8"
+  #gem "psych", ">= 0"
   gem "rdoc", "~> 3.12"
   gem "simplecov", ">= 0"
 end

data/Rakefile

@@ -17,8 +17,8 @@ Jeweler::Tasks.new do |gem|
   gem.name = "mageo"
   gem.homepage = "http://github.com/ippei94da/mageo"
   gem.license = "MIT"
-  gem.summary = %Q{MAth GEOmetry library to deal with 2 and 3 dimension space.}
-  gem.description = %Q{MAth GEOmetry library to deal with 2 and 3 dimension space.
+  gem.summary = %Q{MAth GEOmetry library to deal with 2 and 3 dimensional spaces.}
+  gem.description = %Q{MAth GEOmetry library to deal with 2 and 3 dimensional spaces.
     Cartesian and internal coordinate systems can be used.
     This includes besic objects in 3 dimensional space.
   }

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/mageo.rb

@@ -0,0 +1,20 @@
+module Mageo; end
+
+require "rubygems"
+#gem     "malge"
+require "malge"
+
+require "mageo/axes.rb"
+require "mageo/cylinder.rb"
+require "mageo/polar2d.rb"
+require "mageo/polar3d.rb"
+require "mageo/segment.rb"
+require "mageo/sphere.rb"
+require "mageo/triangle.rb"
+require "mageo/vector.rb"
+require "mageo/vector3d.rb"
+require "mageo/vector3dinternal.rb"
+
+require "mageo/polyhedron.rb"
+require "mageo/tetrahedron.rb"
+require "mageo/octahedron.rb"

data/lib/mageo/axes.rb

@@ -1,10 +1,8 @@
 #! /usr/bin/env ruby
 # coding: utf-8
 
-require "matrix"
-
 # n 次元空間における座標系を表現する n 本のベクトルを扱うクラス。
-class Axes
+class Mageo::Axes
   attr_reader :axes
 
   class InitializeError < Exception; end

data/lib/mageo/cylinder.rb

@@ -1,20 +1,18 @@
 #! /usr/bin/env ruby
 # coding: utf-8
 
-require "mageo/vector3d.rb"
-
 #
-# 球を表現するクラス。
+# Class for cylinder
 #
-class Cylinder
+class Mageo::Cylinder
   attr_reader :positions, :radius
 
   # 座標と半径
   # positions は 両底面の中心座標を入れた配列。
   def initialize(position, radius)
     @positions = [
-      Vector3D[*position[0]],
-      Vector3D[*position[1]]
+      Mageo::Vector3D[*position[0]],
+      Mageo::Vector3D[*position[1]]
     ]
     @radius = radius
   end

data/lib/mageo/octahedron.rb

@@ -1,14 +1,8 @@
 #! /usr/bin/env ruby
 # coding: utf-8
 
-require "mageo/vector3d.rb"
-require "mageo/triangle.rb"
-#require "mageo/tetrahedron.rb"
-require "mageo/polyhedron.rb"
-
-
 # 3次元空間中の八面体を表現するクラス
-class Octahedron < Polyhedron
+class Mageo::Octahedron < Mageo::Polyhedron
 
   class InitializeError < Exception; end
 
@@ -36,7 +30,7 @@ class Octahedron < Polyhedron
     end
 
     pairs.flatten.each do |vertex|
-      raise InitializeError if vertex.class == Vector3DInternal
+      raise InitializeError if vertex.class == Mageo::Vector3DInternal
     end
 
 

data/lib/mageo/polar2d.rb

@@ -1,13 +1,10 @@
 #! /usr/bin/env ruby
 # coding: utf-8
 
-require 'matrix'
-
-
 class Vector
   include Math
 
-  #Polar2D クラスインスタンスへの変換。
+  #Mageo::Polar2D クラスインスタンスへの変換。
   def to_p2d
     raise Vector::SizeError if self.size != 2
     x, y = *self
@@ -29,7 +26,7 @@ class Vector
       theta = Math::atan( y/x )
       theta += PI if ( x < 0) 
     end
-    Polar2D.new( r, theta ).minimize_theta
+    Mageo::Polar2D.new( r, theta ).minimize_theta
   end
 end
 
@@ -37,14 +34,14 @@ end
 #極座標ライブラリでは、角度は基本的に radian を使用する。
 #degree は人間の都合で決められた尺度だろう。
 #まあ人間用に degree 用インターフェイスも用意することもあるかもしれんが。
-class Polar2D
+class Mageo::Polar2D
 
   include Math
 
   ##クラスメソッド
 
   #与えられた角度 radian を 0 <= radian < 2*PI の間の角度に変換する破壊破壊的メソッド。
-  def Polar2D.minimum_radian( radian )
+  def self.minimum_radian( radian )
     tmp = ( radian / (2.0*PI) )
     tmp = tmp - tmp.floor
     (2.0*PI) * tmp
@@ -82,7 +79,7 @@ class Polar2D
 
   #theta を 0 <= theta < 2*PI の間の角度に変換する破壊破壊的メソッド。
   def minimize_theta!
-    @theta = Polar2D.minimum_radian( @theta )
+    @theta = self.class.minimum_radian( @theta )
   end
 
   #theta を 0 <= theta < 2*PI の間の角度に変換したオブジェクトを返す非破壊破壊的メソッド。

data/lib/mageo/polar3d.rb

@@ -1,14 +1,11 @@
 #! /usr/bin/env ruby
 # coding: utf-8
 
-require 'matrix'
-require 'mageo/vector3d.rb'
-
 #3次元極座標。
 #極座標ライブラリでは、角度は基本的に radian を使用する。
 #degree は人間の都合で決められた尺度だろう。
 #まあ人間用に degree 用インターフェイスも用意することもあるかもしれんが。
-class Polar3D
+class Mageo::Polar3D
 
   include Math
   
@@ -27,7 +24,7 @@ class Polar3D
     x = @r * sin( @theta ) * cos( @phi )
     y = @r * sin( @theta ) * sin( @phi )
     z = @r * cos( @theta )
-    Vector3D[ x, y, z ]
+    Mageo::Vector3D[ x, y, z ]
   end
 
   #phi を 0 <= phi < 2*PI の間の角度に変換する破壊破壊的メソッド。

data/lib/mageo/polyhedron.rb

@@ -2,24 +2,24 @@
 # coding: utf-8
 
 require "rubygems"
-gem "builtinextension"
-require "array_include_eql.rb"
+gem     "builtinextension"
+require "array/includeeql.rb"
 
 # 多面体を表現する抽象クラス。
 # 面は必ず三角形で、たとえば四角形も2つの三角形であると考える。
 # initialize メソッドは subclass で再定義する。
 # subclass の注意点。
 #   - 凸包であることを前提とする。
-#     チェック機構は Polyhedron クラスで持っているべきだが、面倒なので後回し。
+#     チェック機構は Mageo::Polyhedron クラスで持っているべきだが、面倒なので後回し。
 #     3次元凸包判定の方法をぐぐったが、これといったものが見つからない。
 #   - 定義された面同士の間に隙間がないことを前提とする。
-#     チェック機構は Polyhedron クラスで持っているべきだが、面倒なので後回し。
+#     チェック機構は Mageo::Polyhedron クラスで持っているべきだが、面倒なので後回し。
 #   - 頂点リスト @vertices と、面リスト @vertex_indices_of_triangles を持つ。
-#     ただし、@vertex_indices_of_triangles は Triangle クラスインスタンスではなく、
+#     ただし、@vertex_indices_of_triangles は Mageo::Triangle クラスインスタンスではなく、
 #     @vertices 内の index。
-#     see Tetrahedron.rb
-#   - メインのテストは 四面体 Tetrahedron クラスで行っている。
-class Polyhedron
+#     see Mageo::Tetrahedron.rb
+#   - メインのテストは 四面体 Mageo::Tetrahedron クラスで行っている。
+class Mageo::Polyhedron
   attr_reader :vertices
 
   class TypeError < Exception; end
@@ -42,14 +42,14 @@ class Polyhedron
 
   def triangles
     results = @vertex_indices_of_triangles.map do |indices|
-      Triangle.new( indices.map{|i| @vertices[i] } )
+      Mageo::Triangle.new( indices.map{|i| @vertices[i] } )
     end
     return results
   end
 
   #面で囲まれた空間の中にあれば true を返す。
   def inside?( pos )
-    raise TypeError if pos.class == Vector3DInternal
+    raise TypeError if pos.class == Mageo::Vector3DInternal
 
     result = true
     triangles.each do |triangle|
@@ -58,8 +58,8 @@ class Polyhedron
     return result
   end
 
-  def include?(pos, tolerance)
-    raise TypeError if pos.class == Vector3DInternal
+  def include?(pos, tolerance = 0.0)
+    raise TypeError if pos.class == Mageo::Vector3DInternal
 
     return true if inside?( pos )
     triangles.each do |triangle|
@@ -75,7 +75,7 @@ class Polyhedron
     result = 0.0
     @vertex_indices_of_triangles.each do |tri_vertices|
       vectors =  tri_vertices.map { |i| @vertices[i] - center }
-      volume = Vector3D.scalar_triple_product( *vectors ).abs
+      volume = Mageo::Vector3D.scalar_triple_product( *vectors ).abs
       volume /= 6.0
       result += volume
     end
@@ -84,7 +84,7 @@ class Polyhedron
 
   #各頂点の座標の平均値を返す。
   def center
-    tmp = Vector3D[ 0.0, 0.0, 0.0 ]
+    tmp = Mageo::Vector3D[ 0.0, 0.0, 0.0 ]
     @vertices.each do |vertex|
       tmp += vertex
     end

data/lib/mageo/segment.rb

@@ -1,10 +1,8 @@
 #! /usr/bin/env ruby
 # coding: utf-8
 
-require "mageo/vector3d.rb"
-
 # 線分を表すクラス。
-class Segment
+class Mageo::Segment
   attr_reader :endpoints
 
   class InitializeError < Exception; end
@@ -13,8 +11,8 @@ class Segment
   
   # 端点を2つ渡す。
   def initialize(vector0, vector1)
-    raise InitializeError if vector0.class != Vector3D
-    raise InitializeError if vector1.class != Vector3D
+    raise InitializeError if vector0.class != Mageo::Vector3D
+    raise InitializeError if vector1.class != Mageo::Vector3D
     raise InitializeError if vector0 == vector1
     
     @endpoints = [vector0, vector1]
@@ -22,9 +20,9 @@ class Segment
 
   # position で与えられた点が線分の中にある点か？
   # tolerance = 0.0 では計算誤差のためにほとんど真とならない。
-  # position は Vector3D クラスインスタンスでなければならない。
+  # position は Mageo::Vector3D クラスインスタンスでなければならない。
   def include?(position, tolerance)
-    raise TypeError if position.class != Vector3D
+    raise TypeError if position.class != Mageo::Vector3D
 
     vec_self = @endpoints[1] - @endpoints[0]
     vec_other = position - @endpoints[0]
@@ -56,7 +54,7 @@ class Segment
   end
 
   # endpoints で取り出せる座標2つのうち、最初のものから最後のものへのベクトルを表す
-  # Vector3D クラスインスタンスを返す。
+  # Mageo::Vector3D クラスインスタンスを返す。
   def to_v3d
     return @endpoints[1] - @endpoints[0]
   end
@@ -64,7 +62,7 @@ class Segment
   # 等価チェック。
   # uniq できるようにするため。
   def eql?(other)
-    raise TypeError if other.class != Segment
+    raise TypeError if other.class != Mageo::Segment
     @endpoints.each do |point|
       return false unless other.endpoints.include?(point)
     end
@@ -72,7 +70,7 @@ class Segment
   end
 
   def ==(other)
-    raise TypeError if other.class != Segment
+    raise TypeError if other.class != Mageo::Segment
     @endpoints.size.times do |i|
       return false unless other.endpoints[i] == @endpoints[i]
     end

data/lib/mageo/sphere.rb

@@ -1,17 +1,14 @@
 #! /usr/bin/env ruby
 # coding: utf-8
 
-require "mageo/vector3d.rb"
-
-#
 # 球を表現するクラス。
 #
-class Sphere
+class Mageo::Sphere
   attr_reader :position, :radius
 
   # 座標と半径
   def initialize(position, radius)
-    @position = Vector3D[*position]
+    @position = Mageo::Vector3D[*position]
     @radius = radius
   end
 end

data/lib/mageo/tetrahedron.rb

@@ -1,15 +1,10 @@
 #! /usr/bin/env ruby
 # coding: utf-8
 
-require "mageo/vector3d.rb"
-require "mageo/triangle.rb"
-require "mageo/polyhedron.rb"
-
-
 #
 # 直交座標系 3次元空間内の四面体を表現するクラス。
 #
-class Tetrahedron < Polyhedron
+class Mageo::Tetrahedron < Mageo::Polyhedron
 
   class InitializeError < Exception; end
 
@@ -23,7 +18,7 @@ class Tetrahedron < Polyhedron
       raise InitializeError unless vertex.methods.include?( :map )
     end
     vertices.each do |vertex|
-      raise InitializeError if vertex.class == Vector3DInternal
+      raise InitializeError if vertex.class == Mageo::Vector3DInternal
     end
 
     @vertices = vertices.map { |vertex| vertex.to_v3d }

data/lib/mageo/triangle.rb

@@ -1,18 +1,13 @@
 #! /usr/bin/env ruby
 # coding: utf-8
 
-require "mageo/vector3d.rb"
-require "mageo/vector3dinternal.rb"
-require "mageo/axes.rb"
-require "mageo/segment.rb"
-
 #3次元空間中の3角形を表現するクラス。
 #
-#法線ベクトル( Vector3D クラスインスタンス )を返すメソッドは定義しない。
+#法線ベクトル( Mageo::Vector3D クラスインスタンス )を返すメソッドは定義しない。
 #  法線ベクトルは2通りの方向を取りうるため。
 #  initialize 時に点の指定の順序を決めることで定義はできるが、
 #  そうすると簡潔性が損なわれる。
-class Triangle
+class Mageo::Triangle
   attr_reader :vertices
 
   class InitializeError < Exception; end
@@ -22,11 +17,11 @@ class Triangle
   class NoIntersectionError < Exception; end
 
   #An argument 'vertices' can be Array of 3 items, Vector of 3 items,
-  # or Vector3D class instance, which have [] and map methods.
+  # or Mageo::Vector3D class instance, which have [] and map methods.
   #当面は Array を前提とする。
   #座標が整数で入っていたとしても内部的には Float に変換して使用する。
   #3点が1直線上に並んでいて三角形を囲まない場合は
-  #例外 Triangle::LinearException を投げる。
+  #例外 Mageo::Triangle::LinearException を投げる。
   def initialize( vertices )
     raise InitializeError unless vertices.methods.include?( :size )
     raise InitializeError if vertices.size != 3
@@ -42,7 +37,7 @@ class Triangle
     #Checking on linear.
     edge1 = @vertices[1] - @vertices[0]
     edge2 = @vertices[2] - @vertices[0]
-    if ( Vector3D[0.0, 0.0, 0.0] == Vector3D.vector_product( edge1, edge2 ))
+    if ( Mageo::Vector3D[0.0, 0.0, 0.0] == Mageo::Vector3D.vector_product( edge1, edge2 ))
       raise LinearException
     end
 
@@ -51,16 +46,16 @@ class Triangle
   #引数で与えられた 2 つの座標が、三角形の面に対して同じ側にあれば true を返す。
   #どちらか、もしくは両方が、面上の点(当然頂点、辺上を含む)であれば必ず false を返す。
   def same_side?( pos0, pos1 )
-    raise TypeError if pos0.class != Vector3D
-    raise TypeError if pos1.class != Vector3D
+    raise TypeError if pos0.class != Mageo::Vector3D
+    raise TypeError if pos1.class != Mageo::Vector3D
 
     edge1 = @vertices[1] - @vertices[0]
     edge2 = @vertices[2] - @vertices[0]
     pos0  = pos0.to_v3d - @vertices[0]
     pos1  = pos1.to_v3d - @vertices[0]
 
-    triple_product_pos0 = Vector3D.scalar_triple_product( edge1, edge2, pos0 )
-    triple_product_pos1 = Vector3D.scalar_triple_product( edge1, edge2, pos1 )
+    triple_product_pos0 = Mageo::Vector3D.scalar_triple_product( edge1, edge2, pos0 )
+    triple_product_pos1 = Mageo::Vector3D.scalar_triple_product( edge1, edge2, pos1 )
     if triple_product_pos0 * triple_product_pos1 > 0
       return true
     else
@@ -69,11 +64,11 @@ class Triangle
   end
 
   # 3点で張られる面上にあり、三角形の内側にあれば true を返す。
-  # pos が Vector3D クラスインスタンスでなければ例外。
+  # pos が Mageo::Vector3D クラスインスタンスでなければ例外。
   # ただし、面の法線方向には tolerance だけの許容値を設ける。
   # 計算誤差の問題のため、これを設定しないと殆ど真とならない。
   def include?(pos, tolerance)
-    raise TypeError if pos.class != Vector3D
+    raise TypeError if pos.class != Mageo::Vector3D
 
     axes = internal_axes
     #一次独立チェックは initialize 時にされている筈。
@@ -167,7 +162,7 @@ class Triangle
   end
 
   # 3つの頂点の座標が順不同で対応すれば真を返す。
-  # other が Triangle クラス以外のインスタンスなら例外 Triangle::TypeError を投げる。
+  # other が Mageo::Triangle クラス以外のインスタンスなら例外 Triangle::TypeError を投げる。
   # MEMO:
   # 当初 eql? という名前を付けていたが、
   # これは hash メソッドと関連があるので危険。
@@ -175,7 +170,7 @@ class Triangle
   # しかし eql? に依存したコードが残っているので当面 alias を残す。
   # そのうち obsolete する。
   def equivalent?(other, tolerance = 0.0)
-    raise TypeError unless other.class == Triangle
+    raise TypeError unless other.class == Mageo::Triangle
 
     vertices.each do |v_self|
       if (other.vertices.find{|v_other| v_self.equal_in_delta?(v_other, tolerance) })
@@ -204,21 +199,21 @@ class Triangle
 
   def edges
     results = []
-    results << Segment.new(@vertices[0], @vertices[1])
-    results << Segment.new(@vertices[1], @vertices[2])
-    results << Segment.new(@vertices[2], @vertices[0])
+    results << Mageo::Segment.new(@vertices[0], @vertices[1])
+    results << Mageo::Segment.new(@vertices[1], @vertices[2])
+    results << Mageo::Segment.new(@vertices[2], @vertices[0])
     return results
   end
 
   private
 
   # 三角形の2辺のベクトルと、これらからなる外積ベクトル、
-  # 合計3つのベクトルから Axes クラスインスタンスを作る。
+  # 合計3つのベクトルから Mageo::Axes クラスインスタンスを作る。
   # vertices で取り出せる3頂点のうち、0th 要素を原点とし、
   # 1st, 2nd 要素をそれぞれ順に軸としたものとする。
   def internal_axes
     edge1 = (@vertices[1] - @vertices[0])
     edge2 = (@vertices[2] - @vertices[0])
-    return Axes.new([edge1, edge2, normal_vector])
+    return Mageo::Axes.new([edge1, edge2, normal_vector])
   end
 end