zakuro 0.1.0 → 0.1.5

data/lib/zakuro/version/senmyou/stella/solar/average.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+require_relative '../../const/remainder'
+
+require_relative '../origin/winter_solstice'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Senmyou
+    # :nodoc:
+    module Solar
+      #
+      # Average 常気（太陽軌道平均）
+      #
+      class Average
+        # @return [Remainder] 気策
+        SOLAR_TERM_AVERAGE = Const::Remainder::Solar::SOLAR_TERM_AVERAGE
+
+        #
+        # 初期化
+        #
+        # @param [Integer] western_year 西暦年
+        #
+        def initialize(western_year:)
+          @solar_term = Average.first_solar_term(western_year: western_year)
+        end
+
+        #
+        # 冬至から数えた1年データの月ごとに二十四節気を割り当てる
+        #
+        # @param [Array<Month>] annual_range 1年データ
+        #
+        # @return [Array<Month>] 1年データ
+        #
+        def set(annual_range:)
+          # 次月と比較しながら当月の二十四節気を決める
+          # NOTE: 最後の月は処理できない（=計算外の余分な月が最後に必要である）
+          annual_range.each_cons(2) do |(current_month, next_month)|
+            set_solar_term(
+              current_month: current_month,
+              next_month: next_month
+            )
+          end
+
+          annual_range
+        end
+
+        #
+        # 計算開始する二十四節気を求める
+        #
+        # @param [Integer] western_year 西暦年
+        #
+        # @return [SolarTerm] 二十四節気
+        #
+        def self.first_solar_term(western_year:)
+          # 天正冬至
+          winter_solstice = Origin::WinterSolstice.get(western_year: western_year)
+
+          # 二十四節気（冬至）
+          solar_term = Cycle::SolarTerm.new(index: 0, remainder: winter_solstice)
+
+          first_solar_term_index = Average.calc_fist_solar_term_index(western_year: western_year)
+
+          # 対象の二十四節気まで戻す
+          solar_term.prev_by_index(first_solar_term_index)
+
+          solar_term
+        end
+
+        # :reek:TooManyStatements { max_statements: 6 }
+
+        #
+        # 計算開始する二十四節気番号を求める
+        #
+        # * 前提として入定気は冬至の手前にある
+        # * 例えば、定気が大雪であれば入定気は大雪の範囲内にある
+        # * 入定気は、定気の開始位置に重複しない限り、常に定気より後にある
+        # * 基本的に定気の一つ前から起算すれば、当時から求めた11月(閏10/閏11月)に二十四節気を割り当てられる
+        #
+        # @param [Integer] western_year 西暦年
+        #
+        # @return [Integer] 二十四節気番号
+        #
+        def self.calc_fist_solar_term_index(western_year:)
+          # 天正閏余
+          lunar_age = Origin::LunarAge.get(western_year: western_year)
+
+          solar_location = Solar::Location.new(lunar_age: lunar_age)
+          solar_location.run
+
+          solar_term_index = solar_location.index
+
+          # 入定気の一つ後の二十四節気まで戻す（ただし11月経朔が二十四節気上にある場合は戻さない）
+          solar_term_index += 1 unless solar_location.remainder == Cycle::Remainder.new(total: 0)
+
+          solar_term_index
+        end
+
+        # :reek:TooManyStatements { max_statements: 7 }
+
+        #
+        # 月内（当月朔日から当月末日（来月朔日の前日）の間）に二十四節気があるか
+        # @note 大余60で一巡するため 以下2パターンがある
+        #   * current_month <= next_month : (二十四節気) >= current_month && (二十四節気) < next_month
+        #   * current_month > next_month  : (二十四節気) >= current_month || (二十四節気) < next_month
+        #
+        # @param [Remainder] solar_term 二十四節気
+        # @param [Remainder] current_month 月初
+        # @param [Remainder] next_month 月末
+        #
+        # @return [True] 対象の二十四節気がある
+        # @return [False] 対象の二十四節気がない
+        #
+        def self.in_solar_term?(solar_term:, current_month:, next_month:)
+          # 大余で比較する
+          target_time = solar_term.day
+          current_month_time = current_month.day
+          next_month_time = next_month.day
+          current_month_over = (target_time >= current_month_time)
+          next_month_under = (target_time < next_month_time)
+
+          return current_month_over && next_month_under if current_month_time <= next_month_time
+
+          current_month_over || next_month_under
+        end
+
+        private
+
+        # :reek:TooManyStatements { max_statements: 8 }
+
+        #
+        # 二十四節気を設定する
+        #
+        # @param [Month] current_month 当月
+        # @param [Month] next_month 次月
+        #
+        def set_solar_term(current_month:, next_month:)
+          # 安全策として無限ループは回避する
+          # * 最大試行回数：4回（設定なし => 設定あり => 設定あり => 設定なし）
+          # * 閏月は1回しか設定しない
+          # * 最大2回設定する（中気・節気）
+          (0..3).each do |_index|
+            in_range = Average.in_solar_term?(
+              solar_term: @solar_term.remainder, current_month: current_month.remainder,
+              next_month: next_month.remainder
+            )
+
+            # 範囲外
+            unless in_range
+              # 1つ以上設定されていれば切り上げる（一つ飛ばしで二十四節気を設定することはない）
+              break unless current_month.empty_solar_term?
+
+              next_solar_term
+              next
+            end
+
+            current_month.add_term(term: @solar_term.clone)
+            next_solar_term
+
+            # 宣明暦は最大2つまで
+            break if current_month.solar_term_size == 2
+          end
+        end
+
+        #
+        # 次の二十四節気に移る
+        #
+        def next_solar_term
+          @solar_term.next_term!
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/version/senmyou/stella/solar/interval.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Senmyou
+    # :nodoc:
+    module Solar
+      #
+      # Interval 入気定日加減数（二十四節気の間隔）
+      #
+      module Interval
+        # @return [Hash<Symbol, Cycle::Remainder>] 一覧
+        MAP = {
+          # 冬至（とうじ）・大雪（たいせつ）
+          touji: Cycle::Remainder.new(day: 14, minute: 4235, second: 5),
+          taisetsu: Cycle::Remainder.new(day: 14, minute: 4235, second: 5),
+          # 小寒（しょうかん）・小雪（しょうせつ）
+          shoukan: Cycle::Remainder.new(day: 14, minute: 5235, second: 5),
+          shousetsu: Cycle::Remainder.new(day: 14, minute: 5235, second: 5),
+          # 大寒（だいかん）・立冬（りっとう）
+          daikan: Cycle::Remainder.new(day: 14, minute: 6235, second: 5),
+          rittou: Cycle::Remainder.new(day: 14, minute: 6235, second: 5),
+          # 立春（りっしゅん）・霜降（そうこう）
+          risshun: Cycle::Remainder.new(day: 14, minute: 7235, second: 5),
+          soukou: Cycle::Remainder.new(day: 14, minute: 7235, second: 5),
+          # 雨水（うすい）・寒露（かんろ）
+          usui: Cycle::Remainder.new(day: 15, minute: 35, second: 5),
+          kanro: Cycle::Remainder.new(day: 15, minute: 35, second: 5),
+          # 啓蟄（けいちつ）・秋分（しゅうぶん）
+          keichitsu: Cycle::Remainder.new(day: 15, minute: 1235, second: 5),
+          shuubun: Cycle::Remainder.new(day: 15, minute: 1235, second: 5),
+          # 春分（しゅんぶん）・白露（はくろ）
+          shunbun: Cycle::Remainder.new(day: 15, minute: 2435, second: 5),
+          hakuro: Cycle::Remainder.new(day: 15, minute: 2435, second: 5),
+          # 清明（せいめい）・処暑（しょしょ）
+          seimei: Cycle::Remainder.new(day: 15, minute: 3635, second: 5),
+          shosho: Cycle::Remainder.new(day: 15, minute: 3635, second: 5),
+          # 穀雨（こくう）・立秋（りっしゅう）
+          kokuu: Cycle::Remainder.new(day: 15, minute: 4835, second: 5),
+          risshuu: Cycle::Remainder.new(day: 15, minute: 4835, second: 5),
+          # 立夏（りっか）・大暑（たいしょ）
+          rikka: Cycle::Remainder.new(day: 15, minute: 5835, second: 5),
+          taisho: Cycle::Remainder.new(day: 15, minute: 5835, second: 5),
+          # 小満（しょうまん）・小暑（しょうしょ）
+          shouman: Cycle::Remainder.new(day: 15, minute: 6835, second: 5),
+          shousho: Cycle::Remainder.new(day: 15, minute: 6835, second: 5),
+          # 芒種（ぼうしゅ）・夏至（げし）
+          boushu: Cycle::Remainder.new(day: 15, minute: 7835, second: 5),
+          geshi: Cycle::Remainder.new(day: 15, minute: 7835, second: 5)
+        }.freeze
+
+        # @return [Array<Remainder>] 索引
+        LIST = [
+          MAP[:touji],      #  0
+          MAP[:shoukan],    #  1
+          MAP[:daikan],     #  2
+          MAP[:risshun],    #  3
+          MAP[:usui],       #  4
+          MAP[:keichitsu],  #  5
+          MAP[:shunbun],    #  6
+          MAP[:seimei],     #  7
+          MAP[:kokuu],      #  8
+          MAP[:rikka],      #  9
+          MAP[:shouman],    # 10
+          MAP[:boushu],     # 11
+          MAP[:geshi],      # 12
+          MAP[:shousho],    # 13
+          MAP[:taisho],     # 14
+          MAP[:risshuu],    # 15
+          MAP[:shosho],     # 16
+          MAP[:hakuro],     # 17
+          MAP[:shuubun],    # 18
+          MAP[:kanro],      # 19
+          MAP[:soukou],     # 20
+          MAP[:rittou],     # 21
+          MAP[:shousetsu],  # 22
+          MAP[:taisetsu]    # 23
+        ].freeze
+
+        #
+        # 入気定日加減数を引き当てる
+        #
+        # @param [Integer] index 二十四節気番号
+        #
+        # @return [Cycle::Remainder] 入気定日加減数
+        #
+        def self.index_of(index)
+          LIST[index]
+        end
+
+        #
+        # 入気定日加減数の総数を返す
+        #
+        # @return [Integer] 入気定日加減数の総数
+        #
+        def self.size
+          LIST.size
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/version/senmyou/stella/solar/location.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+require_relative '../../const/remainder'
+
+require_relative './interval'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Senmyou
+    # :nodoc:
+    module Solar
+      #
+      # Location 入定気
+      #
+      class Location
+        # @return [Cycle::Remainder] 弦
+        QUARTER = Const::Remainder::Solar::QUARTER
+
+        # @return [True] 計算済み（前回計算あり）
+        # @return [False] 未計算（初回計算）
+        attr_reader :calculated
+        # @return [Integer] 連番
+        attr_reader :index
+        # @return [Cycle::Remainder] 大余小余
+        attr_reader :remainder
+
+        #
+        # 初期化
+        #
+        # @param [Cycle::Remainder] lunar_age 天正閏余（大余小余）
+        #
+        def initialize(lunar_age: Cycle::Remainder.new)
+          @calculated = false
+          @index = -1
+          @remainder = lunar_age.clone
+        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
+
+        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_of(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_of(@index)
+          # 現在の二十四節気に留まる
+          return if remainder < interval
+
+          @remainder.sub!(interval)
+
+          next_index
+
+          # 再帰
+          decrease_recursively
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/version/senmyou/stella/solar/value.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require_relative '../../const/number'
+
+require_relative './adjustment'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Senmyou
+    # :nodoc:
+    module Solar
+      #
+      # Value 太陽補正値
+      #
+      module Value
+        # @return [Integer] 1日
+        DAY = Const::Number::Cycle::DAY
+
+        #
+        # 太陽の運行による補正値を算出する
+        #
+        # @param [SolarTerm] solar_location 入定気
+        #
+        # @return [Integer] 補正値
+        #
+        def self.get(solar_location:)
+          remainder = solar_location.remainder
+
+          adjustment = Adjustment.specify(index: solar_location.index)
+          # 損益率/眺朒（ちょうじく）数
+          # パラメータ:
+          #  a: 眺朒（ちょうじく）数の初日の値
+          #  b: 損益率初日の値
+          #  c: 損益率の毎日の差
+          #  n: 定気の日から数えた日数
+
+          day_stack = calc_day_stack(remainder: remainder, adjustment: adjustment)
+
+          month_stack = calc_month_stack(stack: adjustment.stack, day: remainder.day,
+                                         per_term: adjustment.per_term, per_day:
+                                         adjustment.per_day)
+
+          # 冬至であれば眺朒数がプラスになり続けて損益率が「益」で、小雪であればマイナスの眺朒数がプラスされ続けて「損」
+          month_stack + day_stack
+        end
+
+        #
+        # 損益率を求める
+        #
+        # @param [Remainder] remainder 入定気
+        # @param [Adjustment::Item] adjustment 24気損益眺朒（ちょうじく）数
+        #
+        # @return [Integer] 損益率
+        #
+        def self.calc_day_stack(remainder:, adjustment:)
+          per_term = adjustment.per_term
+          per_day = adjustment.per_day
+          sign, ratio = calc_ratio(day: remainder.day, per_term: per_term, per_day: per_day)
+
+          calc_day_stack_from_ratio(sign: sign, ratio: ratio,
+                                    minute: remainder.minute)
+        end
+        private_class_method :calc_day_stack
+
+        # :reek:TooManyStatements { max_statements: 6 }
+
+        #
+        # 大余に対応する損益率を求める
+        #   損益率 = b + n * c
+        #
+        # @param [Integer] day 大余
+        # @param [Integer] per_term 眺朒（ちょうじく）数
+        # @param [Integer] per_day 毎日差
+        #
+        # @return [Integer] 正負
+        # @return [Integer] 大余に対応する損益率
+        #
+        def self.calc_ratio(day:, per_term:, per_day:)
+          ratio = per_term + day * per_day
+          sign = 1
+          if ratio.negative?
+            sign = -1
+            ratio *= sign
+          end
+          # 小数点以下は無視する
+          ratio = ratio.floor
+
+          [sign, 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(sign:, ratio:, minute:)
+          minute_stack = ratio * minute
+          day_stack = (minute_stack / DAY).floor
+          # 四捨五入
+          # NOTE 資料では「この余りが4200をこえていれば切り上げる」とあり「>=」とした
+          # 1612年の7月（慶長17年7月）が境界値4200だが、繰り上げを行なっていたため
+          day_stack += 1 if minute_stack % DAY >= (DAY / 2)
+          day_stack *= sign
+
+          day_stack
+        end
+        private_class_method :calc_day_stack_from_ratio
+
+        # :reek:LongParameterList { max_params: 4 }
+
+        #
+        # 眺朒（ちょうじく）数を求める
+        #   眺朒（ちょうじく）数 = a + (n * b) + (1/2)n(n-1)c
+        #
+        # @param [Integer] stack 眺朒（ちょうじく）積
+        # @param [Integer] day 大余
+        # @param [Integer] per_term 眺朒（ちょうじく）数
+        # @param [Integer] per_day 毎日差f
+        #
+        # @return [Integer] 眺朒（ちょうじく）数
+        #
+        def self.calc_month_stack(stack:, day:, per_term:, per_day:)
+          month_stack = stack + day * per_term + \
+                        (1 / 2.0) * (day * (day - 1) * per_day)
+          # 切り捨て（プラスマイナスに関わらず小数点以下切り捨て）
+          month_stack.negative? ? month_stack.ceil : month_stack.floor
+        end
+        private_class_method :calc_month_stack
+      end
+    end
+  end
+end