Skip to content

Commit b7c7200

Browse files
feat: add Collatz sequence algorithm
1 parent 5c39e87 commit b7c7200

2 files changed

Lines changed: 67 additions & 31 deletions

File tree

‎Maths/CollatzSequence.js‎

Lines changed: 22 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,26 @@
11
/**
2-
* @function collatz
3-
* @description Applies the Collatz Sequence on a specified number.
4-
* The Collatz Sequence states that every natural number will always fall in a 1, 2, 4 loop when iterated under the following function:
5-
* If the number is even, divide by 2, and if its odd, multiply it by 3 and add 1.
6-
*
7-
* @parama {Integer} n The number to apply the Collatz Sequence to.
8-
*
9-
* @return An array of steps and the final result..
10-
*
11-
* @see [Collatz Conjecture](https://en.wikipedia.org/wiki/Collatz_conjecture)
12-
*
13-
* @example collatz(1) = { result: 1, steps: [] }
14-
* @example collatz(5) = { result: 1, steps: [16, 8, 4, 2, 1] }
2+
* @function collatzSequence
3+
* @description The Collatz conjecture states that for any positive integer n,
4+
* if n is even divide by 2, if n is odd multiply by 3 and add 1.
5+
* Repeating this process will eventually reach 1.
6+
* This function returns the full Collatz sequence for a given number.
7+
* @param {number} n - A positive integer
8+
* @returns {number[]} - The Collatz sequence starting from n
9+
* @see https://en.wikipedia.org/wiki/Collatz_conjecture
10+
* @example collatzSequence(6) => [6, 3, 10, 5, 16, 8, 4, 2, 1]
11+
* @example collatzSequence(1) => [1]
1512
*/
16-
export function collatz(n) {
17-
const steps = []
18-
19-
while (n !== 1) {
20-
if (n % 2 === 0) {
21-
n = n / 2
22-
} else {
23-
n = 3 * n + 1
24-
}
25-
26-
steps.push(n)
13+
const collatzSequence = (n) => {
14+
if (!Number.isInteger(n) || n < 1) {
15+
throw new TypeError('Input must be a positive integer')
2716
}
28-
29-
return { result: n, steps }
17+
const sequence = [n]
18+
let current = n
19+
while (current !== 1) {
20+
current = current % 2 === 0 ? current / 2 : 3 * current + 1
21+
sequence.push(current)
22+
}
23+
return sequence
3024
}
25+
26+
export { collatzSequence }

‎Maths/test/CollatzSequence.test.js‎

Lines changed: 45 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,48 @@
1-
import { collatz } from '../CollatzSequence'
1+
import { collatzSequence } from '../CollatzSequence.js'
22

3-
describe('The Collatz Sequence', () => {
4-
it('Should be 1', () => {
5-
expect(collatz(1)).toStrictEqual({ result: 1, steps: [] })
6-
expect(collatz(5)).toStrictEqual({ result: 1, steps: [16, 8, 4, 2, 1] })
3+
describe('collatzSequence', () => {
4+
test('collatzSequence(1) returns [1]', () => {
5+
expect(collatzSequence(1)).toEqual([1])
6+
})
7+
8+
test('collatzSequence(2) returns [2, 1]', () => {
9+
expect(collatzSequence(2)).toEqual([2, 1])
10+
})
11+
12+
test('collatzSequence(6) returns correct sequence', () => {
13+
expect(collatzSequence(6)).toEqual([6, 3, 10, 5, 16, 8, 4, 2, 1])
14+
})
15+
16+
test('collatzSequence always ends with 1', () => {
17+
const seq = collatzSequence(27)
18+
expect(seq[seq.length - 1]).toBe(1)
19+
})
20+
21+
test('collatzSequence(1) has length 1', () => {
22+
expect(collatzSequence(1)).toHaveLength(1)
23+
})
24+
25+
test('collatzSequence starts with input number', () => {
26+
expect(collatzSequence(10)[0]).toBe(10)
27+
})
28+
29+
test('collatzSequence(4) returns [4, 2, 1]', () => {
30+
expect(collatzSequence(4)).toEqual([4, 2, 1])
31+
})
32+
33+
test('collatzSequence(5) returns [5, 16, 8, 4, 2, 1]', () => {
34+
expect(collatzSequence(5)).toEqual([5, 16, 8, 4, 2, 1])
35+
})
36+
37+
test('throws TypeError for zero', () => {
38+
expect(() => collatzSequence(0)).toThrow(TypeError)
39+
})
40+
41+
test('throws TypeError for negative input', () => {
42+
expect(() => collatzSequence(-6)).toThrow(TypeError)
43+
})
44+
45+
test('throws TypeError for float input', () => {
46+
expect(() => collatzSequence(6.5)).toThrow(TypeError)
747
})
848
})

0 commit comments

Comments
 (0)