zakuro 0.1.1 → 0.2.0

data/lib/zakuro/calculation/specifier/single_day.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require_relative '../base/multi_gengou_roller'
+require_relative '../base/year'
+
+require_relative '../../era/western'
+require_relative '../../output/response'
+require_relative '../../output/logger'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Specifier
+      #
+      # SingleDay 一日検索
+      #
+      module SingleDay
+        # @return [Output::Logger] ロガー
+        LOGGER = Output::Logger.new(location: 'specifier')
+
+        #
+        # 取得する
+        #
+        # @param [Array<Year>] yeas 範囲
+        # @param [Western::Calendar] date 西暦日
+        #
+        # @return [Result::Data::SingleDay] 和暦日
+        #
+        def self.get(years: [], date: Western::Calendar.new)
+          year = specify_year(years: years, date: date)
+
+          year = transfer(year: year, date: date)
+
+          month = specify_month(year: year, date: date)
+          first_date = month.western_date
+
+          Output::Response::SingleDay.save_single_day(
+            param: Output::Response::SingleDay::Param.new(
+              year: year, month: month,
+              date: date, days: date - first_date
+            )
+          )
+        end
+
+        #
+        # 年を特定する
+        #
+        # @param [Array<Year>] years 範囲
+        # @param [Western::Calendar] date 西暦日
+        #
+        # @return [Year] 対象年
+        #
+        def self.specify_year(years:, date:)
+          years.reverse_each do |year|
+            return year if date >= year.new_year_date
+          end
+
+          raise ArgumentError, "invalid year range. date: #{date.format}"
+        end
+        private_class_method :specify_year
+
+        #
+        # 改元する
+        #
+        # @param [Year] year 年
+        # @param [Western::Calendar] date 西暦日
+        #
+        # @return [Year] 改元後の年
+        #
+        def self.transfer(year:, date:)
+          multi_gengou = Calculation::Base::MultiGengouRoller.transfer(
+            multi_gengou: year.multi_gengou, date: date
+          )
+          Calculation::Base::Year.new(
+            multi_gengou: multi_gengou, new_year_date: year.new_year_date,
+            months: year.months, total_days: year.total_days
+          )
+        end
+        private_class_method :transfer
+
+        # :reek:TooManyStatements { max_statements: 7 }
+
+        #
+        # 月を特定する
+        #
+        # @param [Year] year 年
+        # @param [Western::Calendar] date 西暦日
+        #
+        # @return [Month] 対象月
+        #
+        def self.specify_month(year:, date:)
+          months = year.months
+
+          current_month = months[0]
+          months.each do |month|
+            return current_month if month.western_date > date
+
+            current_month = month
+          end
+
+          current_month
+        end
+        private_class_method :specify_month
+      end
+    end
+  end
+end

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

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require_relative '../../cycle/abstract_remainder'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Lunar
+      #
+      # AbstractLocation 入暦
+      #
+      class AbstractLocation
+        # @return [True] 計算済み（前回計算あり）
+        # @return [False] 未計算（初回計算）
+        attr_reader :calculated
+        # @return [Integer] 西暦年
+        attr_reader :western_year
+        # @return [Cycle::LunarRemainder] 大余小余（初回：昨年天正閏余）
+        attr_reader :remainder
+
+        #
+        # 初期化
+        #
+        # @param [Cycle::LunarRemainder] lunar_age 天正閏余（大余小余）
+        # @param [Integer] western_year 西暦年
+        #
+        def initialize(lunar_age:, western_year:)
+          @calculated = false
+          @western_year = western_year
+          @remainder = lunar_age
+        end
+
+        #
+        # 入暦を計算する
+        #
+        def run
+          # abstract
+        end
+
+        #
+        # 弦の分だけ月地点を進める
+        #
+        def add_quarter
+          # abstract
+        end
+
+        private
+
+        #
+        # 初回計算
+        #
+        def first
+          # abstract
+        end
+
+        #
+        # 大余小余に合わせて減算する（折り返す）
+        #
+        # @param [Cycle::LunarRemainder] limit 上限
+        #
+        def decrease(limit:)
+          # abstract
+        end
+
+        #
+        # 1始まりにする
+        #
+        def one_based
+          @remainder.add!(Cycle::AbstractRemainder.new(day: 1, minute: 0, second: 0))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative '../../type/old_float'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Lunar
+      #
+      # ChoukeiValue 再考長慶宣明暦算法
+      #
+      module ChoukeiValue
+        #
+        # 四捨五入した大余を返す
+        #
+        # @param [Integer] per 増減率
+        # @param [Integer] denominator 小余の分母
+        # @param [Integer] minute 小余
+        #
+        # @return [Integer] 累計値（大余）
+        #
+        def self.rounded_day(per:, denominator:, minute:)
+          remainder_minute = Type::OldFloat.new((per * minute).to_f)
+          day = day_only(remainder_minute: remainder_minute.get, denominator: denominator)
+          # 繰り上げ結果を足す
+          day += carried_minute(remainder_minute: remainder_minute, denominator: denominator)
+
+          day
+        end
+
+        def self.day_only(remainder_minute:, denominator:)
+          float_day = Type::OldFloat.new(remainder_minute / denominator)
+          # 切り捨て（プラスマイナスに関わらず小数点以下切り捨て）
+          float_day.floor!
+          float_day.get
+        end
+        private_class_method :day_only
+
+        def self.carried_minute(remainder_minute:, denominator:)
+          remainder_day = remainder_minute.abs % denominator
+          # 四捨五入（1/2日 以上なら繰り上げる）
+          return remainder_minute.sign if remainder_day >= (denominator / 2)
+
+          0
+        end
+        private_class_method :carried_minute
+      end
+    end
+  end
+end

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

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Solar
+      #
+      # AbstractAverage 平気（太陽軌道平均）
+      #
+      class AbstractAverage
+        #
+        # 初期化
+        #
+        # @param [Cycle::AbstractSolarTerm] solar_term 入定気
+        #
+        def initialize(solar_term:)
+          @solar_term = solar_term
+        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
+
+        # :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 [Cycle::AbstractRemainder] solar_term 二十四節気
+        # @param [Cycle::AbstractRemainder] current_month 月初
+        # @param [Cycle::AbstractRemainder] 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 = AbstractAverage.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/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