bias-random 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# bias-random
+
+## 1.0.0
+
+### Major Changes
+
+- 9cb1dc7: Initial release. Main export function generates random biased numbers, with options for:
+  - Degree of bias
+  - Upper vs lower bias
+  - Minimum and maximum values

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Reid Moffat
+
+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.

package/README.md

@@ -0,0 +1,35 @@
+# bias-random
+
+[![npm](https://img.shields.io/npm/v/bias-random)](https://www.npmjs.com/package/bias-random)
+[![npm](https://img.shields.io/npm/dt/bias-random)](https://www.npmjs.com/package/bias-random)
+[![npm](https://img.shields.io/npm/l/bias-random)](https://www.npmjs.com/package/bias-random)
+
+Generates biased random numbers with a customizable bias level, direction, and range
+
+## 📦 Installation
+
+```bash
+npm install bias-random
+
+# or
+yarn add install bias-random
+
+# or
+pnpm install bias-random
+```
+
+## 🚀 Usage
+
+```ts
+import biasedRandom from "bias-random";
+
+// Default settings:
+// -Bias towards lower numbers
+// -Bias level of 2
+// -Range 0 to 1
+// Average resulting value will be 1/3
+const defaultResult = biasRandom();
+
+// Cutomize the parmeters (all parameters are optional, defaulting to the values above)
+const customResult = biasRandom({ upperBias: true, biasLevel: 4, min: 10, max: 1000 });
+```

package/dist/index.cjs

@@ -0,0 +1 @@
+"use strict";var n=Object.defineProperty;var u=Object.getOwnPropertyDescriptor;var i=Object.getOwnPropertyNames;var s=Object.prototype.hasOwnProperty;var m=(a,e)=>{for(var r in e)n(a,r,{get:e[r],enumerable:!0})},l=(a,e,r,t)=>{if(e&&typeof e=="object"||typeof e=="function")for(let o of i(e))!s.call(a,o)&&o!==r&&n(a,o,{get:()=>e[o],enumerable:!(t=u(e,o))||t.enumerable});return a};var b=a=>l(n({},"__esModule",{value:!0}),a);var d={};m(d,{default:()=>f});module.exports=b(d);var p=({upperBias:a=!1,biasLevel:e=2,min:r=0,max:t=1}={})=>{if(typeof e!="number"||e<1)throw new TypeError(`Parameter 'biasLevel' must be a number least 1 (value: ${e}); use upperBias to swap bias direction`);if(typeof r!="number"||typeof t!="number"||r>=t)throw new TypeError(`Parameter 'min' muist be less than 'max' (you can flip them for a valid result). Min value: ${r} Max value: ${t}`);if(typeof a!="boolean")throw new TypeError(`Parameter 'upperBias' must be a boolean, value '${a}' is invalid`);let o=Math.pow(Math.random(),e);return a&&(o=1-o),r+o*(t-r)},f=p;

package/dist/index.d.cts

@@ -0,0 +1,20 @@
+interface BiasedRandomOptions {
+    upperBias?: boolean;
+    biasLevel?: number;
+    min?: number;
+    max?: number;
+}
+/**
+ * Generates a random number, biased towards lower or higher numbers with the level of your choice
+ *
+ * @param upperBias Set to true to bias this towards higher numbers instead of lower numbers. E.g. with a range of 0
+ * to 1, a biasLevel of 2, the average value would be 2/3 (1 - (1 / 3))
+ * @param biasLevel How strongly the bias is, default 2. The resulting values have an average value of 1 / (biasLevel
+ * + 1) (given upperBias = false and a range of 0 to 1). Can be a decimal number, but must be at least 1 (for less than
+ * 1, this is equivalent to using an upperBias, e.g. a bias of 0.5 is the same as an upper bias of 2)
+ * @param min Minimum value of the result, default 0. This scales the result, but keeps the relative bias
+ * @param max Maximum value of the result, default 1. This scales the result, but keeps the relative bias
+ */
+declare const biasedRandom: ({ upperBias, biasLevel, min, max }?: BiasedRandomOptions) => number;
+
+export { biasedRandom as default };

package/dist/index.d.ts

@@ -0,0 +1,20 @@
+interface BiasedRandomOptions {
+    upperBias?: boolean;
+    biasLevel?: number;
+    min?: number;
+    max?: number;
+}
+/**
+ * Generates a random number, biased towards lower or higher numbers with the level of your choice
+ *
+ * @param upperBias Set to true to bias this towards higher numbers instead of lower numbers. E.g. with a range of 0
+ * to 1, a biasLevel of 2, the average value would be 2/3 (1 - (1 / 3))
+ * @param biasLevel How strongly the bias is, default 2. The resulting values have an average value of 1 / (biasLevel
+ * + 1) (given upperBias = false and a range of 0 to 1). Can be a decimal number, but must be at least 1 (for less than
+ * 1, this is equivalent to using an upperBias, e.g. a bias of 0.5 is the same as an upper bias of 2)
+ * @param min Minimum value of the result, default 0. This scales the result, but keeps the relative bias
+ * @param max Maximum value of the result, default 1. This scales the result, but keeps the relative bias
+ */
+declare const biasedRandom: ({ upperBias, biasLevel, min, max }?: BiasedRandomOptions) => number;
+
+export { biasedRandom as default };

package/dist/index.js

@@ -0,0 +1 @@
+var n=({upperBias:o=!1,biasLevel:a=2,min:e=0,max:r=1}={})=>{if(typeof a!="number"||a<1)throw new TypeError(`Parameter 'biasLevel' must be a number least 1 (value: ${a}); use upperBias to swap bias direction`);if(typeof e!="number"||typeof r!="number"||e>=r)throw new TypeError(`Parameter 'min' muist be less than 'max' (you can flip them for a valid result). Min value: ${e} Max value: ${r}`);if(typeof o!="boolean")throw new TypeError(`Parameter 'upperBias' must be a boolean, value '${o}' is invalid`);let t=Math.pow(Math.random(),a);return o&&(t=1-t),e+t*(r-e)},u=n;export{u as default};

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "bias-random",
+  "version": "1.0.0",
+  "description": "Generates biased random numbers with a customizable bias level, direction, and range",
+  "author": "Reid Moffat <reid.moffat9@gmail.com>",
+  "license": "MIT",
+  "keywords": [
+    "random",
+    "bias",
+    "biased",
+    "random-bias",
+    "weighted-random",
+    "probability",
+    "skewed-random",
+    "biased-numbers",
+    "random-distribution",
+    "random-skew",
+    "weighted-numbers",
+    "probability-distribution",
+    "random-bias-generator",
+    "custom-distribution",
+    "random-number-generator",
+    "rng",
+    "biased-probability",
+    "skewed-distribution"
+  ],
+  "type": "module",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "lint": "tsc",
+    "test": "cross-env TS_NODE_PROJECT='./tsconfig.json' mocha --ui tdd",
+    "build": "tsup src/index.ts --format cjs,esm --dts --minify",
+    "deployHelp": "echo 1) Run 'changeset' 2) Merge changes to main 3) Merge changeset PR 4) npm run deploy (verify it looks good)",
+    "deploy": "git checkout main && git pull && npm run build && npm publish"
+  },
+  "files": [
+    "CHANGELOG.md",
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/reid-moffat/bias-random"
+  },
+  "bugs": "https://github.com/reid-moffat/bias-random/issues",
+  "devDependencies": {
+    "@changesets/cli": "^2.27.8",
+    "@types/chai": "^4.3.19",
+    "@types/mocha": "^10.0.8",
+    "@types/node": "^22.6.1",
+    "chai": "^5.1.1",
+    "cross-env": "^7.0.3",
+    "generate-arrays": "^2.0.0",
+    "mocha": "^10.7.3",
+    "suite-metrics": "^1.3.1",
+    "ts-node": "^10.9.2",
+    "tsup": "^8.3.0",
+    "typescript": "^5.6.2"
+  }
+}