astronoby 0.7.0 → 0.8.0

data/lib/astronoby/cache.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+require "monitor"
+require "singleton"
+
+module Astronoby
+  class Cache
+    include Singleton
+
+    Entry = Struct.new(:key, :value, :prev, :next)
+
+    DEFAULT_MAX_SIZE = 10_000
+
+    attr_reader :max_size
+
+    # @param max_size [Integer] Maximum number of entries allowed in the cache
+    # @return [void]
+    def initialize(max_size = DEFAULT_MAX_SIZE)
+      @max_size = max_size
+      @hash = {}
+      @head = nil
+      @tail = nil
+      @mutex = Monitor.new
+    end
+
+    # @param key [Object] the cache key
+    # @return [Object, nil] the value, or nil if not found
+    def [](key)
+      @mutex.synchronize do
+        entry = @hash[key]
+        if entry
+          move_to_head(entry)
+          entry.value
+        end
+      end
+    end
+
+    # @param key [Object]
+    # @param value [Object]
+    # @return [Object] the value set
+    def []=(key, value)
+      @mutex.synchronize do
+        entry = @hash[key]
+        if entry
+          entry.value = value
+          move_to_head(entry)
+        else
+          entry = Entry.new(key, value)
+          add_to_head(entry)
+          @hash[key] = entry
+          evict_last_recently_used if @hash.size > @max_size
+        end
+      end
+    end
+
+    # @param key [Object]
+    # @yieldreturn [Object] Value to store if key is missing.
+    # @return [Object] Cached or computed value.
+    def fetch(key)
+      return self[key] if @mutex.synchronize { @hash.key?(key) }
+
+      value = yield
+
+      @mutex.synchronize do
+        self[key] = value unless @hash.key?(key)
+      end
+
+      value
+    end
+
+    # @return [void]
+    def clear
+      @mutex.synchronize do
+        @hash.clear
+        @head = @tail = nil
+      end
+    end
+
+    # @return [Integer]
+    def size
+      @mutex.synchronize { @hash.size }
+    end
+
+    # @param new_size [Integer] the new cache limit.
+    # @return [void]
+    def max_size=(new_size)
+      raise ArgumentError, "max_size must be positive" unless new_size > 0
+      @mutex.synchronize do
+        @max_size = new_size
+        while @hash.size > @max_size
+          evict_last_recently_used
+        end
+      end
+    end
+
+    private
+
+    def add_to_head(entry)
+      entry.prev = nil
+      entry.next = @head
+      @head.prev = entry if @head
+      @head = entry
+      @tail ||= entry
+    end
+
+    def move_to_head(entry)
+      return if @head == entry
+
+      # Unlink
+      entry.prev.next = entry.next if entry.prev
+      entry.next.prev = entry.prev if entry.next
+
+      # Update tail if needed
+      @tail = entry.prev if @tail == entry
+
+      # Insert as new head
+      entry.prev = nil
+      entry.next = @head
+      @head.prev = entry if @head
+      @head = entry
+    end
+
+    def evict_last_recently_used
+      if @tail
+        @hash.delete(@tail.key)
+        if @tail.prev
+          @tail = @tail.prev
+          @tail.next = nil
+        else
+          @head = @tail = nil
+        end
+      end
+    end
+  end
+
+  class NullCache
+    include Singleton
+
+    def [](key)
+      nil
+    end
+
+    def []=(key, value)
+      value
+    end
+
+    def fetch(key)
+      yield
+    end
+
+    def clear
+    end
+
+    def size
+      0
+    end
+
+    def max_size=(new_size)
+    end
+  end
+
+  class CacheKey
+    class << self
+      # Generate a cache key with appropriate precision
+      # @param type [Symbol] The calculation type (e.g., :geometric, :nutation)
+      # @param instant [Astronoby::Instant] The time instant
+      # @param components [Array] Additional components for the key
+      # @return [Array] The complete cache key
+      def generate(type, instant, *components)
+        return nil unless Astronoby.configuration.cache_enabled?
+
+        precision = Astronoby.configuration.cache_precision(type)
+        rounded_tt = round_terrestrial_time(instant.tt, precision)
+        [type, rounded_tt, *components]
+      end
+
+      # Round terrestrial time to specified precision
+      # @param tt [Numeric] Terrestrial time value
+      # @param precision [Numeric] Precision in seconds
+      # @return [Numeric] Rounded time value
+      def round_terrestrial_time(tt, precision)
+        return tt if precision <= 0
+
+        tt.round(precision)
+      end
+    end
+  end
+end

data/lib/astronoby/configuration.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Astronoby
+  class Configuration
+    DEFAULT_PRECISIONS = {
+      geometric: 9,        # 8.64e-5 seconds
+      nutation: 2,         # 864 seconds
+      precession: 2,       # 864 seconds
+      rise_transit_set: 5  # 0.1 seconds
+    }.freeze
+
+    attr_accessor :cache_enabled
+    attr_reader :cache_precisions
+
+    def initialize
+      @cache_enabled = false
+      @cache_precisions = DEFAULT_PRECISIONS.dup
+      @cache_instance = nil
+    end
+
+    # Configure cache precision for specific calculation types
+    # @param type [Symbol] The calculation type
+    # @param precision [Numeric] Precision in rounding of terrestrial time
+    # @return [Numeric] the precision for the given type
+    def cache_precision(type, precision = nil)
+      if precision.nil?
+        @cache_precisions[type] || DEFAULT_PRECISIONS[:geometric]
+      else
+        @cache_precisions[type] = precision
+      end
+    end
+
+    # Set all cache precisions at once
+    # @param precisions [Hash] Hash of calculation type to precision in rounding
+    #   of terrestrial time
+    # @return [void]
+    def cache_precisions=(precisions)
+      @cache_precisions = DEFAULT_PRECISIONS.merge(precisions)
+    end
+
+    # Get the cache instance (singleton or null cache)
+    # @return [Astronoby::Cache, Astronoby::NullCache] the cache instance
+    def cache
+      if cache_enabled?
+        Cache.instance
+      else
+        NullCache.instance
+      end
+    end
+
+    def cache_enabled?
+      @cache_enabled
+    end
+
+    # Reset cache instance (useful for testing or configuration changes)
+    # @return [void]
+    def reset_cache!
+      cache.clear
+    end
+  end
+
+  class << self
+    # Global configuration instance
+    # @return [Astronoby::Configuration] the global configuration instance
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Configuration block for setup
+    # @example
+    #   Astronoby.configure do |config|
+    #     config.cache_enabled = false
+    #     config.cache_precision(:geometric, 9)
+    #   end
+    def configure
+      yield(configuration)
+      configuration.reset_cache!
+    end
+
+    # Quick access to cache
+    # @return [Astronoby::Cache, Astronoby::NullCache] the cache instance
+    def cache
+      configuration.cache
+    end
+
+    # Reset configuration to defaults
+    # @return [void]
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+  end
+end

data/lib/astronoby/constants.rb

@@ -2,9 +2,12 @@
 
 module Astronoby
   class Constants
-    DAYS_PER_JULIAN_CENTURY = 36525.0
+    DAYS_PER_JULIAN_YEAR = 365.25
+    DAYS_PER_JULIAN_CENTURY = DAYS_PER_JULIAN_YEAR * 100
     DAYS_PER_JULIAN_MILLENIA = DAYS_PER_JULIAN_CENTURY * 10
 
+    TROPICAL_YEAR_AT_B1900 = 365.242198781
+
     HOURS_PER_DAY = 24.0
     DEGREES_PER_CIRCLE = 360.0
     RADIANS_PER_CIRCLE = 2 * Math::PI

data/lib/astronoby/constellation.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Astronoby
+  class Constellation
+    attr_reader :name, :abbreviation
+
+    def initialize(name, abbreviation)
+      @name = name
+      @abbreviation = abbreviation
+    end
+  end
+end

data/lib/astronoby/constellations/data.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Astronoby
+  module Constellations
+    class Data
+      def self.sorted_right_ascensions
+        @sorted_right_ascensions ||=
+          read_file("sorted_right_ascensions.dat").map(&:to_f)
+      end
+
+      def self.sorted_declinations
+        @sorted_declinations ||=
+          read_file("sorted_declinations.dat").map(&:to_f)
+      end
+
+      def self.radec_to_index
+        @radec_to_index ||=
+          read_file("radec_to_index.dat").map do |line|
+            line.split.map(&:to_i)
+          end
+      end
+
+      def self.indexed_abbreviations
+        @indexed_abbreviations ||=
+          read_file("indexed_abbreviations.dat")
+      end
+
+      def self.constellation_names
+        @constellation_names ||=
+          read_file("constellation_names.dat").map(&:split)
+      end
+
+      def self.read_file(filename)
+        File.readlines(data_path(filename)).map(&:strip)
+      end
+
+      def self.data_path(filename)
+        File.join(__dir__, "..", "data", "constellations", filename)
+      end
+    end
+  end
+end

data/lib/astronoby/constellations/finder.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Astronoby
+  module Constellations
+    class Finder
+      # Finds the constellation that contains the given B1875 equatorial
+      #   coordinates.
+      # @param equatorial_coordinates [Astronoby::Coordinates::Equatorial] The
+      #   B1875 coordinates to search for.
+      # @return [Astronoby::Constellation, nil] The constellation that contains
+      #   the coordinates, or nil if none is found.
+      def self.find(equatorial_coordinates)
+        ra_hours = equatorial_coordinates.right_ascension.hours
+        dec_degrees = equatorial_coordinates.declination.degrees
+        ra_index = Data
+          .sorted_right_ascensions
+          .bsearch_index { _1 >= ra_hours }
+        dec_index = Data
+          .sorted_declinations
+          .bsearch_index { _1 > dec_degrees }
+
+        return if ra_index.nil? || dec_index.nil?
+
+        abbreviation_index = Data.radec_to_index.dig(ra_index, dec_index)
+
+        return if abbreviation_index.nil?
+
+        constellation_abbreviation =
+          Data.indexed_abbreviations[abbreviation_index]
+
+        Repository.get(constellation_abbreviation)
+      end
+    end
+  end
+end

data/lib/astronoby/constellations/repository.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Astronoby
+  module Constellations
+    class Repository
+      # Returns a constellation object for the given abbreviation.
+      # @param abbreviation [String] The abbreviation of the constellation.
+      # @return [Astronoby::Constellation, nil] The constellation object or nil
+      #   if not found.
+      def self.get(abbreviation)
+        @constellations ||= Data.constellation_names.map do |abbr, name|
+          constellation = Constellation.new(name, abbr)
+          [abbr, constellation]
+        end.to_h
+
+        @constellations[abbreviation]
+      end
+    end
+  end
+end

data/lib/astronoby/coordinates/equatorial.rb

@@ -9,7 +9,7 @@ module Astronoby
         declination:,
         right_ascension:,
         hour_angle: nil,
-        epoch: Epoch::DEFAULT_EPOCH
+        epoch: JulianDate::DEFAULT_EPOCH
       )
         @right_ascension = right_ascension
         @declination = declination
@@ -82,8 +82,8 @@ module Astronoby
       #  Author: J. L. Lawrence
       #  Edition: MIT Press
       #  Chapter: 4 - Orbits and Coordinate Systems
-      def to_ecliptic(epoch:)
-        mean_obliquity = MeanObliquity.for_epoch(epoch)
+      def to_ecliptic(instant:)
+        mean_obliquity = MeanObliquity.at(instant)
 
         y = Angle.from_radians(
           @right_ascension.sin * mean_obliquity.cos +

data/lib/astronoby/data/constellations/constellation_names.dat

@@ -0,0 +1,88 @@
+And Andromeda
+Ant Antlia
+Aps Apus
+Aql Aquila
+Aqr Aquarius
+Ara Ara
+Ari Aries
+Aur Auriga
+Boo Boötes
+Cae Caelum
+Cam Camelopardalis
+Cap Capricornus
+Car Carina
+Cas Cassiopeia
+Cen Centaurus
+Cep Cepheus
+Cet Cetus
+Cha Chamaeleon
+Cir Circinus
+CMa Canis Major
+CMi Canis Minor
+Cnc Cancer
+Col Columba
+Com Coma Berenices
+CrA Corona Australis
+CrB Corona Borealis
+Crt Crater
+Cru Crux
+Crv Corvus
+CVn Canes Venatici
+Cyg Cygnus
+Del Delphinus
+Dor Dorado
+Dra Draco
+Equ Equuleus
+Eri Eridanus
+For Fornax
+Gem Gemini
+Gru Grus
+Her Hercules
+Hor Horologium
+Hya Hydra
+Hyi Hydrus
+Ind Indus
+Lac Lacerta
+Leo Leo
+Lep Lepus
+Lib Libra
+LMi Leo Minor
+Lup Lupus
+Lyn Lynx
+Lyr Lyra
+Men Mensa
+Mic Microscopium
+Mon Monoceros
+Mus Musca
+Nor Norma
+Oct Octans
+Oph Ophiuchus
+Ori Orion
+Pav Pavo
+Peg Pegasus
+Per Perseus
+Phe Phoenix
+Pic Pictor
+PsA Piscis Austrinus
+Psc Pisces
+Pup Puppis
+Pyx Pyxis
+Ret Reticulum
+Scl Sculptor
+Sco Scorpius
+Sct Scutum
+Ser Serpens
+Sex Sextans
+Sge Sagitta
+Sgr Sagittarius
+Tau Taurus
+Tel Telescopium
+TrA Triangulum Australe
+Tri Triangulum
+Tuc Tucana
+UMa Ursa Major
+UMi Ursa Minor
+Vel Vela
+Vir Virgo
+Vol Volans
+Vul Vulpecula

data/lib/astronoby/data/constellations/indexed_abbreviations.dat

@@ -0,0 +1,88 @@
+And
+Ant
+Aps
+Aql
+Aqr
+Ara
+Ari
+Aur
+Boo
+CMa
+CMi
+CVn
+Cae
+Cam
+Cap
+Car
+Cas
+Cen
+Cep
+Cet
+Cha
+Cir
+Cnc
+Col
+Com
+CrA
+CrB
+Crt
+Cru
+Crv
+Cyg
+Del
+Dor
+Dra
+Equ
+Eri
+For
+Gem
+Gru
+Her
+Hor
+Hya
+Hyi
+Ind
+LMi
+Lac
+Leo
+Lep
+Lib
+Lup
+Lyn
+Lyr
+Men
+Mic
+Mon
+Mus
+Nor
+Oct
+Oph
+Ori
+Pav
+Peg
+Per
+Phe
+Pic
+PsA
+Psc
+Pup
+Pyx
+Ret
+Scl
+Sco
+Sct
+Ser
+Sex
+Sge
+Sgr
+Tau
+Tel
+TrA
+Tri
+Tuc
+UMa
+UMi
+Vel
+Vir
+Vol
+Vul