exercism

commit 764270694f2c0521e38495f0e0eadbb2d5c6187a
parent fb3a4e6b95eaff75f8e2952039e6367e27671e67
Author: dwrz <dwrz@dwrz.net>
Date:   Mon, 22 Apr 2019 01:17:59 +0000

Document grains

Diffstat:
M
c/grains/src/grains.c
 | 
11
+++++++++++

1 file changed, 11 insertions(+), 0 deletions(-)
diff --git a/c/grains/src/grains.c b/c/grains/src/grains.c
@@ -1,12 +1,23 @@
 #include "grains.h"
 
+// square returns the number of grains to be placed at the nth square.
+// An unsigned long long is necessary to hold the value of 2^64, which
+// on 64-bit is equivalent to the max value of that type (ULLONG_MAX).
+// square returns 0 for non-existing squares.
 unsigned long long square(int n) {
   if (n < 1 || n > 64) return 0;
+  // A left shift of 0 leaves a number unchanged.
+  // Otherwise, each left shift of 1 doubles the number;
+  // i.e, 1 << 0 = 1, 1 << 1 = 2, 1 << 2 = 4, etc.
+  // 00000001 = 1, 00000010 = 2, 000000100 = 4, etc.
+  // There is one grain at the first square, not 2.
+  // ∴, we subtract one from n to get the correct number of shifts.
   return 1ull << (n-1);
 }
 
 unsigned long long total() {
   unsigned long long n = 0;
+  // Add up all the squares.
   for (int i = 1; i <= 64; i++) {
     n += square(i);
   }