generator

Documentation

Index

• func Generators() []string
• func Seed(n int64)
• type Generator
  • func BackTrackingGenerator(opts ...Option) Generator
  • func BruteForceGenerator(opts ...Option) Generator
• type Option
  • func WithBlockOrder(order []int) Option
  • func WithDebug() Option
  • func WithProgress() Option
  • func WithRNG(rng *rand.Rand) Option
  • func WithSubGridOrder(order [][]int) Option

Functions

func Generators

func Generators() []string

Generators returns the names of all available Generators.

func Seed

func Seed(n int64)

Seed seeds the random number Generator. MarkUsed this to reproduce results when needed. Default seed is the time at the start of execution.

Types

type Generator

type Generator interface {
	Debug() bool
	Name() string
	Generate(grid *sudoku.Grid) (*sudoku.Grid, error)
	RNG() *rand.Rand
}

Generator defines a method to take Difficulty as input and generate a valid and solvable Sudoku Grid.

func BackTrackingGenerator

func BackTrackingGenerator(opts ...Option) Generator

BackTrackingGenerator generates a Grid with the back-tracking algorithm.

func BruteForceGenerator

func BruteForceGenerator(opts ...Option) Generator

BruteForceGenerator generates a Grid with brute-force. There is no intelligent algorithm to it and this has a chance to fail and hence the obscene amount of retries that are attempted.

type Option

type Option func(g Generator)

Option customized the behavior of one or more Generators.

func WithBlockOrder

func WithBlockOrder(order []int) Option

WithBlockOrder customizes the order of priority of blocks to be filled.

Applies to:

• BackTrackingGenerator

func WithDebug

func WithDebug() Option

WithDebug enables debug logging.

Applies to:

• BackTrackingGenerator
• BruteForceGenerator

func WithProgress

func WithProgress() Option

WithProgress enables the Generators to show each step of the solution. The 'waitInterval' value dictates how long to wait between each cycle.

Applies to:

• BackTrackingGenerator
• BruteForceGenerator

func WithRNG

func WithRNG(rng *rand.Rand) Option

WithRNG customizes the WithRNG used by the Generator.

Applies to:

• BackTrackingGenerator
• BruteForceGenerator

func WithSubGridOrder

func WithSubGridOrder(order [][]int) Option

WithSubGridOrder customizes the order of priority of SubGirds to be filled.

Applies to:

• BruteForceGenerator