Skip to content

Commit

Permalink
Add luhn exercise (#91)
Browse files Browse the repository at this point in the history
  • Loading branch information
keiravillekode authored Oct 29, 2024
1 parent 2f9903e commit 924e6bb
Show file tree
Hide file tree
Showing 12 changed files with 3,732 additions and 0 deletions.
8 changes: 8 additions & 0 deletions config.json
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,14 @@
"prerequisites": [],
"difficulty": 5
},
{
"slug": "luhn",
"name": "Luhn",
"uuid": "74d44a25-bf7c-452a-9ba7-8b730a05684e",
"practices": [],
"prerequisites": [],
"difficulty": 5
},
{
"slug": "matching-brackets",
"name": "Matching Brackets",
Expand Down
65 changes: 65 additions & 0 deletions exercises/practice/luhn/.docs/instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Instructions

Given a number determine whether or not it is valid per the Luhn formula.

The [Luhn algorithm][luhn] is a simple checksum formula used to validate a variety of identification numbers, such as credit card numbers and Canadian Social Insurance Numbers.

The task is to check if a given string is valid.

## Validating a Number

Strings of length 1 or less are not valid.
Spaces are allowed in the input, but they should be stripped before checking.
All other non-digit characters are disallowed.

### Example 1: valid credit card number

```text
4539 3195 0343 6467
```

The first step of the Luhn algorithm is to double every second digit, starting from the right.
We will be doubling

```text
4539 3195 0343 6467
↑ ↑ ↑ ↑ ↑ ↑ ↑ ↑ (double these)
```

If doubling the number results in a number greater than 9 then subtract 9 from the product.
The results of our doubling:

```text
8569 6195 0383 3437
```

Then sum all of the digits:

```text
8+5+6+9+6+1+9+5+0+3+8+3+3+4+3+7 = 80
```

If the sum is evenly divisible by 10, then the number is valid.
This number is valid!

### Example 2: invalid credit card number

```text
8273 1232 7352 0569
```

Double the second digits, starting from the right

```text
7253 2262 5312 0539
```

Sum the digits

```text
7+2+5+3+2+2+6+2+5+3+1+2+0+5+3+9 = 57
```

57 is not evenly divisible by 10, so this number is not valid.

[luhn]: https://en.wikipedia.org/wiki/Luhn_algorithm
19 changes: 19 additions & 0 deletions exercises/practice/luhn/.meta/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"authors": [
"keiravillekode"
],
"files": {
"solution": [
"luhn.s"
],
"test": [
"luhn_test.c"
],
"example": [
".meta/example.s"
]
},
"blurb": "Given a number determine whether or not it is valid per the Luhn formula.",
"source": "The Luhn Algorithm on Wikipedia",
"source_url": "https://en.wikipedia.org/wiki/Luhn_algorithm"
}
62 changes: 62 additions & 0 deletions exercises/practice/luhn/.meta/example.s
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
.text
.globl valid

/* extern int valid(const char *value); */
valid:
mov x1, x0
mov x2, #0 /* digit count */
mov x3, #0 /* digit sum */

.first_scan:
ldrb w4, [x1], #1 /* load byte, post-increment */
cbz w4, .end_first_scan

cmp w4, #' '
beq .first_scan

sub w4, w4, #'0'
cmp w4, #10
bhs .reject /* unsigned >= */

add x2, x2, #1
b .first_scan

.end_first_scan:
mov x1, x0
cmp x2, #2
blt .reject

.second_scan:
ldrb w4, [x1], #1 /* load byte, post-increment */
cbz w4, .end_second_scan

cmp w4, #' '
beq .second_scan

sub w4, w4, #'0'
tst x2, #1
bne .add

lsl w4, w4, #1 /* multiply by 2 */
cmp w4, #10
blo .add /* unsigned < */

sub w4, w4, #9

.add:
add x3, x3, x4
sub x2, x2, #1
b .second_scan

.end_second_scan:
mov x6, #10
udiv x7, x3, x6 /* divide value by 10 */
msub x0, x7, x6, x3 /* remainder */

cmp x0, xzr
cset x0, eq
ret

.reject:
mov x0, #0
ret
76 changes: 76 additions & 0 deletions exercises/practice/luhn/.meta/tests.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# 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.

[792a7082-feb7-48c7-b88b-bbfec160865e]
description = "single digit strings can not be valid"

[698a7924-64d4-4d89-8daa-32e1aadc271e]
description = "a single zero is invalid"

[73c2f62b-9b10-4c9f-9a04-83cee7367965]
description = "a simple valid SIN that remains valid if reversed"

[9369092e-b095-439f-948d-498bd076be11]
description = "a simple valid SIN that becomes invalid if reversed"

[8f9f2350-1faf-4008-ba84-85cbb93ffeca]
description = "a valid Canadian SIN"

[1cdcf269-6560-44fc-91f6-5819a7548737]
description = "invalid Canadian SIN"

[656c48c1-34e8-4e60-9a5a-aad8a367810a]
description = "invalid credit card"

[20e67fad-2121-43ed-99a8-14b5b856adb9]
description = "invalid long number with an even remainder"

[7e7c9fc1-d994-457c-811e-d390d52fba5e]
description = "invalid long number with a remainder divisible by 5"

[ad2a0c5f-84ed-4e5b-95da-6011d6f4f0aa]
description = "valid number with an even number of digits"

[ef081c06-a41f-4761-8492-385e13c8202d]
description = "valid number with an odd number of spaces"

[bef66f64-6100-4cbb-8f94-4c9713c5e5b2]
description = "valid strings with a non-digit added at the end become invalid"

[2177e225-9ce7-40f6-b55d-fa420e62938e]
description = "valid strings with punctuation included become invalid"

[ebf04f27-9698-45e1-9afe-7e0851d0fe8d]
description = "valid strings with symbols included become invalid"

[08195c5e-ce7f-422c-a5eb-3e45fece68ba]
description = "single zero with space is invalid"

[12e63a3c-f866-4a79-8c14-b359fc386091]
description = "more than a single zero is valid"

[ab56fa80-5de8-4735-8a4a-14dae588663e]
description = "input digit 9 is correctly converted to output digit 9"

[b9887ee8-8337-46c5-bc45-3bcab51bc36f]
description = "very long input is valid"

[8a7c0e24-85ea-4154-9cf1-c2db90eabc08]
description = "valid luhn with an odd number of digits and non zero first digit"

[39a06a5a-5bad-4e0f-b215-b042d46209b1]
description = "using ascii value for non-doubled non-digit isn't allowed"

[f94cf191-a62f-4868-bc72-7253114aa157]
description = "using ascii value for doubled non-digit isn't allowed"

[8b72ad26-c8be-49a2-b99c-bcc3bf631b33]
description = "non-numeric, non-space char in the middle with a sum that's divisible by 10 isn't allowed"
36 changes: 36 additions & 0 deletions exercises/practice/luhn/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
AS = aarch64-linux-gnu-as
CC = aarch64-linux-gnu-gcc

CFLAGS = -g -Wall -Wextra -pedantic -Werror
LDFLAGS =

ALL_LDFLAGS = -pie -Wl,--fatal-warnings

ALL_CFLAGS = -std=c99 -fPIE $(CFLAGS)
ALL_LDFLAGS += $(LDFLAGS)

C_OBJS = $(patsubst %.c,%.o,$(wildcard *.c))
AS_OBJS = $(patsubst %.s,%.o,$(wildcard *.s))
ALL_OBJS = $(filter-out example.o,$(C_OBJS) $(AS_OBJS) vendor/unity.o)

CC_CMD = $(CC) $(ALL_CFLAGS) -c -o $@ $<

all: tests
qemu-aarch64 -L /usr/aarch64-linux-gnu ./$<

tests: $(ALL_OBJS)
@$(CC) $(ALL_CFLAGS) $(ALL_LDFLAGS) -o $@ $(ALL_OBJS)

%.o: %.s
@$(AS) -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
5 changes: 5 additions & 0 deletions exercises/practice/luhn/luhn.s
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.text
.globl valid

valid:
ret
Loading

0 comments on commit 924e6bb

Please sign in to comment.