zakuro 0.2.0 → 0.6.0

data/lib/zakuro/version/daien/stella/lunar/adjustment.rb

@@ -0,0 +1,240 @@
+# frozen_string_literal: true
+
+require_relative '../../const/number'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Daien
+    # :nodoc:
+    module Lunar
+      #
+      # Adjustment 補正値情報
+      #
+      module Adjustment
+        # 『歴代天文律暦等志彙編　七』中華書房 p.2230
+        #
+        # 遠/近の地点での中間
+        #
+        # @return [Hash<Integer>] 遠/近の地点での中間
+        DAY_LIMIT = {
+          7 => 2701,
+          14 => 2363,
+          21 => 2024,
+          28 => 1686
+        }.freeze
+
+        #
+        # Row 行情報
+        #
+        class Row
+          # @return [Integer] 入暦（1-14）
+          attr_reader :day
+          # @return [Range] 小余範囲
+          attr_reader :range
+          # @return [Value] 補正値
+          attr_reader :value
+
+          #
+          # 初期化
+          #
+          # @param [Integer] day 入暦（1-14）
+          # @param [Range] range 小余範囲
+          # @param [Value] value 補正値
+          #
+          def initialize(day:, range:, value:)
+            @day = day
+            @range = range
+            @value = value
+          end
+
+          # :reek:ControlParameter
+
+          #
+          # 一致するか
+          #
+          # @param [Integer] day 入暦（1-14）
+          # @param [Integer] minute 小余
+          #
+          # @return [True] 一致
+          # @return [False] 不一致
+          #
+          def match?(day:, minute:)
+            return false unless @day == day
+
+            return false unless @range.include?(minute: minute)
+
+            true
+          end
+
+          #
+          # 分母を返す
+          #
+          # @return [Integer] 分母
+          #
+          def denominator
+            @range.denominator
+          end
+        end
+
+        #
+        # Range 小余範囲
+        #
+        class Range
+          # @return [Integer] 下限
+          MIN = 0
+          # @return [Integer] 上限
+          MAX = Const::Number::Cycle::DAY
+
+          # @return [Integer] 下限
+          attr_reader :min
+          # @return [Integer] 上限
+          attr_reader :max
+
+          #
+          # 初期化
+          #
+          # @param [Integer] min 下限
+          # @param [Integer] max 上限
+          #
+          def initialize(min: MIN, max: MAX)
+            @min = min
+            @max = max
+          end
+
+          #
+          # 含まれるか
+          #
+          # @param [Integer] minute 小余
+          #
+          # @return [True] 含まれる
+          # @return [False] 含まれない
+          #
+          def include?(minute:)
+            minute >= @min && minute <= @max
+          end
+
+          #
+          # 分母を返す
+          #
+          # @return [Integer] 分母
+          #
+          def denominator
+            @max - @min
+          end
+        end
+
+        #
+        # Value 補正値
+        #
+        class Value
+          # @return [Integer] 増減率
+          attr_reader :per
+          # @return [Integer] 遅速積
+          attr_reader :stack
+
+          #
+          # 初期化
+          #
+          # @param [Integer] per 増減率
+          # @param [Integer] stack 遅速積
+          #
+          def initialize(per:, stack:)
+            @per = per
+            @stack = stack
+          end
+
+          #
+          # 文字化
+          #
+          # @return [String] 文字
+          #
+          def to_s
+            "per:#{@per}, stack:#{@stack}"
+          end
+        end
+
+        # rubocop:disable Layout/LineLength
+
+        # 『歴代天文律暦等志彙編　七』中華書房 p.2228-2230
+        #
+        # @note 7日、14日、21日、28日の小余は DAY_LIMIT を参照のこと
+        #
+        # @return [Array<Row>] 月の補正値情報
+        #
+        LIST = [
+          Row.new(day: 1, range: Range.new, value: Value.new(per: +297, stack: 0)),
+          Row.new(day: 2, range: Range.new, value: Value.new(per: +259, stack: +297)),
+          Row.new(day: 3, range: Range.new, value: Value.new(per: +220, stack: +556)),
+          Row.new(day: 4, range: Range.new, value: Value.new(per: +180, stack: +776)),
+          Row.new(day: 5, range: Range.new, value: Value.new(per: +139, stack: +956)),
+          Row.new(day: 6, range: Range.new, value: Value.new(per: +97, stack: +1095)),
+          Row.new(day: 7, range: Range.new(max: DAY_LIMIT[7]), value: Value.new(per: +48, stack: +1192)),
+          Row.new(day: 7, range: Range.new(min: DAY_LIMIT[7]), value: Value.new(per: -6, stack: +1240)), # stack: +1192 + 48
+          Row.new(day: 8, range: Range.new, value: Value.new(per: -64, stack: +1234)),
+          Row.new(day: 9, range: Range.new, value: Value.new(per: -106, stack: +1170)),
+          Row.new(day: 10, range: Range.new, value: Value.new(per: -148, stack: +1064)),
+          Row.new(day: 11, range: Range.new, value: Value.new(per: -189, stack: +916)),
+          Row.new(day: 12, range: Range.new, value: Value.new(per: -229, stack: +727)),
+          Row.new(day: 13, range: Range.new, value: Value.new(per: -267, stack: +498)),
+          Row.new(day: 14, range: Range.new(max: DAY_LIMIT[14]), value: Value.new(per: -231, stack: +231)),
+          Row.new(day: 14, range: Range.new(min: DAY_LIMIT[14]), value: Value.new(per: -66, stack: 0)), # stack: +232 - 231
+          Row.new(day: 15, range: Range.new, value: Value.new(per: -289, stack: -66)),
+          Row.new(day: 16, range: Range.new, value: Value.new(per: -250, stack: -355)),
+          Row.new(day: 17, range: Range.new, value: Value.new(per: -211, stack: -605)),
+          Row.new(day: 18, range: Range.new, value: Value.new(per: -171, stack: -816)),
+          Row.new(day: 19, range: Range.new, value: Value.new(per: -130, stack: -987)),
+          Row.new(day: 20, range: Range.new, value: Value.new(per: -87, stack: -1117)),
+          Row.new(day: 21, range: Range.new(max: DAY_LIMIT[21]), value: Value.new(per: -36, stack: -1204)),
+          Row.new(day: 21, range: Range.new(min: DAY_LIMIT[21]), value: Value.new(per: +18, stack: -1240)), # stack: -1204 - 36
+          Row.new(day: 22, range: Range.new, value: Value.new(per: +73, stack: -1222)),
+          Row.new(day: 23, range: Range.new, value: Value.new(per: +116, stack: -1149)),
+          Row.new(day: 24, range: Range.new, value: Value.new(per: +157, stack: -1033)),
+          Row.new(day: 25, range: Range.new, value: Value.new(per: +198, stack: -876)),
+          Row.new(day: 26, range: Range.new, value: Value.new(per: +237, stack: -678)),
+          Row.new(day: 27, range: Range.new, value: Value.new(per: +276, stack: -441)),
+          Row.new(day: 28, range: Range.new(max: DAY_LIMIT[28]), value: Value.new(per: +165, stack: -165))
+        ].freeze
+        # rubocop:enable Layout/LineLength
+
+        #
+        # 月軌道の補正に必要な基本値を引き当てる
+        #
+        # @param [True, False] forward 進（遠地点より数える）/退（近地点より数える）
+        # @param [Integer] day 大余
+        # @param [Integer] minute 小余
+        #
+        # @return [Row] 補正値
+        #
+        def self.specify(day:, minute:)
+          LIST.each do |row|
+            # NOTE: 範囲が重複している場合、最初に引き当てたほうを優先する
+            return row if row.match?(day: day, minute: minute)
+          end
+
+          raise ArgumentError.new, "invalid parameter: #{day}/#{minute}"
+        end
+
+        # :reek:ControlParameter
+
+        #
+        # 小余の下げ幅を求める
+        #
+        # @param [Integer] day 大余
+        # @param [Integer] minute 小余
+        #
+        # @return [Integer] 小余の下げ幅
+        #
+        def self.minus_minute(day:, minute:)
+          limit = DAY_LIMIT.fetch(day, -1)
+          # 該当なし
+          return minute if limit == -1
+
+          return minute unless minute > limit
+
+          minute - limit
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/version/daien/stella/lunar/localization.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative '../../const/number'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Daien
+    # :nodoc:
+    module Lunar
+      #
+      # Localization 入暦特定
+      #
+      module Localization
+        # @return [Integer] 1近点月
+        ANOMALISTIC_MONTH = Const::Number::Cycle::ANOMALISTIC_MONTH
+        # @return [Integer] 積年
+        TOTAL_YEAR = Const::Number::Stack::TOTAL_YEAR
+        # @return [Integer] 開始年
+        BEGIN_YEAR = Const::Number::Stack::BEGIN_YEAR
+        # @return [Integer] 年
+        YEAR = Const::Number::Cycle::YEAR
+
+        #
+        # 対象年の最初の入暦を求める
+        #
+        # @param [Remainder] lunar_age 天正閏余
+        # @param [Integer] western_year 西暦年
+        #
+        # @return [Cycle::LunarRemainder] 入暦
+        #
+        def self.first_remainder(lunar_age:, western_year:)
+          # 積年の開始から対象年までの年数
+          total_year = TOTAL_YEAR + western_year - BEGIN_YEAR
+
+          # 通積分 - 天正閏余
+          total_day = total_year * YEAR - lunar_age.to_minute
+
+          Cycle::LunarRemainder.new(total: (total_day % ANOMALISTIC_MONTH))
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/version/daien/stella/lunar/location.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require_relative '../../../../calculation/stella/lunar/abstract_location'
+
+require_relative '../../const/remainder'
+
+require_relative './localization'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Daien
+    # :nodoc:
+    module Lunar
+      #
+      # Location 入暦
+      #
+      class Location < Calculation::Lunar::AbstractLocation
+        # @return [Cycle::LunarRemainder] 1近点月
+        ANOMALISTIC_MONTH = Const::Remainder::Lunar::ANOMALISTIC_MONTH
+        # @return [Cycle::LunarRemainder] 弦
+        QUARTER = Const::Remainder::Lunar::QUARTER
+
+        #
+        # 初期化
+        #
+        # @param [Cycle::LunarRemainder] lunar_age 天正閏余（大余小余）
+        # @param [Integer] western_year 西暦年
+        #
+        def initialize(lunar_age:, western_year:)
+          super(lunar_age: lunar_age, western_year: western_year)
+        end
+
+        #
+        # 入暦を計算する
+        #
+        def run
+          if calculated
+            decrease(limit: ANOMALISTIC_MONTH)
+            return
+          end
+
+          first
+        end
+
+        #
+        # 弦の分だけ月地点を進める
+        #
+        def add_quarter
+          remainder.add!(QUARTER)
+        end
+
+        private
+
+        #
+        # 初回計算
+        #
+        def first
+          @remainder = Localization.first_remainder(
+            lunar_age: remainder, western_year: western_year
+          )
+          decrease(limit: ANOMALISTIC_MONTH)
+
+          @calculated = true
+        end
+
+        #
+        # 大余小余に合わせて減算する（折り返す）
+        #
+        # @param [Cycle::LunarRemainder] limit 上限
+        #
+        def decrease(limit:)
+          return if remainder < limit
+
+          remainder.sub!(limit)
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/version/daien/stella/lunar/value.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative '../../../../calculation/stella/lunar/choukei_value'
+
+require_relative '../../cycle/remainder'
+
+require_relative './adjustment'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Daien
+    # :nodoc:
+    module Lunar
+      #
+      # Value 月補正値
+      #
+      module Value
+        # @return [Output::Logger] ロガー
+        LOGGER = Output::Logger.new(location: 'lunar_value')
+
+        # :reek:TooManyStatements { max_statements: 9 }
+
+        #
+        # 月の運行による補正値を算出する
+        #
+        # @param [Cycle::LunarRemainder] remainder 月の大余小余
+        #
+        # @return [Integer] 補正値
+        #
+        def self.get(remainder:)
+          valid?(remainder: remainder)
+
+          day, minute = Calculation::Lunar::ChoukeiValue.remainder_without_second(
+            remainder: remainder
+          )
+
+          # 引き当て
+          row = Adjustment.specify(day: day, minute: minute)
+
+          value = row.value
+
+          # LOGGER.debug("value.per: #{value.per}")
+          # LOGGER.debug("row.denominator: #{row.denominator}")
+          # LOGGER.debug("value.stack: #{value.stack}")
+
+          minus_minute = Adjustment.minus_minute(day: day, minute: minute)
+
+          day = Calculation::Lunar::ChoukeiValue.rounded_day(
+            per: value.per, denominator: row.denominator, minute: minus_minute
+          )
+
+          # LOGGER.debug("day: #{day}")
+
+          value.stack + day
+        end
+
+        #
+        # 大余小余を検証する
+        #
+        # @param [Cycle::LunarRemainder] remainder 大余小余
+        #
+        # @return [True] 正しい（月の位相計算に使う大余小余）
+        # @return [True] 正しくない
+        #
+        def self.valid?(remainder:)
+          return if remainder.is_a?(Cycle::LunarRemainder)
+
+          raise ArgumentError, "unmatch parameter type: #{remainder.class}"
+        end
+        private_class_method :valid?
+      end
+    end
+  end
+end

data/lib/zakuro/version/daien/stella/origin/average_november.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative './lunar_age'
+require_relative './winter_solstice'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Daien
+    # :nodoc:
+    module Origin
+      #
+      # AverageNovember 11月経
+      #
+      module AverageNovember
+        #
+        # 11月経朔（冬至が含まれる月の1日）を求める
+        #
+        # @param [Integer] western_year 西暦年
+        #
+        # @return [Remainder] 11月経朔
+        #
+        def self.get(western_year:)
+          # 冬至
+          winter_solstice = WinterSolstice.get(western_year: western_year)
+          # 天正閏余
+          lunar_age = LunarAge.get(western_year: western_year)
+
+          winter_solstice.sub(lunar_age)
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/version/daien/stella/origin/lunar_age.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative '../../../../output/logger'
+
+require_relative '../../const/number'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Daien
+    # :nodoc:
+    module Origin
+      #
+      # LunarAge 天正閏余
+      #
+      module LunarAge
+        # @return [Integer] 朔望月
+        SYNODIC_MONTH = Const::Number::Cycle::SYNODIC_MONTH
+        # @return [Integer] 一年
+        YEAR = Const::Number::Cycle::YEAR
+        # @return [Integer] 積年
+        TOTAL_YEAR = Const::Number::Stack::TOTAL_YEAR
+        # @return [Integer] 暦の開始年
+        BEGIN_YEAR = Const::Number::Stack::BEGIN_YEAR
+
+        # @return [Output::Logger] ロガー
+        LOGGER = Output::Logger.new(location: 'lunar_age')
+
+        # :reek:TooManyStatements { max_statements: 7 }
+
+        #
+        # 対象年の天正閏余（冬至より前にある11月経朔との差 = 月齢）を算出する
+        # 太陽と月の運動による補正値を算出し、その補正結果を返す
+        #
+        # @param [Integer] western_year 西暦年
+        #
+        # @return [Remainder] 天正閏余
+        #
+        def self.get(western_year:)
+          # 積年の開始から対象年までの年数
+          total = TOTAL_YEAR + western_year - BEGIN_YEAR
+
+          # 12朔望月に対する1年の余り（単位:分）
+          remainder_minute = YEAR - (SYNODIC_MONTH * 12)
+
+          # 朔望月に含まれなかった余り（単位:年）
+          remainder_year = total % SYNODIC_MONTH
+
+          LOGGER.debug("[01]: #{remainder_year}")
+
+          # 天正閏余
+          lunar_age = remainder_minute * remainder_year % SYNODIC_MONTH
+
+          LOGGER.debug("[02]: #{lunar_age}")
+
+          # 大余・小余に変換する
+          Cycle::Remainder.new(total: lunar_age)
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/version/daien/stella/origin/winter_solstice.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative '../../../../output/logger'
+
+require_relative '../../const/number'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Daien
+    # :nodoc:
+    module Origin
+      #
+      # WinterSolstice 冬至
+      #
+      module WinterSolstice
+        # @return [Integer] 通余
+        REMAINDER_ALL_YEAR = Const::Number::Derivation::REMAINDER_ALL_YEAR
+        # @return [Integer] 60日
+        SIXTY_DAYS = Const::Number::Derivation::SIXTY_DAYS
+        # @return [Integer] 積年
+        TOTAL_YEAR = Const::Number::Stack::TOTAL_YEAR
+        # @return [Integer] 暦の開始年
+        BEGIN_YEAR = Const::Number::Stack::BEGIN_YEAR
+
+        # @return [Output::Logger] ロガー
+        LOGGER = Output::Logger.new(location: 'winter_solstice')
+
+        # :reek:TooManyStatements { max_statements: 6 }
+
+        #
+        # 対象年の前年の冬至を求める
+        #
+        # @param [Integer] western_year 西暦年
+        #
+        # @return [Remainder] 前年の冬至
+        #
+        def self.get(western_year:)
+          # 積年の開始から対象年までの年数
+          total = TOTAL_YEAR + western_year - BEGIN_YEAR
+          remainder_year = total % SIXTY_DAYS
+
+          LOGGER.debug("[01]:#{remainder_year}")
+
+          # 通余を使う
+          winter_solstice_minute = (remainder_year * REMAINDER_ALL_YEAR) % SIXTY_DAYS
+
+          LOGGER.debug("[02]:#{winter_solstice_minute}")
+
+          Cycle::Remainder.new(total: winter_solstice_minute)
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/version/daien/stella/solar/adjustment.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require_relative '../../cycle/solar_term'
+
+require_relative '../../const/number'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Daien
+    # :nodoc:
+    module Solar
+      #
+      # Adjustment 24気損益眺朒（ちょうじく）数
+      #
+      module Adjustment
+        #
+        # Row 行データ
+        #
+        class Row
+          # @return [Integer] 眺朒（ちょうじく）積
+          attr_reader :stack
+          # @return [Integer] 眺朒（ちょうじく）数
+          attr_reader :per_term
+          # @return [Integer] 毎日差
+          attr_reader :per_day
+
+          #
+          # 初期化
+          #
+          # @param [Integer] stack 眺朒（ちょうじく）積
+          # @param [Integer] per_term 眺朒（ちょうじく）数
+          # @param [Integer] per_day 毎日差
+          #
+          def initialize(stack:, per_term:, per_day:)
+            @stack = stack
+            @per_term = per_term
+            @per_day = per_day
+          end
+
+          #
+          # 文字化
+          #
+          # @return [String] 文字
+          #
+          def to_s
+            "stack:#{@stack}, per_term:#{@per_term}, per_day:#{@per_day}"
+          end
+        end
+
+        # @return [Array<Row>] 24気損益眺朒（ちょうじく）数
+        MAP = {
+          touji: Row.new(stack: 0.0, per_term: +13.4524, per_day: -0.1886),        # 冬至（とうじ）
+          shoukan: Row.new(stack: +176.0, per_term: +10.5564, per_day: -0.1634),   # 小寒（しょうかん）
+          daikan: Row.new(stack: +314.0, per_term: +8.0408, per_day: -0.1446),     # 大寒（だいかん）
+          risshun: Row.new(stack: +418.0, per_term: +5.8160, per_day: -0.1318),    # 立春（りっしゅん）
+          usui: Row.new(stack: +491.0, per_term: +3.7987, per_day: -0.1240),       # 雨水（うすい）
+          keichitsu: Row.new(stack: +535.0, per_term: +1.9265, per_day: -0.1240),  # 啓蟄（けいちつ）
+          shunbun: Row.new(stack: +551.0, per_term: -0.2048, per_day: -0.1178),    # 春分（しゅんぶん）
+          seimei: Row.new(stack: +535.0, per_term: -1.9968, per_day: -0.1190),     # 清明（せいめい）
+          kokuu: Row.new(stack: +491.0, per_term: -3.7956, per_day: -0.1240),      # 穀雨（こくう）
+          rikka: Row.new(stack: +418.0, per_term: -5.6626, per_day: -0.1324),      # 立夏（りっか）
+          shouman: Row.new(stack: +314.0, per_term: -7.6555, per_day: -0.1436),    # 小満（しょうまん）
+          boushu: Row.new(stack: +176.0, per_term: -9.9405, per_day: -0.1436),     # 芒種（ぼうしゅ）
+          geshi: Row.new(stack: 0.0, per_term: -12.0819, per_day: +0.1436),        # 夏至（げし）
+          shousho: Row.new(stack: -176.0, per_term: -9.7018, per_day: +0.1324),    # 小暑（しょうしょ）
+          taisho: Row.new(stack: -314.0, per_term: -7.5450, per_day: +0.1240),     # 大暑（たいしょ）
+          risshuu: Row.new(stack: -418.0, per_term: -5.5634, per_day: +0.1190),    # 立秋（りっしゅう）
+          shosho: Row.new(stack: -491.0, per_term: -3.7038, per_day: +0.1178),     # 処暑（しょしょ）
+          hakuro: Row.new(stack: -535.0, per_term: -1.8954, per_day: +0.1178),     # 白露（はくろ）
+          shuubun: Row.new(stack: -551.0, per_term: +0.1783, per_day: +0.1240),    # 秋分（しゅうぶん）
+          kanro: Row.new(stack: -535.0, per_term: +2.0042, per_day: +0.1318),      # 寒露（かんろ）
+          soukou: Row.new(stack: -491.0, per_term: +3.8950, per_day: +0.1446),     # 霜降（そうこう）
+          rittou: Row.new(stack: -418.0, per_term: +5.9214, per_day: +0.1634),     # 立冬（りっとう）
+          shousetsu: Row.new(stack: -314.0, per_term: +8.1610, per_day: +0.1886),  # 小雪（しょうせつ）
+          taisetsu: Row.new(stack: -176.0, per_term: +10.9010, per_day: +0.1886)   # 大雪（たいせつ）
+        }.freeze
+
+        #
+        # 24気損益眺朒（ちょうじく）数の行データを特定する
+        #
+        # @param [Integer] index 連番（二十四節気）
+        #
+        # @return [Row] 行データ
+        #
+        def self.specify(index:)
+          key = Cycle::SolarTerm::ORDER[index]
+          Adjustment::MAP[key].clone
+        end
+      end
+    end
+  end
+end