@gkucmierz/utils 4.0.0 → 4.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gkucmierz/utils",
-  "version": "4.0.0",
+  "version": "4.0.2",
   "type": "module",
   "description": "Usefull functions for solving programming tasks",
   "keywords": [

package/src/automata/langtons-ant.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module automata
+ */
+
 /**
  * Creates an unlimited, dynamically expanding 2D grid using nested Maps.
  * Ideal for sparse matrices or algorithms operating on an infinite plane (e.g., Langton's Ant, Game of Life).

package/src/combinatorics/combinations.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module combinatorics
+ */
+
 /**
  * Generates all possible combinations of size n from a set of size k without repetition.
  * Yields arrays of indices representing the current combination.

package/src/combinatorics/gray-code.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module combinatorics
+ */
+
 /**
  * Internal logic for toggling bit state based on MSB progression.
  */

package/src/combinatorics/n-choose-k.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module combinatorics
+ */
+
 /**
  * Newton's formula (Binomial Coefficient) n choose k.
  * Evaluates the number of possible combinations.

package/src/combinatorics/permutations.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module combinatorics
+ */
+
 /**
  * Creates a permutations generator from a specified size or an array of elements.
  * 

package/src/data-structures/SetCnt.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module data-structures
+ */
+
 /**
  * Set-like data structure built using Map with elements counter.
  * Allows adding multiple occurrences of the same element.

package/src/data-structures/Trie.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module data-structures
+ */
+
 /**
  * Creates a Trie (prefix tree) data structure.
  * Implemented as a proper ES6 Class to fix prototyping documentation and encapsulate nodes.

package/src/data-structures/heap.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module data-structures
+ */
+
 /**
  * Creates a Min Heap data structure.
  * Implemented as a ES6 Class to fix prototyping documentation 

package/src/data-structures/list-node.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module data-structures
+ */
+
 
 
 /**

package/src/developer-utils/binary-search.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module developer-utils
+ */
+
 
 /**
  * Performs a binary search for an exact element in a sorted array.

package/src/developer-utils/consume-iterator.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module developer-utils
+ */
+
 /**
  * Consume iterator values asynchronously utilizing macro-task queue
  * to prevent Event Loop blocking.

package/src/developer-utils/get-type.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module developer-utils
+ */
+
 
 /**
  * Returns the type of the value as a lowercase string.

package/src/developer-utils/measure-performance.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module developer-utils
+ */
+
 /**
  * Measures the execution time of a given function by running it multiple times.
  * Useful for micro-benchmarking and performance comparison.

package/src/developer-utils/memoize.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module developer-utils
+ */
+
 
 /**
  * Creates a memoized version of a function.

package/src/developer-utils/natural-search.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module developer-utils
+ */
+
 /**
  * Natural Search Algorithm by gkucmierz
  * Mathematically finds the exponential boundary and binary searches bounds for a conditional function.

package/src/developer-utils/rand-normal.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module developer-utils
+ */
+
 /**
  * Generates a random number from a normal (Gaussian) distribution.
  * Uses the Box-Muller transform.

package/src/developer-utils/range-array.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module developer-utils
+ */
+
 
 // https://www.codewars.com/kata/57d83dfc950d842dcb00005b/train/javascript
 

package/src/developer-utils/set-safe-interval.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module developer-utils
+ */
+
 /**
  * A safe alternative to setInterval that uses recursive setTimeout.
  * It waits for the callback (even if it's async) to finish before scheduling the next tick,

package/src/geometry/barycentric.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module geometry
+ */
+
 /**
  * Calculates the barycentric coordinates of a 2D point P relative to a triangle ABC.
  * @param {Array<number>} p - Point [x, y]

package/src/geometry/math3d.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module geometry
+ */
+
 /**
  * Pure 3D Math Engine for Arcball/Trackball raw matrix transformations
  * @see {@link https://instacode.app/run/FASwtgDg9gTgLgAgN4IMYygZ0wBQwEwFdVEBfBAMwzAQCIABAcwGtiwQBTGALwHpC4IADaZaAbmDB0WXAWJwJQA|▶ Try it live in Instacode}

package/src/geometry/matrix.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module geometry
+ */
+
 
 
 /**

package/src/number-theory/egcd.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module number-theory
+ */
+
 
 /**
  * Extended Euclidean Algorithm.

package/src/number-theory/factors.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module number-theory
+ */
+
 
 /**
  * Calculates the prime factorization of a number.

package/src/number-theory/gcd.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module number-theory
+ */
+
 
 const getGCD = ZERO => {
   return (a, b) => {

package/src/number-theory/lcm.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module number-theory
+ */
+
 
 import {
   gcd,

package/src/number-theory/lucas-lehmer.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module number-theory
+ */
+
 /**
  * Calculates whether a given Mersenne number (2^p - 1) is prime using the Lucas-Lehmer primality test.
  * 

package/src/number-theory/mobius.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module number-theory
+ */
+
 import { factors, factorsBI } from './factors.mjs';
 
 /**

package/src/number-theory/mod.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module number-theory
+ */
+
 
 const getMod = ZERO => {
   return (dividend, divisor) => {

package/src/number-theory/phi.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module number-theory
+ */
+
 
 import {
   gcd,

package/src/number-theory/pow-mod.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module number-theory
+ */
+
 
 // implementation of power function with modulus like native python pow
 

package/src/number-theory/tonelli-shanks.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module number-theory
+ */
+
 
 import {
   powModBI,

package/src/optimization/nelder-mead.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module optimization
+ */
+
 /**
  * Nelder-Mead Simplex Algorithm (Direct Search Gradient-Free Optimization)
  * Maximizes continuous N-dimensional spaces through contraction and expansion.

package/src/optimization/particle-swarm.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module optimization
+ */
+
 /**
  * Particle Swarm Optimization (PSO)
  * A stochastic, population-based metaheuristic for maximizing complex multidimensional bounds.

package/src/optimization/simulated-annealing.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module optimization
+ */
+
 /**
  * Simulated Annealing (Derivative-Free Stochastic Optimization)
  * Maximizes the evaluate function payload.

package/src/sequences/golden-ratio.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module sequences
+ */
+
 import { squareRootBI } from './square-root.mjs';
 
 /**

package/src/sequences/gpn.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module sequences
+ */
+
 
 // Generalized pentagonal numbers
 // https://oeis.org/A001318

package/src/sequences/herons-formula.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module sequences
+ */
+
 
 import {
   squareRootBI,

package/src/sequences/square-root.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module sequences
+ */
+
 
 
 /**

package/src/string-arrays/array-histogram.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module string-arrays
+ */
+
 /**
  * Generates a Map with unique elements and their occurring frequencies.
  * Transforms an array into a Map of (key -> quantity) using an optional mapping callback.

package/src/string-arrays/base64.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module string-arrays
+ */
+
 
 /**
  * Encodes a string to Base64.

package/src/string-arrays/bijective-numeration.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module string-arrays
+ */
+
 
 /**
  * Converts a number to a bijective base-k string.

package/src/string-arrays/chunks.mjs

@@ -1,3 +1,8 @@
+/**
+ * @module string-arrays
+ * @see {@link https://instacode.app/run/FASwtgDg9gTgLgAgN4IMYAsCuA7A1gZwQF8EAzGKMBAIgAEBzXTVMEAUxgC8B6TOEADb5qAbmDAMOAmKA|▶ Try it live in Instacode}
+ */
+
 export const chunks = (input, size = 1) => {
   if (size < 1) size = 1;
   

package/src/string-arrays/copy-case.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module string-arrays
+ */
+
 
 /**
  * Copies the case pattern from one string to another.

package/src/string-arrays/format-big-number.mjs

@@ -1,3 +1,7 @@
+/**
+ * @module string-arrays
+ */
+
 
 /**
  * Formats a BigNumber, Number or string representation of a number
@@ -11,7 +15,7 @@
 const formatBigNumberBoth = (num, separator = '', wrapFn = _ => _) => {
   const str = String(num);
   const rev = [...str].reverse().join('');
-  const match = rev.match(/(\d*\.\-?)|(\d{3}\-?)|(\d{1,3}\-?)|(\-)/g);
+  const match = rev.match(/(\d*\.[+-]?)|(\d{3}[+-]?)|(\d{1,3}[+-]?)|([+-])/g);
   const revInside = (match && match.join('') === rev)
     ? match.map(part => [...part].reverse().join(''))
     : [str];
@@ -41,6 +45,13 @@ export const formatBigNumber = formatBigNumberBoth;
  */
 export const formatBigNumberBI = formatBigNumberBoth;
 
+/**
+ * Creates an alternating span wrapper function for number segments with 'even' and 'odd' classes.
+ * Useful for syntax highlighting or alternating styles of formatted number segments.
+ *
+ * @returns {function(string): string} A wrapper callback function for number segments.
+ * @see {@link https://instacode.app/run/FASwtgDg9gTgLgAgN4IO4wIYQGIDsEC+CAZjFGAgEQACA5gNYCuAxmCAKYwBeA9I3CAA2AZ0oBuYMHRY8EoA|▶ Try it live in Instacode}
+ */
 export const wrapFn = () => {
   let even = true;
   return part => {
@@ -49,3 +60,4 @@ export const wrapFn = () => {
     return `<span class="${cls}">${part}</span>`;
   };
 };
+