Add variable-length-quantity exercise (#48)

Author: keiravillekode

config.json

@@ -326,6 +326,14 @@
         "prerequisites": [],
         "difficulty": 5
       },
+      {
+        "slug": "variable-length-quantity",
+        "name": "Variable Length Quantity",
+        "uuid": "72798afc-0408-4cac-ab99-b4952942bd2e",
+        "practices": [],
+        "prerequisites": [],
+        "difficulty": 5
+      },
       {
         "slug": "intergalactic-transmission",
         "name": "Intergalactic Transmission",

exercises/practice/variable-length-quantity/.docs/instructions.md

@@ -0,0 +1,34 @@
+# Instructions
+
+Implement variable length quantity encoding and decoding.
+
+The goal of this exercise is to implement [VLQ][vlq] encoding/decoding.
+
+In short, the goal of this encoding is to encode integer values in a way that would save bytes.
+Only the first 7 bits of each byte are significant (right-justified; sort of like an ASCII byte).
+So, if you have a 32-bit value, you have to unpack it into a series of 7-bit bytes.
+Of course, you will have a variable number of bytes depending upon your integer.
+To indicate which is the last byte of the series, you leave bit #7 clear.
+In all of the preceding bytes, you set bit #7.
+
+So, if an integer is between `0-127`, it can be represented as one byte.
+Although VLQ can deal with numbers of arbitrary sizes, for this exercise we will restrict ourselves to only numbers that fit in a 32-bit unsigned integer.
+Here are examples of integers as 32-bit values, and the variable length quantities that they translate to:
+
+```text
+ NUMBER        VARIABLE QUANTITY
+00000000              00
+00000040              40
+0000007F              7F
+00000080             81 00
+00002000             C0 00
+00003FFF             FF 7F
+00004000           81 80 00
+00100000           C0 80 00
+001FFFFF           FF FF 7F
+00200000          81 80 80 00
+08000000          C0 80 80 00
+0FFFFFFF          FF FF FF 7F
+```
+
+[vlq]: https://en.wikipedia.org/wiki/Variable-length_quantity

exercises/practice/variable-length-quantity/.meta/config.json

@@ -0,0 +1,19 @@
+{
+  "authors": [
+    "keiravillekode"
+  ],
+  "files": {
+    "solution": [
+      "variable_length_quantity.fut"
+    ],
+    "test": [
+      "test.fut"
+    ],
+    "example": [
+      ".meta/example.fut"
+    ]
+  },
+  "blurb": "Implement variable length quantity encoding and decoding.",
+  "source": "A poor Splice developer having to implement MIDI encoding/decoding.",
+  "source_url": "https://splice.com"
+}

exercises/practice/variable-length-quantity/.meta/example.fut

@@ -0,0 +1,18 @@
+def encode [n] (integers: [n]u32): []i32 =
+  let capacity = n * 5
+  let (a, i) = loop (a, i) = (replicate capacity 0i32, capacity) for integer in reverse integers do
+    let (a2, i2, _) = loop (a2, i2, current) = (a with [i - 1] = 0x7f & i32.u32 integer, i - 1, integer >> 7) while current != 0 do
+      (a2 with [i2 - 1] = 0x80 | (0x7f & i32.u32 current), i2 - 1, current >> 7)
+    in
+      (a2, i2)
+  in
+    a[i:]
+
+def decode [n] (integers: [n]i32): []u32 =
+  let (a, i, _, complete) = loop (a, i, current, _) = (replicate n 0u32, 0, 0u32, true) for integer in integers do
+    let current2 = current | (0x7f & u32.i32 integer)
+    in
+      if (integer & 0x80) != 0 then (a, i, current2 << 7, false) else
+      (a with [i] = current2, i + 1, 0u32, true)
+  in
+    assert (complete) a[0:i]

exercises/practice/variable-length-quantity/.meta/tests.toml

@@ -0,0 +1,103 @@
+# 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.
+
+[35c9db2e-f781-4c52-b73b-8e76427defd0]
+description = "Encode a series of integers, producing a series of bytes. -> zero"
+
+[be44d299-a151-4604-a10e-d4b867f41540]
+description = "Encode a series of integers, producing a series of bytes. -> arbitrary single byte"
+
+[890bc344-cb80-45af-b316-6806a6971e81]
+description = "Encode a series of integers, producing a series of bytes. -> asymmetric single byte"
+
+[ea399615-d274-4af6-bbef-a1c23c9e1346]
+description = "Encode a series of integers, producing a series of bytes. -> largest single byte"
+
+[77b07086-bd3f-4882-8476-8dcafee79b1c]
+description = "Encode a series of integers, producing a series of bytes. -> smallest double byte"
+
+[63955a49-2690-4e22-a556-0040648d6b2d]
+description = "Encode a series of integers, producing a series of bytes. -> arbitrary double byte"
+
+[4977d113-251b-4d10-a3ad-2f5a7756bb58]
+description = "Encode a series of integers, producing a series of bytes. -> asymmetric double byte"
+
+[29da7031-0067-43d3-83a7-4f14b29ed97a]
+description = "Encode a series of integers, producing a series of bytes. -> largest double byte"
+
+[3345d2e3-79a9-4999-869e-d4856e3a8e01]
+description = "Encode a series of integers, producing a series of bytes. -> smallest triple byte"
+
+[5df0bc2d-2a57-4300-a653-a75ee4bd0bee]
+description = "Encode a series of integers, producing a series of bytes. -> arbitrary triple byte"
+
+[6731045f-1e00-4192-b5ae-98b22e17e9f7]
+description = "Encode a series of integers, producing a series of bytes. -> asymmetric triple byte"
+
+[f51d8539-312d-4db1-945c-250222c6aa22]
+description = "Encode a series of integers, producing a series of bytes. -> largest triple byte"
+
+[da78228b-544f-47b7-8bfe-d16b35bbe570]
+description = "Encode a series of integers, producing a series of bytes. -> smallest quadruple byte"
+
+[11ed3469-a933-46f1-996f-2231e05d7bb6]
+description = "Encode a series of integers, producing a series of bytes. -> arbitrary quadruple byte"
+
+[b45ef770-cbba-48c2-bd3c-c6362679516e]
+description = "Encode a series of integers, producing a series of bytes. -> asymmetric quadruple byte"
+
+[d5f3f3c3-e0f1-4e7f-aad0-18a44f223d1c]
+description = "Encode a series of integers, producing a series of bytes. -> largest quadruple byte"
+
+[91a18b33-24e7-4bfb-bbca-eca78ff4fc47]
+description = "Encode a series of integers, producing a series of bytes. -> smallest quintuple byte"
+
+[5f34ff12-2952-4669-95fe-2d11b693d331]
+description = "Encode a series of integers, producing a series of bytes. -> arbitrary quintuple byte"
+
+[9be46731-7cd5-415c-b960-48061cbc1154]
+description = "Encode a series of integers, producing a series of bytes. -> asymmetric quintuple byte"
+
+[7489694b-88c3-4078-9864-6fe802411009]
+description = "Encode a series of integers, producing a series of bytes. -> maximum 32-bit integer input"
+
+[f9b91821-cada-4a73-9421-3c81d6ff3661]
+description = "Encode a series of integers, producing a series of bytes. -> two single-byte values"
+
+[68694449-25d2-4974-ba75-fa7bb36db212]
+description = "Encode a series of integers, producing a series of bytes. -> two multi-byte values"
+
+[51a06b5c-de1b-4487-9a50-9db1b8930d85]
+description = "Encode a series of integers, producing a series of bytes. -> many multi-byte values"
+
+[baa73993-4514-4915-bac0-f7f585e0e59a]
+description = "Decode a series of bytes, producing a series of integers. -> one byte"
+
+[72e94369-29f9-46f2-8c95-6c5b7a595aee]
+description = "Decode a series of bytes, producing a series of integers. -> two bytes"
+
+[df5a44c4-56f7-464e-a997-1db5f63ce691]
+description = "Decode a series of bytes, producing a series of integers. -> three bytes"
+
+[1bb58684-f2dc-450a-8406-1f3452aa1947]
+description = "Decode a series of bytes, producing a series of integers. -> four bytes"
+
+[cecd5233-49f1-4dd1-a41a-9840a40f09cd]
+description = "Decode a series of bytes, producing a series of integers. -> maximum 32-bit integer"
+
+[e7d74ba3-8b8e-4bcb-858d-d08302e15695]
+description = "Decode a series of bytes, producing a series of integers. -> incomplete sequence causes error"
+
+[aa378291-9043-4724-bc53-aca1b4a3fcb6]
+description = "Decode a series of bytes, producing a series of integers. -> incomplete sequence causes error, even if value is zero"
+
+[a91e6f5a-c64a-48e3-8a75-ce1a81e0ebee]
+description = "Decode a series of bytes, producing a series of integers. -> multiple values"

exercises/practice/variable-length-quantity/test.fut

@@ -0,0 +1,193 @@
+import "variable_length_quantity"
+
+-- zero
+-- ==
+-- entry: test_encode
+-- input { [0u32] }
+-- output { [0] }
+
+-- arbitrary single byte
+-- ==
+-- entry: test_encode
+-- input { [64u32] }
+-- output { [64] }
+
+-- asymmetric single byte
+-- ==
+-- entry: test_encode
+-- input { [83u32] }
+-- output { [83] }
+
+-- largest single byte
+-- ==
+-- entry: test_encode
+-- input { [127u32] }
+-- output { [127] }
+
+-- smallest double byte
+-- ==
+-- entry: test_encode
+-- input { [128u32] }
+-- output { [129, 0] }
+
+-- arbitrary double byte
+-- ==
+-- entry: test_encode
+-- input { [8192u32] }
+-- output { [192, 0] }
+
+-- asymmetric double byte
+-- ==
+-- entry: test_encode
+-- input { [173u32] }
+-- output { [129, 45] }
+
+-- largest double byte
+-- ==
+-- entry: test_encode
+-- input { [16383u32] }
+-- output { [255, 127] }
+
+-- smallest triple byte
+-- ==
+-- entry: test_encode
+-- input { [16384u32] }
+-- output { [129, 128, 0] }
+
+-- arbitrary triple byte
+-- ==
+-- entry: test_encode
+-- input { [1048576u32] }
+-- output { [192, 128, 0] }
+
+-- asymmetric triple byte
+-- ==
+-- entry: test_encode
+-- input { [120220u32] }
+-- output { [135, 171, 28] }
+
+-- largest triple byte
+-- ==
+-- entry: test_encode
+-- input { [2097151u32] }
+-- output { [255, 255, 127] }
+
+-- smallest quadruple byte
+-- ==
+-- entry: test_encode
+-- input { [2097152u32] }
+-- output { [129, 128, 128, 0] }
+
+-- arbitrary quadruple byte
+-- ==
+-- entry: test_encode
+-- input { [134217728u32] }
+-- output { [192, 128, 128, 0] }
+
+-- asymmetric quadruple byte
+-- ==
+-- entry: test_encode
+-- input { [3503876u32] }
+-- output { [129, 213, 238, 4] }
+
+-- largest quadruple byte
+-- ==
+-- entry: test_encode
+-- input { [268435455u32] }
+-- output { [255, 255, 255, 127] }
+
+-- smallest quintuple byte
+-- ==
+-- entry: test_encode
+-- input { [268435456u32] }
+-- output { [129, 128, 128, 128, 0] }
+
+-- arbitrary quintuple byte
+-- ==
+-- entry: test_encode
+-- input { [4278190080u32] }
+-- output { [143, 248, 128, 128, 0] }
+
+-- asymmetric quintuple byte
+-- ==
+-- entry: test_encode
+-- input { [2254790917u32] }
+-- output { [136, 179, 149, 194, 5] }
+
+-- maximum 32-bit integer input
+-- ==
+-- entry: test_encode
+-- input { [4294967295u32] }
+-- output { [143, 255, 255, 255, 127] }
+
+-- two single-byte values
+-- ==
+-- entry: test_encode
+-- input { [64u32, 127u32] }
+-- output { [64, 127] }
+
+-- two multi-byte values
+-- ==
+-- entry: test_encode
+-- input { [16384u32, 1193046u32] }
+-- output { [129, 128, 0, 200, 232, 86] }
+
+-- many multi-byte values
+-- ==
+-- entry: test_encode
+-- input { [8192u32, 1193046u32, 268435455u32, 0u32, 16383u32, 16384u32] }
+-- output { [192, 0, 200, 232, 86, 255, 255, 255, 127, 0, 255, 127, 129, 128, 0] }
+
+-- one byte
+-- ==
+-- entry: test_decode
+-- input { [127] }
+-- output { [127u32] }
+
+-- two bytes
+-- ==
+-- entry: test_decode
+-- input { [192, 0] }
+-- output { [8192u32] }
+
+-- three bytes
+-- ==
+-- entry: test_decode
+-- input { [255, 255, 127] }
+-- output { [2097151u32] }
+
+-- four bytes
+-- ==
+-- entry: test_decode
+-- input { [129, 128, 128, 0] }
+-- output { [2097152u32] }
+
+-- maximum 32-bit integer
+-- ==
+-- entry: test_decode
+-- input { [143, 255, 255, 255, 127] }
+-- output { [4294967295u32] }
+
+-- incomplete sequence causes error
+-- ==
+-- entry: test_decode
+-- input { [255] }
+-- error: Error*
+
+-- incomplete sequence causes error, even if value is zero
+-- ==
+-- entry: test_decode
+-- input { [128] }
+-- error: Error*
+
+-- multiple values
+-- ==
+-- entry: test_decode
+-- input { [192, 0, 200, 232, 86, 255, 255, 255, 127, 0, 255, 127, 129, 128, 0] }
+-- output { [8192u32, 1193046u32, 268435455u32, 0u32, 16383u32, 16384u32] }
+
+entry test_encode (integers: []u32): []i32 =
+  encode integers
+
+entry test_decode (integers: []i32): []u32 =
+  decode integers

exercises/practice/variable-length-quantity/variable_length_quantity.fut

@@ -0,0 +1,3 @@
+def encode (integers: []u32): []i32 = ???
+
+def decode (integers: []i32): []u32 = ???