Add README.md, go, and julia templates

koomen · koomen · commit f9edb8d3f27f · 2021-03-13T18:35:44.000-08:00
diff --git a/README.md b/README.md
@@ -0,0 +1,159 @@
+# eulercli Templates
+
+Templates for programming solutions to [Project Euler] problems.
+
+## Introduction
+
+This repository contains a set of [Project Euler] solution templates written in [julia] and [go]. 
+
+These templates are designed to be used with [eulercli] to generate ready-to-use "starting points" for solving Project Euler problems. This is a time-saver, especially if you plan on solving multiple problems.
+
+## Usage
+
+To use these templates, you'll need to install the [eulercli] tool.
+
+Next, create a directory for your Project Euler solutions.  We'll refer to this as your "project directory" going forward.
+
+```sh
+mkdir projecteuler
+cd projecteuler
+```
+
+### "Installing" the eulercli templates
+
+There are several ways to "install" these templates into your project directory.
+
+#### Installing with `eulercli pull`
+
+You can copy these templates into your `projecteuler` directory by running `eulercli pull` in that directory.
+
+```sh
+eulercli pull
+```
+
+At this point, your `projecteuler` directory should look like this
+
+```sh
+projecteuler/
+    eulercli-templates/
+        julia/
+            [...]
+        go/
+            [...]
+```
+
+`eulercli pull` downloads template files directly from [this github repository](https://github.com/koomen/eulercli-templates), and you can always update your templates by rerunning `eulercli pull`.  You can also modify these templates locally or add your own--see the [eulercli README][eulercli] for instructions.
+
+#### Installing with `git clone`
+
+From within your `projecteuler` directory:
+
+```sh
+git clone https://github.com/koomen/eulercli-templates
+```
+
+### Rendering templates for a specific Project Euler problem
+
+Once you've installed these templates in your project directory, you can use `eulercli generate` to render them for a specific Project Euler problem.
+
+For example, if you'd like to use the [julia programming language][julia] to solve [Problem #1](https://projecteuler.net/problem=1), run the following from within your project directory:
+
+```sh
+eulercli generate 1 --language julia
+```
+
+If you're doing this for the first time, you should see a new `julia` directory in your `projecteuler` directory:
+
+```sh
+projecteuler/
+    eulercli-templates/
+    julia/
+        initenv.jl
+        README.md
+        euler0001/
+            solution.jl
+```
+
+When you run `eulercli generate` again, eulercli will skip existing files as long as they are unchanged by the operation. So, for example, if you run
+
+```sh
+eulercli generate 2 --language julia
+```
+
+...you should see the following in your `projecteuler` directory:
+
+```sh
+projecteuler/
+    eulercli-templates/
+    julia/
+        initenv.jl
+        README.md
+        euler0001/
+            solution.jl
+        euler0002/
+            solution.jl
+```
+
+### Running and Benchmarking your solution program
+
+Once you've used `eulercli generate` to render your solution files, you can start work on solving your Project Euler problem.
+
+The process of building, running, and benchmarking your solution programs is different for each language.  You can find language-specific instructions in the language README.md files:
+
+- [julia README.md](julia/README.md)
+- [go README.md](go/README.md)
+
+Don't forget you can use `eulercli check` to [check your whether your solution is correct](https://github.com/koomen/eulercli/#check-your-answers-using-pipes).
+
+### Adding your own solution program templates
+
+When you run `eulercli generate --language <langauge>`, the tool will look for templates in `./eulercli-templates/<language>`.
+
+If you'd like to create templates for a new language or modify the templates for an existing language, you can do so by saving them in the `./eulercli-templates/<language>` directory.
+
+Template solution files and filenames can include [text/template package](https://golang.org/pkg/text/template/) directives with the following fields:
+
+- `{{.ProblemNum}}` - the problem number (e.g. "42")
+- `{{.PaddedProblemNum}}` - the problem number, padded with 0s (e.g. "0042")
+- `{{.ProblemText}}` - the problem text (e.g. "The nth term of the sequence of triangle...")
+- `{{.Answer}}` - The correct answer to the problem (e.g. "123")
+- `{{.AnswerMD5}}` - The correct answer to the problem, hashed using [MD5](https://en.wikipedia.org/wiki/MD5) (e.g. "ba1f2511fc30423bdbb183fe33f3dd0f")
+
+For example, calling
+
+```sh
+$ eulercli generate 42 --language julia
+```
+
+will render the following template file
+
+```
+./eulercli-templates/julia/src/euler{{.PaddedProblemNum}}/solution.jl
+```
+
+to the target output file
+
+```
+./julia/src/euler0042/solution.jl
+```
+
+If you find ways to improve existing template files or create useful new template files for an as-yet-unsupported language, consider [contributing to this project](#contributing)
+
+## Contributing
+
+Code contributions to eulercli-templates are encouraged and appreciated! If you'd like to contribute, clone this repository, commit your proposed changes, and create a pull request.
+
+<!-- Links -->
+
+[eulercli]: https://github.com/koomen/eulercli
+[go]: https://golang.org
+[julia]: https://julialang.org
+[Project Euler]: https://projecteuler.net
+
+
+
+
+
+
+
+
diff --git a/go/README.md b/go/README.md
@@ -0,0 +1,66 @@
+# Go solution templates
+
+This directory contains a set of [Project Euler](https://projecteuler.net) solution templates written in [go](https://golang.org/). 
+
+## Usage
+
+### Generating a new julia solution program
+
+You can use [eulercli](https://github.com/koomen/eulercli) to generate a new, ready-to-use solution program in go.  From your `projecteuler` directory, run
+
+```sh
+eulercli generate 1 --language go
+```
+
+If you're doing this for the first time, you should see a new `go` directory in your project directory:
+
+```sh
+projecteuler/
+    eulercli-templates/
+    go/
+        go.mod
+        README.md
+        euler0001/
+            euler0001.go
+            euler0001_test.go
+```
+
+### Completing your solution program
+
+Once you've used `eulercli generate` to render your templates for a new Project Euler problem, you're ready to solve the problem.  
+
+Your job is to complete the definition of the `solve()` function in `euler0001.go` such that it returns the correct answer to the appropriate Project Euler problem.
+
+
+### Running your solution program
+
+From within `projecteuler/go`, you can run your solution program using `go run`:
+
+```sh
+cd go
+go run euler0001/euler0001.go
+```
+
+As you're working on your solution, you can use `eulercli check` to check your answers:
+
+```sh
+go run euler0001/euler0001.go | eulercli check
+```
+
+See the [eulercli documentation](https://github.com/koomen/eulercli) for more details.
+
+### Benchmarking your solution
+
+To benchmark your solution, use `go test` with the `-bench` flag:
+
+```sh
+$ cd euler0001
+$ go test -bench=.
+goos: darwin
+goarch: amd64
+pkg: example.com/projecteuler/euler0001
+cpu: VirtualApple @ 2.50GHz
+BenchmarkSolve-8   	1000000000	         0.3153 ns/op
+PASS
+ok  	example.com/projecteuler/euler0001	0.893s
+```
diff --git a/go/euler{{.PaddedProblemNum}}/euler{{.PaddedProblemNum}}.go b/go/euler{{.PaddedProblemNum}}/euler{{.PaddedProblemNum}}.go
@@ -0,0 +1,32 @@
+/*
+Problem {{.ProblemNum}}
+https://projecteuler.net/problem={{.ProblemNum}}
+==========
+
+{{.ProblemText}}
+
+
+Solution
+========
+
+[Explain your solution here]
+
+*/
+
+package main
+
+import (
+	"fmt"
+)
+
+const PROBLEM_NUM = {{.ProblemNum}}
+
+func solve(verbose bool) int {
+	return 0
+}
+
+func main() {
+	fmt.Printf("Solving problem %d\n", PROBLEM_NUM)
+	answer := solve(true)
+	fmt.Printf("Obtained solution %d\n", answer)
+}
diff --git a/go/euler{{.PaddedProblemNum}}/euler{{.PaddedProblemNum}}_test.go b/go/euler{{.PaddedProblemNum}}/euler{{.PaddedProblemNum}}_test.go
@@ -0,0 +1,17 @@
+package main
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestSolve(t *testing.T) {
+	assert.Equal(t, 0, solve(false))
+}
+
+func BenchmarkSolve(b *testing.B) {
+	for n := 0; n < b.N; n++ {
+		solve(false)
+	}
+}
diff --git a/go/go.mod b/go/go.mod
@@ -0,0 +1,5 @@
+module example.com/projecteuler
+
+go 1.16
+
+require github.com/stretchr/testify v1.7.0 // indirect
diff --git a/julia/README.md b/julia/README.md
@@ -0,0 +1,79 @@
+# Julia solution templates
+
+This directory contains a set of [Project Euler](https://projecteuler.net) solution templates written in [julia](https://julialang.org/). 
+
+## Usage
+
+### Generating a new julia solution program
+
+You can use [eulercli](https://github.com/koomen/eulercli) to generate a new, ready-to-use solution program in julia.  From your `projecteuler` directory, run
+
+```sh
+eulercli generate 1 --language julia
+```
+
+If you're doing this for the first time, you should see a new `julia` directory in your project directory:
+
+```sh
+projecteuler/
+    eulercli-templates/
+    julia/
+        initenv.jl
+        README.md
+        euler0001/
+            solution.jl
+```
+
+### Completing your solution program
+
+Once you've used `eulercli generate` to render your Julia templates for a new Project Euler problem, you're ready to solve the problem.  
+
+Your job is to complete the definition of the `solve()` function in `solution.jl` such that it returns the correct answer to the appropriate Project Euler problem.
+
+
+### Running your solution program
+
+First, initialize your Julia environment:
+
+```sh
+cd julia
+julia initenv.jl
+```
+
+Julia will create a new environment in `projecteuler/julia/projecteulerenv/`. **Note:** make sure to run `initenv.jl` in `projecteuler/julia`, *not* `projecteuler/eulercli-templates/julia`!
+
+When this is done, you're ready to run your solution program:
+
+```sh
+cd euler0001
+julia solution.jl
+```
+
+As you're working on your solution, you can use `eulercli check` to check your answers:
+
+```sh
+julia solution.jl | eulercli check
+```
+
+See the [eulercli documentation](https://github.com/koomen/eulercli) for more details.
+
+### Benchmarking your solution
+
+If it is run with the `-b` or `--benchmark` flag, `solution.jl` will use Julia's [BenchmarkTools](https://github.com/JuliaCI/BenchmarkTools.jl) package to measure the performance of your `solve()` function.
+
+```sh
+$ julia solution.jl -b
+ Activating environment at `~/git/projecteuler/julia/projecteulerenv/Project.toml`
+Benchmarking solution...
+BenchmarkTools.Trial:
+  memory estimate:  7.94 KiB
+  allocs estimate:  1
+  --------------
+  minimum time:     17.675 ms (0.00% GC)
+  median time:      18.695 ms (0.00% GC)
+  mean time:        19.194 ms (0.00% GC)
+  maximum time:     24.503 ms (0.00% GC)
+  --------------
+  samples:          261
+  evals/sample:     1
+```
diff --git a/julia/initenv.jl b/julia/initenv.jl
@@ -0,0 +1,25 @@
+"""
+init.jl
+
+Run this code to initialize your Project Euler julia environment.  Problem solution
+programs should activate the projecteulerenv environment.
+
+    import Pkg
+    Pkg.activate("projecteulerenv")
+
+New modules and packages can be added "in-line" in a solution program or in this
+program via 
+
+    Pkg.add("MyPackage")
+"""
+
+import Pkg
+
+Pkg.activate("projecteulerenv")
+
+Pkg.add("BenchmarkTools")
+Pkg.add("DataStructures")
+Pkg.add("Combinatorics")
+Pkg.add("Primes")
+Pkg.add("Multisets")
+
diff --git a/julia/src/euler{{.PaddedProblemNum}}/solution.jl b/julia/src/euler{{.PaddedProblemNum}}/solution.jl
