smath 1.1.4 → 1.1.6

package/README.md

@@ -1,6 +1,36 @@
+<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
+
+[Docs](https://npm.nicfv.com/smath/) | [GitHub](https://github.com/nicfv/npm/tree/main/smath/) | [npm](https://www.npmjs.com/package/smath) | [Changelog](https://github.com/nicfv/npm/blob/main/smath//CHANGELOG.md) | Small math function library
+
+![NPM Downloads](https://img.shields.io/npm/dt/smath)
+![NPM Version](https://img.shields.io/npm/v/smath)
+![Relative date](https://img.shields.io/date/1710877538)
+![GitHub watchers](https://img.shields.io/github/watchers/nicfv/npm)
+![GitHub forks](https://img.shields.io/github/forks/nicfv/npm)
+![GitHub Repo stars](https://img.shields.io/github/stars/nicfv/npm)
+
+## Installation
+
+smath can be installed from the official [npm package repository](https://www.npmjs.com/package/smath). It is highly recommended to install the latest version, which is installed by default with the following command.
+
+```shell
+npm i smath@1.1.6
+```
+
+## Bugs and Requests
+
+Is there a way we can make smath better? Please report all bugs, issues, and new feature requests to the [issues](https://github.com/nicfv/npm/issues) page in the [official repository](https://github.com/nicfv/npm). For critical security issues, please send an email to <smath@nicolasventura.com>.
+
+## Contribute
+
+Thank you for your interest in contributing to smath! smath is an open source software package maintained by Nicolas Ventura ([@nicfv](https://github.com/nicfv)) and built by users like you! You are allowed to fork the repository as permitted by the [MIT License](https://raw.githubusercontent.com/nicfv/npm/main/LICENSE) terms. Contributions are welcome by submitting a [pull request](https://github.com/nicfv/npm/pulls). Please follow the existing code styling if submitting a pull request. Thank you for your consideration!
 ## Getting Started
 
-**Example:** A temperature conversion tool using [`SMath.translate`](https://npm.nicfv.com/smath/classes/SMath.html#translate) to convert units and [`SMath.approx`](https://npm.nicfv.com/smath/classes/SMath.html#approx) to validate the result. The translation uses freezing and boiling points for 2 unit systems to linearly interpolate between them.
+Similar to JavaScript's builtin [`Math`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math) object, `SMath` exports one global object with several math-related helper functions. There is no need to instantiate the class, just call functions directly. See the examples below to get started using SMath!
+
+## Example
+
+A temperature conversion tool using [`SMath.translate`](https://npm.nicfv.com/smath/classes/SMath.html#translate) to convert units and [`SMath.approx`](https://npm.nicfv.com/smath/classes/SMath.html#approx) to validate the result. The translation uses freezing and boiling points for 2 unit systems to linearly interpolate between them.
 
 ```js
 import { SMath } from 'smath';

package/dist/index.js

@@ -4,6 +4,13 @@ exports.SMath = void 0;
 var SMath = (function () {
     function SMath() {
     }
+    SMath.avg = function () {
+        var n = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            n[_i] = arguments[_i];
+        }
+        return n.reduce(function (prev, curr) { return prev + curr; }) / n.length;
+    };
     SMath.clamp = function (n, min, max) {
         if (n < min) {
             return min;
@@ -29,6 +36,16 @@ var SMath = (function () {
     SMath.translate = function (n, min1, max1, min2, max2) {
         return this.expand(this.normalize(n, min1, max1), min2, max2);
     };
+    SMath.linspace = function (min, max, count) {
+        var space = [];
+        for (var i = 0; i < count; i++) {
+            space[i] = this.translate(i, 0, count - 1, min, max);
+        }
+        return space;
+    };
+    SMath.logspace = function (min, max, count) {
+        return this.linspace(min, max, count).map(function (n) { return Math.pow(10, n); });
+    };
     return SMath;
 }());
 exports.SMath = SMath;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "smath",
-  "version": "1.1.4",
+  "version": "1.1.6",
   "description": "Small math function library",
   "homepage": "https://npm.nicfv.com/smath",
   "main": "dist/index.js",
@@ -24,10 +24,15 @@
     "library",
     "simple",
     "number",
+    "avg",
+    "average",
+    "mean",
     "interpolate",
     "interpolation",
     "extrapolate",
-    "extrapolation"
+    "extrapolation",
+    "linspace",
+    "logspace"
   ],
   "author": {
     "name": "Nicolas Ventura",

package/types/index.d.ts

@@ -9,6 +9,16 @@
  * useful interpolation and extrapolation functions.
  */
 export declare abstract class SMath {
+    /**
+     * Compute the average, or mean, of a set of numbers.
+     * @param n Any amount of numeric inputs
+     * @returns The average, or mean
+     * @example
+     * ```js
+     * const mean = SMath.avg(1, 2, 3, 4); // 2.5
+     * ```
+     */
+    static avg(...n: Array<number>): number;
     /**
      * Clamp a number within a range.
      * @param n The number to clamp
@@ -74,4 +84,30 @@ export declare abstract class SMath {
      * ```
      */
     static translate(n: number, min1: number, max1: number, min2: number, max2: number): number;
+    /**
+     * Generate an array of linearly spaced numbers.
+     * @param min The initial value of the linear space
+     * @param max The final value of the linear space
+     * @param count The number of values in the space
+     * @returns The linear space as an array of numbers
+     * @example
+     * ```js
+     * const space = SMath.linspace(1, 5, 6);
+     * // [ 1, 1.8, 2.6, 3.4, 4.2, 5 ]
+     * ```
+     */
+    static linspace(min: number, max: number, count: number): Array<number>;
+    /**
+     * Generate an array of logarithmically spaced numbers.
+     * @param min The initial magnitude of the space
+     * @param max The final magnitude of the space
+     * @param count The number of values in the space
+     * @returns The logarithmic space as an array of numbers
+     * @example
+     * ```js
+     * const space = SMath.logspace(0, 2, 5);
+     * // [ 1, 3.2, 10, 31.6, 100 ]
+     * ```
+     */
+    static logspace(min: number, max: number, count: number): Array<number>;
 }