rroonga 2.0.4-x86-mingw32 → 2.0.7-x86-mingw32

data/lib/groonga/geo-point.rb

@@ -0,0 +1,216 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2012  Kouhei Sutou <kou@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License version 2.1 as published by the Free Software Foundation.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+module Groonga
+  module GeoPointValueConverter
+    module_function
+
+    MSEC_PER_SEC = 1000 * 1000
+    N_SIGNIFICANT_DIGITS = (Math.log10(MSEC_PER_SEC) + 1).truncate
+    def msec_to_degree(msec)
+      degree_integer_part, degree_fraction_part = msec.divmod(3600 * 1000)
+      degree = degree_integer_part + (degree_fraction_part.to_f / (3600 * 1000))
+      round(degree, N_SIGNIFICANT_DIGITS)
+    end
+
+    def degree_to_msec(degree)
+      round(degree * 3600 * 1000)
+    end
+
+    def msec?(value)
+      value.is_a?(Integer)
+    end
+
+    def degree?(value)
+      value.is_a?(Float)
+    end
+
+    def to_degree(value)
+      return value if degree?(value)
+      msec_to_degree(value)
+    end
+
+    def to_msec(value)
+      return value if msec?(value)
+      degree_to_msec(value)
+    end
+
+    def parse(value)
+      if /\A[-+]?\d+\z/ =~ value
+        value.to_i
+      else
+        value.to_f
+      end
+    end
+
+    if Numeric.instance_method(:round).arity.zero?
+      def round(number, n_digits=0)
+        if n_digits.zero?
+          number.round
+        else
+          base = 10 ** n_digits
+          (number * base).round / base.to_f
+        end
+      end
+    else
+      def round(number, n_digits=0)
+        number.round(n_digits)
+      end
+    end
+  end
+
+  class GeoPoint
+    class << self
+      def parse(string)
+        # TODO: validation
+        latitude, longitude = string.split(/[x,]/, 2)
+        new(GeoPointValueConverter.parse(latitude),
+            GeoPointValueConverter.parse(longitude))
+      end
+    end
+
+    attr_accessor :latitude, :longitude
+    # TODO: write document
+    # @overload initialize(geo_point_in_string)
+    # @overload initialize(latitude, longitude)
+    def initialize(*arguments)
+      if arguments.size == 1
+        if arguments.first.is_a?(String)
+          geo_point = self.class.parse(arguments.first)
+        else
+          geo_point = arguments.first
+          geo_point = coerce(geo_point)
+        end
+        @latitude = geo_point.latitude
+        @longitude = geo_point.longitude
+      else
+        # TODO: check # of arguments
+        @latitude, @longitude, = arguments
+      end
+    end
+
+    def degree?
+      GeoPointValueConverter.degree?(latitude) and
+        GeoPointValueConverter.degree?(longitude)
+    end
+
+    def msec?
+      GeoPointValueConverter.msec?(latitude) and
+        GeoPointValueConverter.msec?(longitude)
+    end
+
+    def to_degree
+      return self if degree?
+      self.class.new(GeoPointValueConverter.to_degree(latitude),
+                     GeoPointValueConverter.to_degree(longitude))
+    end
+
+    def to_msec
+      return self if msec?
+      self.class.new(GeoPointValueConverter.to_msec(latitude),
+                     GeoPointValueConverter.to_msec(longitude))
+    end
+
+    def to_s
+      "#{latitude}x#{longitude}"
+    end
+
+    def inspect
+      "#<#{self.class} #{to_s}>"
+    end
+
+    def ==(other)
+      case other
+      when String
+        to_s == otehr
+      when GeoPoint
+        normalized_self = to_msec
+        normalized_other = coerce(other).to_msec
+        [normalized_self.latitude, normalized_self.longitude] ==
+          [normalized_other.latitude, normalized_other.longitude]
+      else
+        false
+      end
+    end
+  end
+
+  class TokyoGeoPoint < GeoPoint
+    def to_tokyo
+      self
+    end
+
+    # TODO: write document
+    #
+    # TokyoGeoPoint <-> WGS84GeoPoint is based on
+    # http://www.jalan.net/jw/jwp0200/jww0203.do
+    #
+    #   jx: longitude in degree in Tokyo Geodetic System.
+    #   jy: latitude in degree in Tokyo Geodetic System.
+    #   wx: longitude in degree in WGS 84.
+    #   wy: latitude in degree in WGS 84.
+    #
+    #   jy = wy * 1.000106961 - wx * 0.000017467 - 0.004602017
+    #   jx = wx * 1.000083049 + wy * 0.000046047 - 0.010041046
+    #
+    #   wy = jy - jy * 0.00010695 + jx * 0.000017464 + 0.0046017
+    #   wx = jx - jy * 0.000046038 - jx * 0.000083043 + 0.010040
+    def to_wgs84
+      in_degree = to_degree
+      wgs84_latitude_in_degree =
+        in_degree.latitude -
+        in_degree.latitude * 0.00010695 +
+        in_degree.longitude * 0.000017464 +
+        0.0046017
+      wgs84_longitude_in_degree =
+        in_degree.longitude -
+        in_degree.latitude * 0.000046038 -
+        in_degree.longitude * 0.000083043 +
+        0.010040
+      WGS84GeoPoint.new(wgs84_latitude_in_degree, wgs84_longitude_in_degree)
+    end
+
+    private
+    def coerce(other_geo_point)
+      other_geo_point.to_tokyo
+    end
+  end
+
+  class WGS84GeoPoint < GeoPoint
+    # @see TokyoGeoPoint#to_wgs84
+    def to_tokyo
+      in_degree = to_degree
+      tokyo_latitude_in_degree =
+        in_degree.latitude * 1.000106961 -
+        in_degree.longitude * 0.000017467 -
+        0.004602017
+      tokyo_longitude_in_degree =
+        in_degree.longitude * 1.000083049 +
+        in_degree.latitude  * 0.000046047 -
+        0.010041046
+      TokyoGeoPoint.new(tokyo_latitude_in_degree, tokyo_longitude_in_degree)
+    end
+
+    def to_wgs84
+      self
+    end
+
+    private
+    def coerce(other_geo_point)
+      other_geo_point.to_wgs84
+    end
+  end
+end

data/lib/groonga/pagination.rb

@@ -17,7 +17,7 @@
 
 module Groonga
   class TooSmallPage < Error
-    # Table#paginate で小さすぎるページ番号を指定した場合に
+    # {Table#paginate} で小さすぎるページ番号を指定した場合に
     # 発生する。
 
     # 指定したページ番号。
@@ -33,7 +33,7 @@ module Groonga
   end
 
   class TooLargePage < Error
-    # Table#paginate で大きすぎるページ番号を指定した場合に
+    # {Table#paginate} で大きすぎるページ番号を指定した場合に
     # 発生する。
 
     # 指定したページ番号。
@@ -49,7 +49,7 @@ module Groonga
   end
 
   class TooSmallPageSize < Error
-    # Table#paginate で小さすぎるページサイズを指定した場合
+    # {Table#paginate} で小さすぎるページサイズを指定した場合
     # に発生する。
 
     # 指定したページサイズ。
@@ -67,42 +67,48 @@ module Groonga
   class Table
 
     # ページネーション用便利メソッド。ページネーションをした
-    # い場合は #sort よりも #paginate の方が便利。
+    # い場合は {#sort} よりも #paginate の方が便利。
     #
     # 説明文（descriptionカラム）を「Ruby」で全文検索し、
     # 検索結果をスコアの高い順にソートして、10項目ずつ表示する
     # 場合は以下のようになる。
     #
-    #   query = "Ruby"
-    #   entries = Groonga["entries"]
-    #   selected_entries = entries.select do |record|
-    #     entry.description =~ query
-    #   end
-    #   paged_entries = selected_entries.paginate([["_score", :desc]],
-    #                                             :page => 1,
-    #                                             :size => 10)
+    # <pre>
+    # !!!ruby
+    # query = "Ruby"
+    # entries = Groonga["entries"]
+    # selected_entries = entries.select do |record|
+    #   entry.description =~ query
+    # end
+    # paged_entries = selected_entries.paginate([["_score", :desc]],
+    #                                           :page => 1,
+    #                                           :size => 10)
+    # </pre>
     #
-    # #sort と違い、返されるTableオブジェクトにはPagination
-    # モジュールがextendされており、以下のようにページネーショ
-    # ン情報を取得できる。
+    # {#sort} と違い、返される {Table} オブジェクトには
+    # {Pagination} モジュールがextendされており、
+    # 以下のようにページネーション情報を取得できる。
     #
-    #   puts "#{paged_entries.n_records}件ヒット"
-    #   puts "#{paged_entries.start_offset}-#{paged_entries.end_offset}件を表示"
-    #   paged_entries.each do |entry|
-    #     puts entry.description
-    #   end
+    # <pre>
+    # !!!ruby
+    # puts "#{paged_entries.n_records}件ヒット"
+    # puts "#{paged_entries.start_offset}-#{paged_entries.end_offset}件を表示"
+    # paged_entries.each do |entry|
+    #   puts entry.description
+    # end
+    # </pre>
     #
     # _sort_keys_ には ソートに用いる情報を指定する。
-    # 指定の仕方は #sort と同様なので、詳細は #sort を参照。
+    # 指定の仕方は {#sort} と同様なので、詳細は {#sort} を参照。
     #
     # _options_ に指定可能な値は以下の通り。
     #
     # @param [::Hash] options The name and value
     #   pairs. Omitted names are initialized as the default value.
-    # @option options [Integer] :size (10) The size
+    # @option options [Integer] :size (10)
     #
     #   1ページあたりに表示する最大項目数。
-    # @option options [Integer] :page (1) The page
+    # @option options [Integer] :page (1)
     #
     #   ページ番号。ページ番号は0ベースではなく1ベースであることに注意。
     def paginate(sort_keys, options={})
@@ -220,7 +226,7 @@ module Groonga
 
     # 最初のページから最後のページまでを含んだRangeを返す。
     #
-    # 例えば、10ページある場合は以下を返す。
+    # @example 10ページある場合は以下を返す。
     #   1..10
     def pages
       first_page..last_page

data/lib/groonga/posting.rb

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2011  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2011-2012  Kouhei Sutou <kou@clear-code.com>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -43,6 +43,12 @@ module Groonga
     # The number of rest posting information for the term ID.
     attr_accessor :n_rest_postings
 
+    # @return [Groonga::Table] The table of the record ID.
+    attr_reader :table
+
+    # @return [Groonga::Table] The table of the term ID.
+    attr_reader :lexicon
+
     # Creates a new Posting.
     #
     # @return The new Posting.
@@ -61,6 +67,8 @@ module Groonga
     # @option parameters [Integer] :term_frequency The term_frequency.
     # @option parameters [Integer] :weight The weight.
     # @option parameters [Integer] :n_rest_postings The n_rest_postings.
+    # @option parameters [Groonga::Table] :table The table of the record ID.
+    # @option parameters [Groonga::Table] :lexicon The table of the term ID.
     def update(parameters)
       @record_id = parameters[:record_id] || nil
       @section_id = parameters[:section_id] || nil
@@ -69,6 +77,8 @@ module Groonga
       @term_frequency = parameters[:term_frequency] || 0
       @weight = parameters[:weight] || 0
       @n_rest_postings = parameters[:n_rest_postings] || 0
+      @table = parameters[:table]
+      @lexicon = parameters[:lexicon]
     end
 
     # Returns Hash created from attributes.
@@ -83,5 +93,23 @@ module Groonga
         :n_rest_postings => @n_rest_postings
       }
     end
+
+    # @return [Groonga::Record, nil] The record for the record ID.
+    #   If table isn't assosiated, nil is returned.
+    #
+    # @since 2.0.6
+    def record
+      return nil unless @table
+      Record.new(@table, @record_id)
+    end
+
+    # @return [Groonga::Record, nil] The record for the term ID.
+    #   If lexicon isn't assosiated, nil is returned.
+    #
+    # @since 2.0.6
+    def term
+      return nil unless @lexicon
+      Record.new(@lexicon, @term_id)
+    end
   end
 end

data/lib/groonga/record.rb

@@ -21,14 +21,17 @@ module Groonga
   class Record
     # レコードが所属するテーブル
     attr_reader :table
-    # _table_ の _id_ に対応するレコードを作成する。_values_ には各
+    # _table_ の _id_ に対応するレコードを作成する。 _values_ には各
     # カラムに設定する値を以下のような形式で指定する。
     #
-    #   [
-    #    ["カラム名", 値],
-    #    ["カラム名", 値],
-    #    ...,
-    #   ]
+    # <pre>
+    # !!!ruby
+    # [
+    #  ["カラム名", 値],
+    #  ["カラム名", 値],
+    #  ...,
+    # ]
+    # </pre>
     def initialize(table, id, values=nil)
       @table = table
       @id = id
@@ -48,7 +51,7 @@ module Groonga
         [table, id] == [other.table, other.id]
     end
 
-    # Groonga::Record#==と同じ。
+    # {Groonga::Record#==} と同じ。
     def eql?(other)
       self == other
     end
@@ -100,35 +103,35 @@ module Groonga
     end
 
     # 名前が _name_ のカラムが索引カラム
-    # （Groonga::IndexColumn）であるなら +true+ を返す。
+    # （ {Groonga::IndexColumn} ）であるなら +true+ を返す。
     def index_column?(name)
       column(name).index?
     end
 
     # 名前が _name_ のカラムの値がベクターであるなら +true+ を返す。
     #
-    # @since: 1.0.5
+    # @since 1.0.5
     def vector_column?(name)
       column(name).vector?
     end
 
     # 名前が _name_ のカラムの値がスカラーであるなら +true+ を返す。
     #
-    # @since: 1.0.5
+    # @since 1.0.5
     def scalar_column?(name)
       column(name).scalar?
     end
 
-    # 名前が _name_ のGroonga::IndexColumnの search メソッドを呼ぶ。
+    # 名前が _name_ の {Groonga::IndexColumn} の search メソッドを呼ぶ。
     # _query_ と _options_ はそのメソッドにそのまま渡される。詳しく
-    # はGroonga::IndexColumn#searchを参照。
+    # は {Groonga::IndexColumn#search} を参照。
     def search(name, query, options={})
       column(name).search(query, options)
     end
 
     # レコードの主キーを返す。
     #
-    # _record_ が所属するテーブルがGroonga:::Arrayの場合は常
+    # _record_ が所属するテーブルが {Groonga::Array} の場合は常
     # に +nil+ を返す。
     def key
       if support_key?
@@ -139,7 +142,7 @@ module Groonga
     end
     # レコードを一意に識別するための情報を返す。
     #
-    # _record_ が所属するテーブルがGroonga:::Arrayの場合はID
+    # _record_ が所属するテーブルが {Groonga::Array} の場合はID
     # を返し、それ以外の場合は主キーを返す。
     def record_id
       if support_key?
@@ -168,7 +171,7 @@ module Groonga
       self["_score"] = new_score
     end
 
-    # Groonga::Record#scoreが利用できる場合は +true+ を
+    # {Groonga::Record#score} が利用できる場合は +true+ を
     # 返す。
     def support_score?
       @table.have_column?("_score") # TODO delegate to Table
@@ -177,13 +180,13 @@ module Groonga
     # 主キーの値が同一であったレコードの件数を返す。検索結果とし
     # て生成されたテーブルのみに定義される。
     #
-    # Groonga::Record#support_sub_records?でこの値を利用でき
+    # {Groonga::Record#support_sub_records?} でこの値を利用でき
     # るかがわかる。
     def n_sub_records
       self["_nsubrecs"]
     end
 
-    # Groonga::Record#n_sub_recordsが利用できる場合は +true+ を
+    # {Groonga::Record#n_sub_records} が利用できる場合は +true+ を
     # 返す。
     def support_sub_records?
       @table.support_sub_records?
@@ -232,7 +235,7 @@ module Groonga
     end
 
     # レコードが所属するテーブルをロックする。ロックに失敗した場
-    # 合はGroonga::ResourceDeadlockAvoided例外が発生する。
+    # 合は {Groonga::ResourceDeadlockAvoided} 例外が発生する。
     #
     # ブロックを指定した場合はブロックを抜けたときにunlockする。
     #