Skip to content

Commit 109ff11

Browse files
feat: add clamp number algorithm
1 parent 5c39e87 commit 109ff11

2 files changed

Lines changed: 80 additions & 0 deletions

File tree

‎Maths/ClampNumber.js‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
/**
2+
* @function clampNumber
3+
* @description Clamps a number between a minimum and maximum value.
4+
* If the number is less than min, returns min.
5+
* If the number is greater than max, returns max.
6+
* Otherwise returns the number itself.
7+
* @param {number} num - The number to clamp
8+
* @param {number} min - The minimum value
9+
* @param {number} max - The maximum value
10+
* @returns {number} - The clamped number
11+
* @see https://en.wikipedia.org/wiki/Clamping_(graphics)
12+
* @example clampNumber(5, 1, 10) => 5
13+
* @example clampNumber(-5, 1, 10) => 1
14+
* @example clampNumber(15, 1, 10) => 10
15+
*/
16+
const clampNumber = (num, min, max) => {
17+
if (
18+
typeof num !== 'number' ||
19+
typeof min !== 'number' ||
20+
typeof max !== 'number' ||
21+
isNaN(num) ||
22+
isNaN(min) ||
23+
isNaN(max)
24+
) {
25+
throw new TypeError('All inputs must be numbers')
26+
}
27+
if (min > max) {
28+
throw new RangeError('min must be less than or equal to max')
29+
}
30+
return Math.min(Math.max(num, min), max)
31+
}
32+
33+
export { clampNumber }

‎Maths/test/ClampNumber.test.js‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
import { clampNumber } from '../ClampNumber.js'
2+
3+
describe('clampNumber', () => {
4+
test('clampNumber(5, 1, 10) returns 5', () => {
5+
expect(clampNumber(5, 1, 10)).toBe(5)
6+
})
7+
8+
test('clampNumber(-5, 1, 10) returns 1', () => {
9+
expect(clampNumber(-5, 1, 10)).toBe(1)
10+
})
11+
12+
test('clampNumber(15, 1, 10) returns 10', () => {
13+
expect(clampNumber(15, 1, 10)).toBe(10)
14+
})
15+
16+
test('clampNumber(1, 1, 10) returns 1 (at min)', () => {
17+
expect(clampNumber(1, 1, 10)).toBe(1)
18+
})
19+
20+
test('clampNumber(10, 1, 10) returns 10 (at max)', () => {
21+
expect(clampNumber(10, 1, 10)).toBe(10)
22+
})
23+
24+
test('clampNumber works with negative range', () => {
25+
expect(clampNumber(-5, -10, -1)).toBe(-5)
26+
})
27+
28+
test('clampNumber works with decimals', () => {
29+
expect(clampNumber(1.5, 1.0, 2.0)).toBe(1.5)
30+
})
31+
32+
test('clampNumber(0, 0, 0) returns 0', () => {
33+
expect(clampNumber(0, 0, 0)).toBe(0)
34+
})
35+
36+
test('throws TypeError for non-number input', () => {
37+
expect(() => clampNumber('5', 1, 10)).toThrow(TypeError)
38+
})
39+
40+
test('throws TypeError for NaN', () => {
41+
expect(() => clampNumber(NaN, 1, 10)).toThrow(TypeError)
42+
})
43+
44+
test('throws RangeError when min > max', () => {
45+
expect(() => clampNumber(5, 10, 1)).toThrow(RangeError)
46+
})
47+
})

0 commit comments

Comments
 (0)