robonen/tools
1
0
Fork 0
mirror of https://github.com/robonen/tools.git synced 2026-03-20 10:54:44 +00:00
Code Releases Activity

refactor(packages/stdlib): add comments for math utils

Browse Source
This commit is contained in:
Andrew Robonen
2024-04-11 00:10:52 +07:00
parent e9b8b0c78d
commit 65ba312f4c
2 changed files with 11 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
packages/stdlib/src/math/clamp/index.ts
View File

@@ -7,5 +7,10 @@
* @returns {number} The clamped number * @returns {number} The clamped number
*/ */
export function clamp(value: number, min: number, max: number): number { export function clamp(value: number, min: number, max: number): number {
// The clamp function takes a value, a minimum, and a maximum as parameters.
// It ensures that the value falls within the range defined by the minimum and maximum values.
// If the value is less than the minimum, it returns the minimum value.
// If the value is greater than the maximum, it returns the maximum value.
// Otherwise, it returns the original value.
return Math.min(Math.max(value, min), max); return Math.min(Math.max(value, min), max);
} }

7
packages/stdlib/src/math/mapRange/index.ts
View File

@@ -11,8 +11,13 @@ import { clamp } from "../clamp";
* @returns {number} The mapped value * @returns {number} The mapped value
*/ */
export function mapRange(value: number, in_min: number, in_max: number, out_min: number, out_max: number): number { export function mapRange(value: number, in_min: number, in_max: number, out_min: number, out_max: number): number {
// Zero input range means invalid input, so return lowest output range value
if (in_min === in_max) if (in_min === in_max)
return out_min; return out_min;
return (clamp(value, in_min, in_max) - in_min) * (out_max - out_min) / (in_max - in_min) + out_min; // To ensure the value is within the input range, clamp it
const clampedValue = clamp(value, in_min, in_max);
// Finally, map the value from the input range to the output range
return (clampedValue - in_min) * (out_max - out_min) / (in_max - in_min) + out_min;
} }