zakuro 0.1.5 → 0.2.0

data/lib/zakuro/calculation/stella/solar/abstract_location.rb

@@ -0,0 +1,187 @@
+# frozen_string_literal: true
+
+require_relative '../../cycle/abstract_remainder'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Solar
+      #
+      # AbstractLocation 入定気
+      #
+      class AbstractLocation
+        # @return [True] 計算済み（前回計算あり）
+        # @return [False] 未計算（初回計算）
+        attr_reader :calculated
+        # @return [Integer] 連番
+        attr_reader :index
+        # @return [Cycle::AbstractRemainder] 大余小余
+        attr_reader :remainder
+        # @return [Cycle::AbstractRemainder] 弦
+        attr_reader :quarter
+
+        #
+        # 初期化
+        #
+        # @param [Cycle::AbstractRemainder] lunar_age 天正閏余（大余小余）
+        # @param [Cycle::AbstractRemainder] quarter 弦
+        #
+        def initialize(lunar_age:, quarter:)
+          @calculated = false
+          @index = -1
+          @remainder = lunar_age.clone
+          @quarter = quarter
+        end
+
+        #
+        # 入定気を計算する
+        #
+        def run
+          return current if calculated
+
+          first
+        end
+
+        #
+        # 無効かどうか
+        #
+        # @return [True] 無効
+        # @return [False] 有効
+        #
+        def invalid?
+          @index == -1
+        end
+
+        #
+        # 弦の分だけ太陽地点を進める
+        #
+        def add_quarter
+          @remainder.add!(quarter)
+        end
+
+        #
+        # 二十四節気番号に対応する入気定日加減数を返す
+        #
+        # @note 継承で暦ごとの入気定日加減数を返す
+        #
+        # @param [Integer] index 二十四節気番号
+        #
+        # @return [Cycle::Remainder] 入気定日加減数
+        #
+        def interval(index:)
+          # abstract
+        end
+
+        #
+        # 入気定日加減数の要素数を返す
+        #
+        # @note 継承で暦ごとの入気定日加減数の要素数を返す
+        #
+        # @return [Integer] 入気定日加減数の要素数
+        #
+        def interval_size
+          # abstract
+        end
+
+        private
+
+        #
+        # 2回目以降の計算をする
+        #
+        def current
+          decrease_recursively
+        end
+
+        #
+        # 初回計算する
+        #
+        def first
+          define_first
+          @calculated = true
+        end
+
+        #
+        # 初回の入定気を定める
+        #
+        def define_first
+          # 入定気の起算方法
+          # 概要:
+          #  * 太陽の運行による補正値は、二十四節気の気ごとに定められる
+          #  * 11月経朔の前にある気を求め、それから11月経朔との間隔を求める
+          #  * 気ごとの補正値と、気から11月経朔までにかかる補正値を求める
+          # 前提:
+          #  * 11月経朔に関わる二十四節気は、時系列から順に、小雪・大雪・冬至である
+          #  * 小雪〜大雪の間隔は小雪定数で、大雪〜冬至の間隔は大雪定数で決められている（24気損益眺朒（ちょうじく）数のこと）
+          #  * 11月経朔は、この小雪〜冬至の間のいずれかにある
+          # 計算:
+          # 2パターンある
+          #  (a) 大雪〜冬至にある場合
+          #   *「大雪定数 >= 天正閏余」の場合を指す
+          #   * * NOTE 資料では「より大きい（>）」とされるが、大雪そのものの場合は大雪から起算すべき
+          #   * この場合は、大雪〜経朔の間隔を求める
+          #  (b) 小雪〜大雪にある場合
+          #   *「大雪定数 < 天正閏余」の場合を指す
+          #   * この場合は、小雪〜経朔の間隔を求める
+
+          # NOTE: 上記パターンとは別に、稀だが立冬のパターンも存在する
+          # この場合は比較方法はそのままに立冬〜経朔の間隔を求める
+
+          # 大雪（23）/小雪（22）/立冬（21）
+          [23, 22, 21].each do |index|
+            prev(index: index)
+
+            break unless invalid?
+          end
+
+          # 立冬（21）を超える天正閏余は成立し得ない（1朔望月をはるかに超えることになる）
+          return unless invalid?
+
+          raise ArgumentError.new, 'invalid winster solstice age'
+        end
+
+        #
+        # 大余小余の分だけ二十四節気を遡る
+        #
+        # @param [Integer] index 二十四節気番号
+        #
+        def prev(index:)
+          interval = interval(index: index)
+          if remainder > interval
+            @remainder.sub!(interval)
+            return
+          end
+
+          # 入定気が確定する
+          @remainder = interval.sub(@remainder)
+          @index = index
+        end
+
+        #
+        # 二十四節気番号を次に進める
+        #
+        def next_index
+          @index += 1
+          @index = 0 if @index >= interval_size
+        end
+
+        #
+        # 二十四節気を減算する
+        #
+        def decrease_recursively
+          interval = interval(index: index)
+          # 現在の二十四節気に留まる
+          return if remainder < interval
+
+          @remainder.sub!(interval)
+
+          next_index
+
+          # 再帰
+          decrease_recursively
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/calculation/stella/solar/choukei_value.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+require_relative '../../type/old_float'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Solar
+      #
+      # ChoukeiValue 再考長慶宣明暦算法
+      #
+      module ChoukeiValue
+        # @return [Output::Logger] ロガー
+        LOGGER = Output::Logger.new(location: 'solar_choukei')
+
+        #
+        # 補正値を返す
+        #
+        # @param [Cycle::AbstractRemainder] remainder 大余小余
+        # @param [Adjustment::Row] row 24気損益眺朒（ちょうじく）数
+        #
+        # @return [Integer] 補正値
+        #
+        def self.get(remainder:, row:)
+          # 損益率/眺朒（ちょうじく）数
+          # パラメータ:
+          #  a: 眺朒（ちょうじく）数の初日の値
+          #  b: 損益率初日の値
+          #  c: 損益率の毎日の差
+          #  n: 定気の日から数えた日数
+
+          # LOGGER.debug("row.per_day: #{row.per_day}")
+          # LOGGER.debug("row.stack: #{row.stack}")
+
+          day_stack = calc_day_stack(remainder: remainder, row: row)
+
+          # LOGGER.debug("day_stack: #{day_stack}")
+
+          month_stack = calc_month_stack(row: row, day: remainder.day)
+
+          # LOGGER.debug("month_stack: #{month_stack}")
+
+          # 冬至であれば眺朒数がプラスになり続けて損益率が「益」で、小雪であればマイナスの眺朒数がプラスされ続けて「損」
+          month_stack + day_stack
+        end
+
+        #
+        # 損益率を求める
+        #
+        # @param [Remainder] remainder 入定気
+        # @param [Adjustment::Row] row 24気損益眺朒（ちょうじく）数
+        #
+        # @return [Integer] 損益率
+        #
+        def self.calc_day_stack(remainder:, row:)
+          ratio = calc_ratio(day: remainder.day, per_term: row.per_term, per_day: row.per_day)
+
+          # LOGGER.debug("ratio.sign: #{ratio.sign}")
+          # LOGGER.debug("ratio.abs: #{ratio.abs}")
+
+          calc_day_stack_from_ratio(
+            ratio: ratio, minute: remainder.minute, limit: remainder.base_day
+          )
+        end
+        private_class_method :calc_day_stack
+
+        #
+        # 大余に対応する損益率を求める
+        #   損益率 = b + n * c
+        #
+        # @param [Integer] day 大余
+        # @param [Integer] per_term 眺朒（ちょうじく）数
+        # @param [Integer] per_day 毎日差
+        #
+        # @return [Type::OldFloat] 大余に対応する損益率
+        #
+        def self.calc_ratio(day:, per_term:, per_day:)
+          ratio = Type::OldFloat.new(per_term + day * per_day)
+          # 小数点以下は無視する
+          ratio.floor!
+
+          ratio
+        end
+        private_class_method :calc_ratio
+
+        #
+        # 小余を含めた損益率を求める
+        #
+        # @param [Integer] sign 正負（大余に対応する損益率）
+        # @param [Integer] ratio 大余に対応する損益率
+        # @param [Integer] minute 小余
+        #
+        # @return [Integer] 小余を含めた損益率
+        #
+        def self.calc_day_stack_from_ratio(ratio:, minute:, limit:)
+          minute_stack = ratio.abs * minute
+          day_stack = (minute_stack / limit).floor
+          # 四捨五入
+          # NOTE 資料では「この余りが4200をこえていれば切り上げる」とあり「>=」とした
+          # 1612年の7月（慶長17年7月）が境界値4200だが、繰り上げを行なっていたため
+          day_stack += 1 if minute_stack % limit >= (limit / 2)
+          day_stack *= ratio.sign
+
+          day_stack
+        end
+        private_class_method :calc_day_stack_from_ratio
+
+        #
+        # 眺朒（ちょうじく）数を求める
+        #   眺朒（ちょうじく）数 = a + (n * b) + (1/2)n(n-1)c
+        #
+        # @param [Adjustment::Row] row 24気損益眺朒（ちょうじく）数
+        # @param [Integer] day 大余
+        #
+        # @return [Integer] 眺朒（ちょうじく）数
+        #
+        def self.calc_month_stack(row:, day:)
+          # row.stack: 眺朒（ちょうじく）積
+          # row.per_term: 眺朒（ちょうじく）数
+          # row.per_day: 毎日差
+          month_stack = Type::OldFloat.new(
+            row.stack + day * row.per_term + \
+            (1 / 2.0) * (day * (day - 1) * row.per_day)
+          )
+          # 切り捨て（プラスマイナスに関わらず小数点以下切り捨て）
+          month_stack.floor!
+
+          month_stack.get
+        end
+        private_class_method :calc_month_stack
+      end
+    end
+  end
+end

data/lib/zakuro/calculation/type/old_float.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Type
+      #
+      # OldFloat 浮動小数点数（古代）
+      #
+      # @note 四捨五入は常に絶対値に対して行う
+      #   * value.negative? ? value.ceil : value.floor
+      #   * 絶対値だけを取り出すことで、四捨五入を平易にする
+      #
+      class OldFloat
+        # @return [Integer] 符号
+        attr_reader :sign
+        # @return [Float] 絶対値
+        attr_reader :abs
+
+        #
+        # 初期化
+        #
+        # @param [Float] value 符号つき浮動小数点数
+        #
+        def initialize(value)
+          @sign = value.negative? ? -1 : 1
+          @abs = @sign * value
+        end
+
+        #
+        # 四捨五入する
+        #
+        def floor!
+          @abs = floor
+        end
+
+        #
+        # 四捨五入する（非破壊的）
+        #
+        # @return [Float] 絶対値
+        #
+        def floor
+          @abs.floor
+        end
+
+        #
+        # 符号つき浮動小数点数を取得する
+        #
+        # @return [Float] 符号つき浮動小数点数
+        #
+        def get
+          @sign * @abs
+        end
+
+        #
+        # 負数かどうか
+        #
+        # @return [True] 負数
+        # @return [False] 正数
+        #
+        def negative?
+          @sign == -1
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/version.rb

@@ -3,5 +3,5 @@
 # :nodoc:
 module Zakuro
   # @return [String] library version
-  VERSION = '0.1.5'
+  VERSION = '0.2.0'
 end

data/lib/zakuro/version/gihou/const/number.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Gihou
+    #
+    # Const 定数
+    #
+    module Const
+      #
+      # Number 数値
+      #
+      module Number
+        #
+        # Cycle 周期
+        #
+        module Cycle
+          # @return [Integer] 総法（1日=1340分）
+          DAY = 1340
+          #
+          # @return [Float] 変日（1近点月 = 27日743分1秒（1分=12秒））
+          # @note 小数点以下の値によって大幅に結果が変わる。除算結果を設定した
+          #
+          # ANOMALISTIC_MONTH = 36_923.083333333333
+          ANOMALISTIC_MONTH = 36_923 + (1.0 / 12)
+          # @return [Integer] 朔望月
+          SYNODIC_MONTH = 39_571
+          # @return [Integer] 一年
+          YEAR = 489_428
+        end
+
+        #
+        # Derivation 導出
+        #
+        module Derivation
+          # @return [Integer] 通余:  (YEAR - DAY * 12 * 30)
+          REMAINDER_ALL_YEAR = 7028
+          # @return [Integer] 旬周（60日） DAY * 60
+          SIXTY_DAYS = 80_400
+        end
+
+        #
+        # 累積
+        #
+        module Stack
+          # @return [Integer] 積年（甲子夜半朔旦冬至〜暦の開始前）
+          TOTAL_YEAR = 269_880
+          # @return [Integer] 暦の開始年（麟徳元年）
+          BEGIN_YEAR = 664
+        end
+      end
+    end
+  end
+end