Skip to content
This repository has been archived by the owner on Nov 17, 2024. It is now read-only.

Commit

Permalink
clean-up final repo
Browse files Browse the repository at this point in the history
  • Loading branch information
@mstksg
mstksg committed Dec 21, 2023
1 parent af17db7 commit 4e0b6d9
Show file tree
Hide file tree
Showing 10 changed files with 5 additions and 1,458 deletions.
306 changes: 5 additions & 301 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Advent of Code 2023
This file generated by the build script at ./Build.hs
-->

*[2016][]* / *[2017][]* / *[2018][]* / *[2019][]* / *[2020][]* / *[2021][]* / *[2022][]* / *2023*
*[2016][]* / *[2017][]* / *[2018][]* / *[2019][]* / *[2020][]* / *[2021][]* / *[2022][]* / *[2023][]*

[2016]: https://github.com/mstksg/advent-of-code-2016
[2017]: https://github.com/mstksg/advent-of-code-2017
Expand All @@ -14,304 +14,8 @@ This file generated by the build script at ./Build.hs
[2020]: https://github.com/mstksg/advent-of-code-2020
[2021]: https://github.com/mstksg/advent-of-code-2021
[2022]: https://github.com/mstksg/advent-of-code-2022
[2023]: https://github.com/mstksg/advent-of-code-2023

It's the most wonderful time of the year!

My [Advent of Code 2023][aoc] Haskell solutions here, along with an automated
fetching, testing, running environment (powered by the
*[advent-of-code-api][]* library). The interactive development environment and
runner/bench marker/viewer/tester has been pulled out [here][dev], so this is
implemented as "fork" of it with my own solutions and reflections.

Check out the [reflections][] (with [rss feed][rss]) and [package
haddocks][haddock] --- more info below!

[aoc]: https://adventofcode.com/2023
[haddock]: https://mstksg.github.io/advent-of-code-2023/
[advent-of-code-api]: https://hackage.haskell.org/package/advent-of-code-api
[dev]: https://github.com/mstksg/advent-of-code-dev

[Reflections and Benchmarks][reflections]
-----------------------------------------

[Available as RSS Feed][rss]

[rss]: http://feeds.feedburner.com/jle-advent-of-code-2023

| Challenge | Reflections | Code | Rendered | Benchmarks |
| --------- | ----------- | --------- | ---------- | ---------- |
| Day 1 | [x][d01r] | [x][d01g] | [x][d01h] | [x][d01b] |
| Day 2 | [x][d02r] | [x][d02g] | [x][d02h] | [x][d02b] |
| Day 3 | | [x][d03g] | [x][d03h] | [x][d03b] |
| Day 4 | | [x][d04g] | [x][d04h] | [x][d04b] |
| Day 5 | [x][d05r] | [x][d05g] | [x][d05h] | [x][d05b] |
| Day 6 | | | | |
| Day 7 | | | | |
| Day 8 | | | | |
| Day 9 | | | | |
| Day 10 | | | | |
| Day 11 | | | | |
| Day 12 | | | | |
| Day 13 | | | | |
| Day 14 | | | | |
| Day 15 | | | | |
| Day 16 | | | | |
| Day 17 | | | | |
| Day 18 | | | | |
| Day 19 | | | | |
| Day 20 | | | | |
| Day 21 | | | | |
| Day 22 | | | | |
| Day 23 | | | | |
| Day 24 | | | | |
| Day 25 | | | | |

"Rendered" links go to haddock source renders for code, with reflections in the
documentation. Haddock source renders have hyperlinked identifiers,
so you can follow any unrecognized identifiers to see where I have defined them
in the library.

[reflections]: https://github.com/mstksg/advent-of-code-2023/blob/master/reflections.md

### `:~>` type

If you're looking at my actual github solutions, you'll notice that this year
I'm implementing my solutions in terms of a `:~>` record type:

```haskell
data a :~> b = MkSol
{ sParse :: String -> Maybe a -- ^ parse input into an `a`
, sSolve :: a -> Maybe b -- ^ solve an `a` input to a `b` solution
, sShow :: b -> String -- ^ print out the `b` solution for submission
}
```

An `a :~> b` is a solution to a challenge expecting input of type `a` and
producing answers of type `b`. It also packs in functions to parse a `String`
into an `a`, and functions to show a `b` as a `String` to submit as an answer.

This helps me mentally separate out parsing, solving, and showing, allowing for
some cleaner code and an easier time planning my solution.

Such a challenge can be "run" on string inputs by feeding the string into
`sParse`, then `sSolve`, then `sShow`:

```haskell
-- | Run a ':~>' on some input, retuning 'Maybe'
runSolution :: Challenge -> String -> Maybe String
runSolution MkSol{..} s = do
x <- sParse s
y <- sSolve x
pure (sShow y)
```

In the actual library, I have `runSolution` return an `Either` so I can debug
which stage the error happened in.

You might also notice the function `dyno_`, used like `dyno_ "limit" 10000`. This
is how I implement parameters in problems that vary between test data and
actual input. For example, Day 6 involved finding points that had a total
distance of less than 10000, but for the test input, we found the points that
had a total distance of less than 32. So, I have a system that lets me write
`dyno_ "limit" 10000` in my code instead of hard-coding in `10000`. This
`10000` would be replaced by `32` when running with test data (which is parsed
from [this file][7btest])

[7btest]: https://github.com/mstksg/advent-of-code-2018/blob/master/test-data/06b.txt

Interactive
-----------

The *[AOC.Run.Interactive][interactive]* module has code (powered by
*[advent-of-code-api][]*) for testing your solutions and submitting within
GHCI, so you don't have to re-compile. If you edit your solution programs, they
are automatically updated when you hit `:r` in ghci.

[interactive]: https://mstksg.github.io/advent-of-code-2023/AOC2023-Run-Interactive.html

```haskell
ghci> execSolution_ $ solSpec 'day02a -- get answer for challenge based on solution
ghci> testSolution_ $ solSpec 'day02a -- run solution against test suite
ghci> viewPrompt_ $ solSpec 'day02a -- view the prompt for a part
ghci> waitForPrompt_ $ solSpec 'day02a -- count down to the prompt for a part
ghci> submitSolution_ $ solSpec 'day02a -- submit a solution, and retry after cooldown automatically
```

These are loaded with session key stored in the configuration file (see next
section).

Executable
----------

Comes with test examples given in problems.

You can install using `stack`:

```bash
$ git clone https://github.com/mstksg/advent-of-code-2023
$ cd advent-of-code-2023
$ stack setup
$ stack install
```

The executable `aoc2023` includes a testing and benchmark suite, as well as a
way to view prompts within the command line:

```
$ aoc2023 --help
aoc2023 - Advent of Code 2023 challenge runner
Usage: aoc2023 [-c|--config PATH] COMMAND
Run challenges from Advent of Code 2023. Available days: 1, 2, 3 (..)
Available options:
-c,--config PATH Path to configuration file (default: aoc-conf.yaml)
-h,--help Show this help text
Available commands:
run Run, test, and benchmark challenges
view View a prompt for a given challenge
submit Test and submit answers for challenges
test Alias for run --test
bench Alias for run --bench
countdown Alias for view --countdown
$ aoc2023 run 3 b
>> Day 03b
>> [✓] 243
```

You can supply input via stdin with `--stdin`:

```
$ aoc2023 run 1 --stdin
>> Day 01a
+1
+2
+1
-3
<Ctrl+D>
[?] 1
>> Day 01b
[?] 1
```

Benchmarking is implemented using *criterion*

```
$ aoc2023 bench 2
>> Day 02a
benchmarking...
time 1.317 ms (1.271 ms .. 1.392 ms)
0.982 R² (0.966 R² .. 0.999 R²)
mean 1.324 ms (1.298 ms .. 1.373 ms)
std dev 115.5 μs (77.34 μs .. 189.0 μs)
variance introduced by outliers: 65% (severely inflated)
>> Day 02b
benchmarking...
time 69.61 ms (68.29 ms .. 72.09 ms)
0.998 R² (0.996 R² .. 1.000 R²)
mean 69.08 ms (68.47 ms .. 69.99 ms)
std dev 1.327 ms (840.8 μs .. 1.835 ms)
```

Test suites run the example problems given in the puzzle description, and
outputs are colorized in ANSI terminals.

```
$ aoc2023 test 1
>> Day 01a
[✓] (3)
[✓] (3)
[✓] (0)
[✓] (-6)
[✓] Passed 4 out of 4 test(s)
[✓] 416
>> Day 01b
[✓] (2)
[✓] (0)
[✓] (10)
[✓] (5)
[✓] (14)
[✓] Passed 5 out of 5 test(s)
[✓] 56752
```

This should only work if you're running `aoc2023` in the project directory.

**To run on actual inputs**, the executable expects inputs to be found in the
folder `data/XX.txt` in the directory you are running in. That is, the input
for Day 7 will be expected at `data/07.txt`.

*aoc2023 will download missing input files*, but requires a session token.
This can be provided in `aoc-conf.yaml`:

```yaml
session: [[ session token goes here ]]
```
Session keys are also required to download "Part 2" prompts for each challenge.
You can "lock in" your current answers (telling the executable that those are
the correct answers) by passing in `--lock`. This will lock in any final
puzzle solutions encountered as the verified official answers. Later, if you
edit or modify your solutions, they will be checked on the locked-in answers.

These are stored in `data/ans/XXpart.txt`. That is, the target output for Day 7
(Part 2, `b`) will be expected at `data/ans/07b.txt`. You can also manually
edit these files.

You can view prompts: (use `--countdown` to count down until a prompt is
released, and display immediately)

```
$ aoc2023 view 3 b
>> Day 03b
--- Part Two ---
----------------

Amidst the chaos, you notice that exactly one claim doesn't overlap by
even a single square inch of fabric with any other claim. If you can
somehow draw attention to it, maybe the Elves will be able to make
Santa's suit after all!

For example, in the claims above, only claim `3` is intact after all
claims are made.

*What is the ID of the only claim that doesn't overlap?*
```
You can also submit answers:
```
$ aoc2023 submit 1 a
```
Submissions will automatically run the test suite. If any tests fail, you will
be asked to confirm submission or else abort. The submit command will output
the result of your submission: The message from the AoC website, and whether or
not your answer was correct (or invalid or ignored). Answers that are
confirmed correct will be locked in and saved for future testing against, in
case you change your solution.
All networking features are powered by *[advent-of-code-api][]*.
[d01g]: https://github.com/mstksg/advent-of-code-2023/blob/master/src/AOC/Challenge/Day01.hs
[d01h]: https://mstksg.github.io/advent-of-code-2023/src/AOC.Challenge.Day01.html
[d01r]: https://github.com/mstksg/advent-of-code-2023/blob/master/reflections.md#day-1
[d01b]: https://github.com/mstksg/advent-of-code-2023/blob/master/reflections.md#day-1-benchmarks
[d02g]: https://github.com/mstksg/advent-of-code-2023/blob/master/src/AOC/Challenge/Day02.hs
[d02h]: https://mstksg.github.io/advent-of-code-2023/src/AOC.Challenge.Day02.html
[d02r]: https://github.com/mstksg/advent-of-code-2023/blob/master/reflections.md#day-2
[d02b]: https://github.com/mstksg/advent-of-code-2023/blob/master/reflections.md#day-2-benchmarks
[d03g]: https://github.com/mstksg/advent-of-code-2023/blob/master/src/AOC/Challenge/Day03.hs
[d03h]: https://mstksg.github.io/advent-of-code-2023/src/AOC.Challenge.Day03.html
[d03b]: https://github.com/mstksg/advent-of-code-2023/blob/master/reflections.md#day-3-benchmarks
[d04g]: https://github.com/mstksg/advent-of-code-2023/blob/master/src/AOC/Challenge/Day04.hs
[d04h]: https://mstksg.github.io/advent-of-code-2023/src/AOC.Challenge.Day04.html
[d04b]: https://github.com/mstksg/advent-of-code-2023/blob/master/reflections.md#day-4-benchmarks
[d05g]: https://github.com/mstksg/advent-of-code-2023/blob/master/src/AOC/Challenge/Day05.hs
[d05h]: https://mstksg.github.io/advent-of-code-2023/src/AOC.Challenge.Day05.html
[d05r]: https://github.com/mstksg/advent-of-code-2023/blob/master/reflections.md#day-5
[d05b]: https://github.com/mstksg/advent-of-code-2023/blob/master/reflections.md#day-5-benchmarks
In-progress master repo that's eventually going to subsume my individual year
repos, and maybe even include non-haskell. In the meanwhile, check out the
yearly repositories above.
2 changes: 0 additions & 2 deletions Setup.hs
View file

This file was deleted.

Loading

0 comments on commit 4e0b6d9

Please sign in to comment.