pu

package module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 16, 2015 License: MIT Imports: 4 Imported by: 0

README

pu

pu is a library with a little boilerplate to help with the repetitive creation of new Project Euler projects.

euler is a command-line tool to grab the problem from the website and generate a template for each problem as you go.

Why?

Project euler contains over 500 problems, so having a standard and quick way of starting a new problems is helpful.

One simple command: euler -new 1 and you're ready to do problem 1 with this: template

Knowing which problems are solved is as easy as go test ./... because the template includes a test to see if the problem is solved.

Getting started:

Install the tool:

go get -u -v github.com/jacobhands/pu/euler

Create a folder 'p1' containing 'p1.go' and 'p1_test.go' with starting templates in current directory:

euler -new 1

(Examples: p1.go, p1_test.go)

Test all problems:

go test ./...

Test and benchmark all problems

go test -bench=. ./...

Contributing

Contributions are welcome. Please read CONTRIBUTING.md before submitting PR's.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Problem

type Problem struct {
	ID            int
	Solver        func() string
	CorrectAnswer string
}

Problem is a Project Euler (.net) problem

func (Problem) Answer

func (p Problem) Answer()

Answer prints out the answer for viewing.

func (Problem) Bench

func (p Problem) Bench(b *testing.B)

Bench benchmarks the problem. Great for testing for improvements.

func (Problem) Test

func (p Problem) Test(t *testing.T)

Test ensures that the answer is correct. Will fail until problem is solved.

Directories

Path Synopsis
example
p1
Project Euler: Problem 1 Title: Multiples of 3 and 5 Info: Published on Friday, 5th October 2001, 06:00 pm; Solved by 521276; Difficulty rating: 5% Description: If we list all the natural numbers below 10 that are multiples of 3 or 5, we get 3, 5, 6 and 9.
Project Euler: Problem 1 Title: Multiples of 3 and 5 Info: Published on Friday, 5th October 2001, 06:00 pm; Solved by 521276; Difficulty rating: 5% Description: If we list all the natural numbers below 10 that are multiples of 3 or 5, we get 3, 5, 6 and 9.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL