figurate_numbers 1.4.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f88663fb4b29da717f010c1f0316c6f43b84742bf90149c988f280af9642696
-  data.tar.gz: f96d3430868d3aa1e7fa9152586c90eb83cda937f6d2a3c87434cfdd4fe13241
+  metadata.gz: a286c4ec17f817140054ae0c0b0aba3b3b7f8a47204fb4813eba687f6e1cba15
+  data.tar.gz: 85f689294ce5b0e7fc30a06ba001cb7dda5d8fb70bbcfa92e5e5ecc249540607
 SHA512:
-  metadata.gz: 725f757198c2c298a12331410c98bcf1a6c001675c9fc8f6244f0dec7023bba66f88a05eaaa2bae4e97edb9f08992ec168cf8fc660dafcd0ddd82ebbd37c9fa3
-  data.tar.gz: 62e57fdb8abf8546e6f5cca8c97eee63fbc9d9acba3f86299fed7619e75a97817c5de6dfdabea91927765f24557fa41df9c9797388969c2d9771177e7c914410
+  metadata.gz: c9ca9a1809ea6760cf8e2d6bcfead0eabc270bcfc2678e8c891921376514405d32d59e90a1187b4143e983f865765d9cfe258df736b93630189dbd695fabea1e
+  data.tar.gz: bacbbc4997f8da85f48962149a9b118bd1f857843c41d0a43e085560540ac4770b3ed10439758e7214e14007643bd05ac7a919d3fcfe58c9d668e610e584c91c

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Edgar Armando Delgado Vega
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/docs/ERRATA.md

@@ -1,4 +1,4 @@
-## Errata
+# Errata
 
 - **Chapter 1, page 6:**
   The formula for *Square* in the table is given as:

data/docs/METHODS.md

@@ -1,10 +1,11 @@
-# List of Implemented Sequences in `figurate_numbers`
+# List of Sequences in `figurate_numbers` and Arithmetic Transformations Methods
 
 ### Table of Contents
 - 🟦 [Plane Figurate Numbers](#1-plane-figurate-numbers)
 - 🟥 [Space Figurate Numbers](#2-space-figurate-numbers)
 - 🟨 [Multidimensional Figurate Numbers](#3-multidimensional-figurate-numbers)
-- 🧬 [Zoo of figurate-related numbers](#6-zoo-of-figurate-related-numbers)
+- 🧬 [Zoo of figurate-related numbers](#4-zoo-of-figurate-related-numbers)
+- ⚙️ [Arithmetic Transformations](#5-arithmetic-transformations)
 
 > Note that `=` means that you can call the same sequence with different names.
 
@@ -252,7 +253,7 @@
 69. `generalized_k_dimensional_centered_hyperoctahedron(k, left_index = 0)[provisional symmetry]`
 70. `generalized_nexus(k, left_index = 0) [even or odd dimension only changes sign]`
 
-### 6. Zoo of figurate-related numbers
+### 4. Zoo of figurate-related numbers
 
 1. `cuban_numbers = cuban_prime_numbers`
 2. `quartan_numbers [Needs to improve the algorithmic complexity for n > 70]`
@@ -260,3 +261,14 @@
 4. `carmichael_numbers [Needs to improve the algorithmic complexity for n > 20]`
 4. `stern_prime_numbers(infty = false) [Quick calculations up to 8 terms]`
 5. `apocalyptic_numbers`
+
+### 5. Arithmetic Transformations
+
+1. `ArithTransform.n_residue(n, pow, mod)`
+2. `ArithTransform.pc_inversion(n, mod)`
+3. `ArithTransform.padic_val(n, p)`
+4. `ArithTransform.ring_padic_val(seq, p)`
+5. `ArithTransform.padic_norm(n, p)`
+6. `ArithTransform.ring_padic_norm(seq, p)`
+7. `ArithTransform.padic_expansion(n, p, precision = 11, reverse: false)`
+8. `ArithTransform.ring_padic_expansion(seq, p, precision = 11, reverse: false)`

data/lib/figurate_numbers/arith_transform.rb

@@ -0,0 +1,47 @@
+require_relative './utils/padic_utils'
+require_relative './utils/modn_utils'
+
+module FigurateNumbers
+  # Provides arithmetic methods for transforming and analyzing figurate number sequences.
+  module ArithTransform
+    extend self
+
+    def n_residue(n, pow, mod)
+      ModNUtils.q_residues(n, pow, mod)
+    end
+
+    def pc_inversion(n, mod)
+      ModNUtils.inversion(n, mod)
+    end
+
+    def padic_val(n, p)
+      PAdicUtils.padic_valuation(n, p)
+    end
+
+    def ring_padic_val(seq, p)
+      seq.map do |delta|
+        PAdicUtils.padic_valuation(delta, p)
+      end
+    end
+
+    def padic_norm(n, p)
+      PAdicUtils.padic_norm(n, p)
+    end
+
+    def ring_padic_norm(seq, p)
+      seq.map do |delta|
+        PAdicUtils.padic_norm(delta, p)
+      end
+    end
+
+    def padic_expansion(n, p, precision = 11, reverse: false)
+      PAdicUtils.padic_expansion(n, p, precision, reverse)
+    end
+
+    def ring_padic_expansion(seq, p, precision = 11, reverse: false)
+      seq.map do |delta|
+        PAdicUtils.padic_expansion(delta, p, precision, reverse)
+      end
+    end
+  end
+end

data/lib/figurate_numbers/utils/modn_utils.rb

@@ -0,0 +1,23 @@
+module FigurateNumbers
+  # Provides modular arithmetic methods (mod n) for transforming figurate number sequences.
+  module ModNUtils
+    extend self
+
+    def n_power(n, power)
+      n.pow(power)
+    end
+
+    def mod_reduc(n, mod)
+      n % mod
+    end
+
+    def q_residues(n, power, mod)
+      mod_reduc(n_power(n, power), mod)
+    end
+
+    def inversion(n, mod)
+      inv = n * -1
+      mod_reduc(inv, mod)
+    end
+  end
+end

data/lib/figurate_numbers/utils/padic_utils.rb

@@ -0,0 +1,54 @@
+require 'prime'
+
+module FigurateNumbers
+  # Module providing p-adic methods for transforming
+  # sequences of figurate numbers.
+  module PAdicUtils
+    extend self
+
+    def padic_valuation(base_ten_number, p)
+      raise "#{p} is not a prime number" unless Prime.prime?(p)
+
+      index = 0
+      return index if base_ten_number < 1
+
+      while base_ten_number % (p**index) == 0 # rubocop:disable Style/NumericPredicate,Style/WhileUntilModifier
+        index += 1
+      end
+      index - 1
+    end
+
+    def padic_norm(base_ten_number, p)
+      return 0 if base_ten_number == 0 # rubocop:disable Style/NumericPredicate
+
+      power = padic_valuation(base_ten_number, p)
+      1.0 / p**power
+    end
+
+    def padic_expansion(base_ten_number, p, precision = 11, reverse_trim = false) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength,Style/OptionalBooleanParameter
+      inverse_limit_arr = []
+      (1...precision).each do |index|
+        power = p**index
+        inverse_limits = ((base_ten_number % power) + power) % power
+        inverse_limit_arr << inverse_limits
+      end
+      p_adic_expansion_array = [inverse_limit_arr[0]]
+
+      (0...(precision - 2)).each do |index|
+        a1 = inverse_limit_arr[index + 1]
+        a0 = inverse_limit_arr[index]
+        power = p**(index + 1)
+        digits = (a1 - a0) / power
+        p_adic_expansion_array << digits
+      end
+
+      if reverse_trim
+        reversed = p_adic_expansion_array.reverse
+        first_nonzero_index = reversed.index { |digit| digit != 0 } || 0
+        reversed[first_nonzero_index..-1]
+      else
+        p_adic_expansion_array
+      end
+    end
+  end
+end

data/lib/figurate_numbers/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FigurateNumbers
-  VERSION = '1.4.2'
+  VERSION = '1.5.0'
 end

data/lib/figurate_numbers.rb

@@ -2,13 +2,16 @@ require_relative 'figurate_numbers/version'
 require_relative 'figurate_numbers/plane_figurate_numbers'
 require_relative 'figurate_numbers/space_figurate_numbers'
 require_relative 'figurate_numbers/multidimensional_figurate_numbers'
+require_relative 'figurate_numbers/arith_transform'
 
 module FigurateNumbers
   extend PlaneFigurateNumbers
   extend SpaceFigurateNumbers
   extend MultiDimensionalFigurateNumbers
+  extend ArithTransform
 end
 
 PlaneFigurateNumbers = FigurateNumbers::PlaneFigurateNumbers
 SpaceFigurateNumbers = FigurateNumbers::SpaceFigurateNumbers
 MultiDimensionalFigurateNumbers = FigurateNumbers::MultiDimensionalFigurateNumbers
+ArithTransform = FigurateNumbers::ArithTransform

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: figurate_numbers
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.5.0
 platform: ruby
 authors:
 - Edgar Armando Delgado Vega
@@ -18,25 +18,27 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.md
+- "./LICENSE"
 - docs/ERRATA.md
 - docs/METHODS.md
 files:
-- README.md
+- "./LICENSE"
 - docs/ERRATA.md
 - docs/METHODS.md
 - lib/figurate_numbers.rb
+- lib/figurate_numbers/arith_transform.rb
 - lib/figurate_numbers/multidimensional_figurate_numbers.rb
-- lib/figurate_numbers/p_adic_utils/p_adic_utils.rb
 - lib/figurate_numbers/plane_figurate_numbers.rb
 - lib/figurate_numbers/space_figurate_numbers.rb
+- lib/figurate_numbers/utils/modn_utils.rb
+- lib/figurate_numbers/utils/padic_utils.rb
 - lib/figurate_numbers/utils/utils.rb
 - lib/figurate_numbers/version.rb
 homepage: https://github.com/edelveart/figurate_numbers
 licenses:
 - MIT
 metadata:
-  documentation_uri: https://www.rubydoc.info/gems/figurate_numbers
+  documentation_uri: https://www.rubydoc.info/gems/figurate_numbers/
   source_code_uri: https://github.com/edelveart/figurate_numbers/
   homepage_uri: https://github.com/edelveart/figurate_numbers
 rdoc_options:

data/README.md

@@ -1,92 +0,0 @@
-<h1 align="center"> Figurate Numbers </h1>
-
-**Figurate Numbers** is the most comprehensive and specialized library for figurate numbers, developed in Ruby to date.
-It implements **241 infinite number sequences** inspired by the groundbreaking work [*Figurate Numbers*](https://books.google.com.pe/books/about/Figurate_Numbers.html?id=ERS7CgAAQBAJ&redir_esc=y) by Elena Deza and Michel Deza, published in 2012.
-
-<p align="center">
-  <img src="https://img.shields.io/gem/v/figurate_numbers" alt="Gem Version">
-  <img src="https://img.shields.io/gem/dt/figurate_numbers" alt="Gem Total Downloads">
-  <img src="https://img.shields.io/github/stars/edelveart/figurate_numbers" alt="GitHub Repo stars">
-    <img src="https://img.shields.io/github/license/edelveart/figurate_numbers" alt="GitHub License">
-</p>
-
-[![figurate numbers image](https://raw.githubusercontent.com/edelveart/figurate_numbers/main/figurate_numbers.png)](https://rubygems.org/gems/figurate_numbers)
-
-
-## 💎 Installation
-
-Install it from the gem repository:
-
-```rb
-gem install figurate_numbers
-```
-
-## 🧊 Features
-
-Figurate Numbers implements 241 infinite sequences using the Enumerator class in Ruby, each categorized by its geometric dimension. It is ideal for use in mathematical modeling, algorithmic composition, and integration with tools like Sonic Pi.
-
-The sequences are organized following the structure of the *Figurate Numbers* book:
-
--  🟦 **PlaneFigurateNumbers** – 79 sequences (2D)
--  🟥 **SpaceFigurateNumbers** – 86 sequences (3D)
--  🟨 **MultiDimensionalFigurateNumbers** – 70 sequences (4D and beyond)
--  🧬 **Zoo of figurate-related numbers** – 6 additional sequences *(included in the MultiDimensional module)*
-
-> 📚 Explore the detailed list of figurate numbers [here 🔍.](docs/METHODS.md)
-
-##  🧰 How to use in Ruby
-
-```rb
-require 'figurate_numbers'
-
-## Using take(integer)
-FigurateNumbers.pentatope.take(10)
-
-## Storing and iterating
-f = FigurateNumbers.centered_octagonal_pyramid
-f.next
-f.next
-f.next
-```
-
-Starting with version **1.4.0**, you can also call methods directly from their respective classes. This allows you to work with figurate numbers grouped by their geometric dimension:
-
-```rb
-PlaneFigurateNumbers.polygonal(3)
-SpaceFigurateNumbers.rhombic_dodecahedral
-MultiDimensionalFigurateNumbers.six_dimensional_hyperoctahedron
-```
-
-## 🎶 How to use in Sonic Pi
-
-### Version 1.4.0
-
-Starting from version **1.4.0**, you can use the library globally through `FigurateNumbers`to access all sequences, or you can use the specific classes mentioned above for separate access.
-The main change compared to version **1.3.0** is that you now need to import the file using **require** instead of **run_file**; otherwise, it will not function.
-
-```rb
-require "<PATH>"
-pol_num = FigurateNumbers.polygonal(8)
-350.times do
-  play pol_num.next % 12 * 7  # Some mathematical function or transformation
-  sleep 0.125
-end
-```
-
-Simply copy the entry point path from the `lib/figurate_numbers.rb` file where the *gem* is installed.
-
-### Version 1.3.0 (legacy)
-
-See discussion in the [**Sonic Pi community thread right here!**](https://in-thread.sonic-pi.net/t/figurate-numbers-for-sonic-pi-new-ruby-gem-for-infinite-number-sequences-and-patterns/8962)
-
-## 📚 List of Implemented Sequences in `figurate_numbers`
-
-Explore the complete list of figurate number sequences and their Ruby methods:
-
-- [View all implemented methods and sequences 🔍](docs/METHODS.md)
-
-## 📝 Book Errata
-
-Corrections to formulas and data found in *Figurate Numbers* (2012):
-
-- [See full list of known errata 🔍](docs/ERRATA.md)

data/lib/figurate_numbers/p_adic_utils/p_adic_utils.rb

@@ -1,27 +0,0 @@
-# module PAdicUtils
-#   def self.potence(exponent)
-#     # Este método modificará el arreglo de números aplicando la potencia
-#     map { |num| num**exponent }
-#   end
-#  def self.p_adic_valuation(base_ten_number, base_p_number)
-#     m = 0
-#     return m if base_ten_number < 1
-#     while base_ten_number % (base_p_number ** m) == 0
-#       m += 1
-#     end
-#     m - 1
-#   end
-
-#   def self.to_p_adic_valuation(arr, p)
-#     arr.lazy.collect { |fignum| p_adic_valuation(fignum, p) }
-#   end
-# end
-
-
-# puts PAdicUtils.p_adic_valuation(96, 2)
-# # export const pAdicValuation = (baseTenNumber: number, baseNumber: number): number => {
-# #     let index = 0;
-# #     if (baseTenNumber < 1) return index;
-# #     while (baseTenNumber % (baseNumber ** index) === 0) index++;
-# #     return index - 1;
-# # }