add sublist exercise

Author: oxe-i

config.json

@@ -340,6 +340,14 @@
         "prerequisites": [],
         "difficulty": 3
       },
+      {
+        "slug": "sublist",
+        "name": "Sublist",
+        "uuid": "9876f5db-d23c-49c0-bf99-c24f4efe5622",
+        "practices": [],
+        "prerequisites": [],
+        "difficulty": 3
+      },
       {
         "slug": "acronym",
         "name": "Acronym",

exercises/practice/sublist/.docs/instructions.md

@@ -0,0 +1,25 @@
+# Instructions
+
+Given any two lists `A` and `B`, determine if:
+
+- List `A` is equal to list `B`; or
+- List `A` contains list `B` (`A` is a superlist of `B`); or
+- List `A` is contained by list `B` (`A` is a sublist of `B`); or
+- None of the above is true, thus lists `A` and `B` are unequal
+
+Specifically, list `A` is equal to list `B` if both lists have the same values in the same order.
+List `A` is a superlist of `B` if `A` contains a contiguous sub-sequence of values equal to `B`.
+List `A` is a sublist of `B` if `B` contains a contiguous sub-sequence of values equal to `A`.
+
+Examples:
+
+- If `A = []` and `B = []` (both lists are empty), then `A` and `B` are equal
+- If `A = [1, 2, 3]` and `B = []`, then `A` is a superlist of `B`
+- If `A = []` and `B = [1, 2, 3]`, then `A` is a sublist of `B`
+- If `A = [1, 2, 3]` and `B = [1, 2, 3, 4, 5]`, then `A` is a sublist of `B`
+- If `A = [3, 4, 5]` and `B = [1, 2, 3, 4, 5]`, then `A` is a sublist of `B`
+- If `A = [3, 4]` and `B = [1, 2, 3, 4, 5]`, then `A` is a sublist of `B`
+- If `A = [1, 2, 3]` and `B = [1, 2, 3]`, then `A` and `B` are equal
+- If `A = [1, 2, 3, 4, 5]` and `B = [2, 3, 4]`, then `A` is a superlist of `B`
+- If `A = [1, 2, 4]` and `B = [1, 2, 3, 4, 5]`, then `A` and `B` are unequal
+- If `A = [1, 2, 3]` and `B = [1, 3, 2]`, then `A` and `B` are unequal

exercises/practice/sublist/.meta/config.json

@@ -0,0 +1,17 @@
+{
+  "authors": [
+    "oxe-i"
+  ],
+  "files": {
+    "solution": [
+      "sublist.asm"
+    ],
+    "test": [
+      "sublist_test.c"
+    ],
+    "example": [
+      ".meta/example.asm"
+    ]
+  },
+  "blurb": "Write a function to determine if a list is a sublist of another list."
+}

exercises/practice/sublist/.meta/example.asm

@@ -0,0 +1,119 @@
+UNEQUAL equ 0
+EQUAL equ 1
+SUBLIST equ 2
+SUPERLIST equ 3
+
+section .text
+global sublist
+ 
+sublist:
+    ; rdi - array of int64_t (first list)
+    ; rsi - size of first array as uint64_t
+    ; rdx - array of int64_t (second list)
+    ; rcx - size of second array as uint64_t
+    ; return is an enum in eax
+
+    xchg rsi, rdx ; for using cmpsq
+
+    cmp rdx, rcx 
+    je .check_equality ; if lengths are the same, lists must be equal or unequal
+    jg .check_superlist ; if first list is larger, it must be a superlist or unequal
+    ; otherwise, second list is larger and first must be sublist or unequal
+
+.check_sublist:
+    cmp rdx, 0 
+    je .sublist ; empty list is sublist of any list
+                ; except of other empty list, which is equal (but this is covered in .check_equality)
+
+.sublist_loop:
+    cmp rcx, rdx
+    jl .unequal ; if at any point of the loop, the first list is greater, then the lists are unequal
+
+    mov r8, qword [rdi]
+    cmp r8, qword [rsi]
+    jne .check_next_sublist ; if elements are different, no sublist starts here
+    ; otherwise we check if a sublist starts here
+
+    ; saves variables to use cmpsq
+    mov r8, rdi
+    mov r9, rsi
+    mov r10, rcx
+
+    mov rcx, rdx ; repe uses rcx as counter, it must be instantiated with the lesser length
+
+    repe cmpsq
+    je .sublist ; if the comparison exhausts the first list returning equal, then it's a sublist
+    ; otherwise, the variables are restored to check next element
+
+    mov rdi, r8
+    mov rsi, r9
+    mov rcx, r10
+
+.check_next_sublist:
+    ; moves to next element of the second list to check if a sublist starts there
+    dec rcx
+    add rsi, 8
+
+    jmp .sublist_loop
+
+.sublist:
+    mov rax, SUBLIST
+    ret
+
+.check_superlist:
+    cmp rcx, 0
+    je .superlist ; any list is superlist of an empty list
+                  ; except another empty list, which is equal (but this is covered in .check_equality)
+
+.superlist_loop:
+    cmp rdx, rcx
+    jl .unequal ; if at any point of the loop, the first list's size is lesser, then the lists are unequal
+
+    mov r8, qword [rdi]
+    cmp r8, qword [rsi]
+    jne .check_next_superlist ; if elements are different, no superlist starts here
+    ; otherwise we check if a superlist starts here
+
+    ; saves variables to use cmpsq
+    mov r8, rdi
+    mov r9, rsi
+    mov r10, rcx
+
+    ; repe uses rcx as counter, it must be instantiated with the lesser length
+    ; but in this case rcx is already the lesser length
+
+    repe cmpsq
+    je .superlist ; if the comparison exhausts the second list returning equal, then the first is a superlist
+    ; otherwise, the variables are restored to check next element
+
+    mov rdi, r8
+    mov rsi, r9
+    mov rcx, r10
+
+.check_next_superlist:
+    ; moves to next element of the first list to check if a superlist starts there
+    dec rdx
+    add rdi, 8
+
+    jmp .superlist_loop
+
+.superlist:
+    mov rax, SUPERLIST
+    ret
+
+.check_equality:
+    ; sizes are equal, there's no need to change rcx for repe
+    repe cmpsq
+    jne .unequal
+    
+    mov rax, EQUAL
+    ret
+
+.unequal:
+    mov rax, UNEQUAL
+    ret
+
+%ifidn __OUTPUT_FORMAT__,elf64
+section .note.GNU-stack noalloc noexec nowrite progbits
+%endif
+

exercises/practice/sublist/.meta/tests.toml

@@ -0,0 +1,64 @@
+# 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.
+
+[97319c93-ebc5-47ab-a022-02a1980e1d29]
+description = "empty lists"
+
+[de27dbd4-df52-46fe-a336-30be58457382]
+description = "empty list within non empty list"
+
+[5487cfd1-bc7d-429f-ac6f-1177b857d4fb]
+description = "non empty list contains empty list"
+
+[1f390b47-f6b2-4a93-bc23-858ba5dda9a6]
+description = "list equals itself"
+
+[7ed2bfb2-922b-4363-ae75-f3a05e8274f5]
+description = "different lists"
+
+[3b8a2568-6144-4f06-b0a1-9d266b365341]
+description = "false start"
+
+[dc39ed58-6311-4814-be30-05a64bc8d9b1]
+description = "consecutive"
+
+[d1270dab-a1ce-41aa-b29d-b3257241ac26]
+description = "sublist at start"
+
+[81f3d3f7-4f25-4ada-bcdc-897c403de1b6]
+description = "sublist in middle"
+
+[43bcae1e-a9cf-470e-923e-0946e04d8fdd]
+description = "sublist at end"
+
+[76cf99ed-0ff0-4b00-94af-4dfb43fe5caa]
+description = "at start of superlist"
+
+[b83989ec-8bdf-4655-95aa-9f38f3e357fd]
+description = "in middle of superlist"
+
+[26f9f7c3-6cf6-4610-984a-662f71f8689b]
+description = "at end of superlist"
+
+[0a6db763-3588-416a-8f47-76b1cedde31e]
+description = "first list missing element from second list"
+
+[83ffe6d8-a445-4a3c-8795-1e51a95e65c3]
+description = "second list missing element from first list"
+
+[7bc76cb8-5003-49ca-bc47-cdfbe6c2bb89]
+description = "first list missing additional digits from second list"
+
+[0d7ee7c1-0347-45c8-9ef5-b88db152b30b]
+description = "order matters to a list"
+
+[5f47ce86-944e-40f9-9f31-6368aad70aa6]
+description = "same digits but different numbers"

exercises/practice/sublist/Makefile

@@ -0,0 +1,46 @@
+AS = nasm
+
+CFLAGS = -g -Wall -Wextra -pedantic -Werror
+LDFLAGS =
+ASFLAGS = -g -F dwarf -Werror
+
+ifeq ($(shell uname -s),Darwin)
+ifeq ($(shell sysctl -n hw.optional.arm64 2>/dev/null),1)
+	ALL_CFLAGS = -target x86_64-apple-darwin
+endif
+	ALL_LDFLAGS = -Wl,-pie
+	ALL_ASFLAGS = -f macho64 --prefix _
+else
+	ALL_LDFLAGS = -pie -Wl,--fatal-warnings
+	ALL_ASFLAGS = -f elf64
+endif
+
+ALL_CFLAGS += -std=c99 -fPIE -m64 $(CFLAGS)
+ALL_LDFLAGS += $(LDFLAGS)
+ALL_ASFLAGS += $(ASFLAGS)
+
+C_OBJS = $(patsubst %.c,%.o,$(wildcard *.c))
+AS_OBJS = $(patsubst %.asm,%.o,$(wildcard *.asm))
+ALL_OBJS = $(filter-out example.o,$(C_OBJS) $(AS_OBJS) vendor/unity.o)
+
+CC_CMD = $(CC) $(ALL_CFLAGS) -c -o $@ $<
+
+all: tests
+	@./$<
+
+tests: $(ALL_OBJS)
+	@$(CC) $(ALL_CFLAGS) $(ALL_LDFLAGS) -o $@ $(ALL_OBJS)
+
+%.o: %.asm
+	@$(AS) $(ALL_ASFLAGS) -o $@ $<
+
+%.o: %.c
+	@$(CC_CMD)
+
+vendor/unity.o: vendor/unity.c vendor/unity.h vendor/unity_internals.h
+	@$(CC_CMD)
+
+clean:
+	@rm -f *.o vendor/*.o tests
+
+.PHONY: all clean

exercises/practice/sublist/sublist.asm

@@ -0,0 +1,17 @@
+UNEQUAL equ 0
+EQUAL equ 1
+SUBLIST equ 2
+SUPERLIST equ 3
+
+section .text
+global sublist
+
+sublist:
+    ; Provide your implementation here
+    ret
+
+%ifidn __OUTPUT_FORMAT__,elf64
+section .note.GNU-stack noalloc nowrite progbits
+%endif
+
+