Add sieve exercise (#61)

Author: keiravillekode

config.json

@@ -396,6 +396,14 @@
         "prerequisites": [],
         "difficulty": 3
       },
+      {
+        "slug": "sieve",
+        "name": "Sieve",
+        "uuid": "b99f0eb0-269c-4f3c-9e40-2da54112dbae",
+        "practices": [],
+        "prerequisites": [],
+        "difficulty": 3
+      },
       {
         "slug": "space-age",
         "name": "Space Age",

exercises/practice/sieve/.docs/instructions.md

@@ -0,0 +1,101 @@
+# Instructions
+
+Your task is to create a program that implements the Sieve of Eratosthenes algorithm to find all prime numbers less than or equal to a given number.
+
+A prime number is a number larger than 1 that is only divisible by 1 and itself.
+For example, 2, 3, 5, 7, 11, and 13 are prime numbers.
+By contrast, 6 is _not_ a prime number as it not only divisible by 1 and itself, but also by 2 and 3.
+
+To use the Sieve of Eratosthenes, first, write out all the numbers from 2 up to and including your given number.
+Then, follow these steps:
+
+1. Find the next unmarked number (skipping over marked numbers).
+   This is a prime number.
+2. Mark all the multiples of that prime number as **not** prime.
+
+Repeat the steps until you've gone through every number.
+At the end, all the unmarked numbers are prime.
+
+~~~~exercism/note
+The Sieve of Eratosthenes marks off multiples of each prime using addition (repeatedly adding the prime) or multiplication (directly computing its multiples), rather than checking each number for divisibility.
+
+The tests don't check that you've implemented the algorithm, only that you've come up with the correct primes.
+~~~~
+
+## Example
+
+Let's say you're finding the primes less than or equal to 10.
+
+- Write out 2, 3, 4, 5, 6, 7, 8, 9, 10, leaving them all unmarked.
+
+  ```text
+  2 3 4 5 6 7 8 9 10
+  ```
+
+- 2 is unmarked and is therefore a prime.
+  Mark 4, 6, 8 and 10 as "not prime".
+
+  ```text
+  2 3 [4] 5 [6] 7 [8] 9 [10]
+  ↑
+  ```
+
+- 3 is unmarked and is therefore a prime.
+  Mark 6 and 9 as not prime _(marking 6 is optional - as it's already been marked)_.
+
+  ```text
+  2 3 [4] 5 [6] 7 [8] [9] [10]
+    ↑
+  ```
+
+- 4 is marked as "not prime", so we skip over it.
+
+  ```text
+  2 3 [4] 5 [6] 7 [8] [9] [10]
+       ↑
+  ```
+
+- 5 is unmarked and is therefore a prime.
+  Mark 10 as not prime _(optional - as it's already been marked)_.
+
+  ```text
+  2 3 [4] 5 [6] 7 [8] [9] [10]
+          ↑
+  ```
+
+- 6 is marked as "not prime", so we skip over it.
+
+  ```text
+  2 3 [4] 5 [6] 7 [8] [9] [10]
+             ↑
+  ```
+
+- 7 is unmarked and is therefore a prime.
+
+  ```text
+  2 3 [4] 5 [6] 7 [8] [9] [10]
+                ↑
+  ```
+
+- 8 is marked as "not prime", so we skip over it.
+
+  ```text
+  2 3 [4] 5 [6] 7 [8] [9] [10]
+                   ↑
+  ```
+
+- 9 is marked as "not prime", so we skip over it.
+
+  ```text
+  2 3 [4] 5 [6] 7 [8] [9] [10]
+                       ↑
+  ```
+
+- 10 is marked as "not prime", so we stop as there are no more numbers to check.
+
+  ```text
+  2 3 [4] 5 [6] 7 [8] [9] [10]
+                           ↑
+  ```
+
+You've examined all the numbers and found that 2, 3, 5, and 7 are still unmarked, meaning they're the primes less than or equal to 10.

exercises/practice/sieve/.docs/introduction.md

@@ -0,0 +1,7 @@
+# Introduction
+
+You bought a big box of random computer parts at a garage sale.
+You've started putting the parts together to build custom computers.
+
+You want to test the performance of different combinations of parts, and decide to create your own benchmarking program to see how your computers compare.
+You choose the famous "Sieve of Eratosthenes" algorithm, an ancient algorithm, but one that should push your computers to the limits.

exercises/practice/sieve/.meta/config.json

@@ -0,0 +1,19 @@
+{
+  "authors": [
+    "keiravillekode"
+  ],
+  "files": {
+    "solution": [
+      "Sieve.pas"
+    ],
+    "test": [
+      "TestCases.pas"
+    ],
+    "example": [
+      ".meta/example.pas"
+    ]
+  },
+  "blurb": "Use the Sieve of Eratosthenes to find all the primes from 2 up to a given number.",
+  "source": "Sieve of Eratosthenes at Wikipedia",
+  "source_url": "https://en.wikipedia.org/wiki/Sieve_of_Eratosthenes"
+}

exercises/practice/sieve/.meta/example.pas

@@ -0,0 +1,46 @@
+unit Sieve;
+
+{$mode ObjFPC}{$H+}
+
+interface
+
+type
+  TIntArray = Array Of Integer;
+  TBoolArray = Array Of Boolean;
+
+function primes(
+  const limit   : Integer
+) : TIntArray;
+
+implementation
+
+uses SysUtils;
+
+function primes(
+  const limit   : Integer
+) : TIntArray;
+var
+  table : TBoolArray = ();
+  p : Integer;
+  n : Integer;
+begin
+  SetLength(table, limit + 1);
+  for n := Low(table) to High(table) do
+    table[n] := true;
+
+  result := [];
+  for p := 2 to limit do
+    if table[p] then
+      begin
+        insert(p, result, Length(result));
+
+        n := p * p;
+        while n <= limit do
+          begin
+            table[n] := false;
+            n := n + p;
+          end;
+      end;
+end;
+
+end.

exercises/practice/sieve/.meta/tests.toml

@@ -0,0 +1,25 @@
+# This is an auto-generated file.
+#
+# Regenerating this file via `configlet sync` will:
+# - Recreate every `description` key/value pair
+# - Recreate every `reimplements` key/value pair, where they exist in problem-specifications
+# - Remove any `include = true` key/value pair (an omitted `include` key implies inclusion)
+# - Preserve any other key/value pair
+#
+# As user-added comments (using the # character) will be removed when this file
+# is regenerated, comments can be added via a `comment` key.
+
+[88529125-c4ce-43cc-bb36-1eb4ddd7b44f]
+description = "no primes under two"
+
+[4afe9474-c705-4477-9923-840e1024cc2b]
+description = "find first prime"
+
+[974945d8-8cd9-4f00-9463-7d813c7f17b7]
+description = "find primes up to 10"
+
+[2e2417b7-3f3a-452a-8594-b9af08af6d82]
+description = "limit is prime"
+
+[92102a05-4c7c-47de-9ed0-b7d5fcd00f21]
+description = "find primes up to 1000"

exercises/practice/sieve/Makefile

@@ -0,0 +1,15 @@
+SHELL       = /bin/bash
+MAKEFLAGS  += --no-print-directory
+DESTDIR     = build
+EXECUTABLE  = $(DESTDIR)/test
+COMMAND     = fpc -l- -v0 -g -gl -Sa -Cr -Sehnw -Fu./lib test.pas -FE"./$(DESTDIR)"
+
+.ONESHELL:
+
+test:
+	@mkdir -p "./$(DESTDIR)"
+	@cp -r ./lib "./$(DESTDIR)"
+	@$(COMMAND) && ./$(EXECUTABLE) $(test)
+
+clean:
+	@rm -fr "./$(DESTDIR)"

exercises/practice/sieve/Sieve.pas

@@ -0,0 +1,27 @@
+unit Sieve;
+
+{$mode ObjFPC}{$H+}
+
+interface
+
+type
+  TIntArray = Array Of Integer;
+
+function primes(
+  const limit   : Integer
+) : TIntArray;
+
+implementation
+
+uses SysUtils;
+
+function primes(
+  const limit   : Integer
+) : TIntArray;
+begin
+
+  raise ENotImplemented.Create('Please implement your solution.'); result := [limit];
+
+end;
+
+end.

exercises/practice/sieve/TestCases.pas

@@ -0,0 +1,81 @@
+unit TestCases;
+
+{$mode ObjFPC}{$H+}
+
+interface
+
+uses Classes, SysUtils, FPCUnit, TestRegistry, FPCUnitTestUtils;
+
+type
+  SieveTest = class(TTestCase)
+  published
+    procedure no_primes_under_two;
+    procedure find_first_prime;
+    procedure find_primes_up_to_10;
+    procedure limit_is_prime;
+    procedure find_primes_up_to_1000;
+  end;
+
+implementation
+
+uses Sieve;
+
+// 88529125-c4ce-43cc-bb36-1eb4ddd7b44f
+procedure SieveTest.no_primes_under_two;
+var
+  expect : TIntArray;
+  actual : TIntArray;
+begin
+  expect := [];
+  actual := Sieve.primes(1);
+  TapAssertTrue(Self, 'no primes under two', expect, actual);
+end;
+
+// 4afe9474-c705-4477-9923-840e1024cc2b
+procedure SieveTest.find_first_prime;
+var
+  expect : TIntArray;
+  actual : TIntArray;
+begin
+  expect := [2];
+  actual := Sieve.primes(2);
+  TapAssertTrue(Self, 'find first prime', expect, actual);
+end;
+
+// 974945d8-8cd9-4f00-9463-7d813c7f17b7
+procedure SieveTest.find_primes_up_to_10;
+var
+  expect : TIntArray;
+  actual : TIntArray;
+begin
+  expect := [2, 3, 5, 7];
+  actual := Sieve.primes(10);
+  TapAssertTrue(Self, 'find primes up to 10', expect, actual);
+end;
+
+// 2e2417b7-3f3a-452a-8594-b9af08af6d82
+procedure SieveTest.limit_is_prime;
+var
+  expect : TIntArray;
+  actual : TIntArray;
+begin
+  expect := [2, 3, 5, 7, 11, 13];
+  actual := Sieve.primes(13);
+  TapAssertTrue(Self, 'limit is prime', expect, actual);
+end;
+
+// 92102a05-4c7c-47de-9ed0-b7d5fcd00f21
+procedure SieveTest.find_primes_up_to_1000;
+var
+  expect : TIntArray;
+  actual : TIntArray;
+begin
+  expect := [2, 3, 5, 7, 11, 13, 17, 19, 23, 29, 31, 37, 41, 43, 47, 53, 59, 61, 67, 71, 73, 79, 83, 89, 97, 101, 103, 107, 109, 113, 127, 131, 137, 139, 149, 151, 157, 163, 167, 173, 179, 181, 191, 193, 197, 199, 211, 223, 227, 229, 233, 239, 241, 251, 257, 263, 269, 271, 277, 281, 283, 293, 307, 311, 313, 317, 331, 337, 347, 349, 353, 359, 367, 373, 379, 383, 389, 397, 401, 409, 419, 421, 431, 433, 439, 443, 449, 457, 461, 463, 467, 479, 487, 491, 499, 503, 509, 521, 523, 541, 547, 557, 563, 569, 571, 577, 587, 593, 599, 601, 607, 613, 617, 619, 631, 641, 643, 647, 653, 659, 661, 673, 677, 683, 691, 701, 709, 719, 727, 733, 739, 743, 751, 757, 761, 769, 773, 787, 797, 809, 811, 821, 823, 827, 829, 839, 853, 857, 859, 863, 877, 881, 883, 887, 907, 911, 919, 929, 937, 941, 947, 953, 967, 971, 977, 983, 991, 997];
+  actual := Sieve.primes(1000);
+  TapAssertTrue(Self, 'find primes up to 1000', expect, actual);
+end;
+
+initialization
+RegisterTest(SieveTest);
+
+end.