diff --git a/flags/parse.go b/flags/parse.go new file mode 100644 index 0000000..991da21 --- /dev/null +++ b/flags/parse.go @@ -0,0 +1,136 @@ +package flags + +import ( + "flag" + "fmt" + "log" + "os" + "runtime" +) + +func (flags *Flags) ParseFlags() { + + // Define parameters + flag.StringVar(&flags.Row1, "row1", "000000000", "1st row of the sudoku puzzle.") + flag.StringVar(&flags.Row2, "row2", "000000000", "2nd row of the sudoku puzzle.") + flag.StringVar(&flags.Row3, "row3", "000000000", "4rd row of the sudoku puzzle.") + flag.StringVar(&flags.Row4, "row4", "000000000", "4th row of the sudoku puzzle.") + flag.StringVar(&flags.Row5, "row5", "000000000", "5th row of the sudoku puzzle.") + flag.StringVar(&flags.Row6, "row6", "000000000", "6th row of the sudoku puzzle.") + flag.StringVar(&flags.Row7, "row7", "000000000", "7th row of the sudoku puzzle.") + flag.StringVar(&flags.Row8, "row8", "000000000", "8th row of the sudoku puzzle.") + flag.StringVar(&flags.Row9, "row9", "000000000", "9th row of the sudoku puzzle.") + flag.IntVar(&flags.NumCPUs, "numcpu", runtime.NumCPU(), "Number of CPU cores to assign to this task.") + flag.IntVar(&flags.Split, "split", 1, "Split the tasks in n parts. This depends on the availability of the first row.") + flag.IntVar(&flags.Part, "part", 1, "Process part x in n parts. Cannot be lower than 1, or higher than specified in split.") + + // Parse the flags + flag.Parse() + + // Process any changes to the CPU usage. + if flags.NumCPUs <= 0 { + log.Printf("ERROR: Number of CPU cores must be 1 or higher.\n\n") + flags.printUsage() + os.Exit(1) + } + + if flags.NumCPUs != runtime.NumCPU() { + runtime.GOMAXPROCS(flags.NumCPUs) + } + + // Process rows + if flags.Row1 == "000000000" || flags.Row2 == "000000000" || flags.Row3 == "000000000" || flags.Row4 == "000000000" || flags.Row5 == "000000000" || flags.Row6 == "000000000" || flags.Row7 == "000000000" || flags.Row8 == "000000000" || flags.Row9 == "000000000" { + log.Printf("ERROR: All parameters must be entered.\n\n") + flags.printUsage() + os.Exit(1) + } + + // Validate the row (never trust user input) + flags.validateRow("row1", flags.Row1) + flags.validateRow("row2", flags.Row2) + flags.validateRow("row3", flags.Row3) + flags.validateRow("row4", flags.Row4) + flags.validateRow("row5", flags.Row5) + flags.validateRow("row6", flags.Row6) + flags.validateRow("row7", flags.Row7) + flags.validateRow("row8", flags.Row8) + flags.validateRow("row9", flags.Row9) + + // Process workload splitting + // Ensure split and part are 1 or higher + if flags.Split <= 0 || flags.Part <= 0 { + log.Printf("ERROR: '-split' and '-part' need to be 1 or higher.\n") + flags.printUsage() + os.Exit(1) + } + + // Ensure part is between 1 and split + if flags.Part > flags.Split { + log.Printf("ERROR: '-part' cannot be bigger than `-split`.\n") + flags.printUsage() + os.Exit(1) + } + +} + +func (flags *Flags) validateRow(name string, row string) { + + var found bool + var double bool + count := make(map[rune]int) + + // 1. Make sure the row is 9 in length + if len(row) != 9 { + log.Printf("ERROR: Invalid length of %s (%s), must be 9 numbers\n\n", name, row) + flags.printUsage() + os.Exit(1) + } + + // 2. Ensure all digits are numbers + for _, value := range row { + found = flags.validChar(value) + } + + if !found { + log.Printf("ERROR: Invalid character of %s (%s), must be 9 numbers\n\n", name, row) + flags.printUsage() + os.Exit(1) + } + + // 3. Ensure all digits (except zero) are there only once + for _, digits := range row { + count[digits] = count[digits] + 1 + } + + for key, value := range count { + if value > 1 && key != 48 { + double = true + } + } + + if double { + log.Printf("ERROR: Double character of %s (%s), numbers between 1 and 9 may only be entered once\n\n", name, row) + flags.printUsage() + os.Exit(1) + } + +} + +func (flags *Flags) validChar(char rune) (valid bool) { + decvals := [10]int{48, 49, 50, 51, 52, 53, 54, 55, 56, 57} + + for _, value := range decvals { + if char == rune(value) { + valid = true + } + } + + return +} + +func (flags *Flags) printUsage() { + fmt.Fprintf(flag.CommandLine.Output(), "Usage of %s:\n", os.Args[0]) + fmt.Fprintf(flag.CommandLine.Output(), "\nPut every row of a Sudoku puzzle as paramters.\nUse '0' for what is currently blank in the puzzle you wish to solve.\n\n") + fmt.Fprintf(flag.CommandLine.Output(), "Example: %s -row1 ... -row2 ... -row3 ... (etc)\n\n", os.Args[0]) + flag.PrintDefaults() +} diff --git a/flags/transfer.go b/flags/transfer.go new file mode 100644 index 0000000..d77f8a9 --- /dev/null +++ b/flags/transfer.go @@ -0,0 +1,19 @@ +package flags + +import "gitea.ligthert.net/golang/sudoku-funpark/solver" + +func (flags *Flags) TransferConfig(solver *solver.Solver) { + // Parse variables parsed from the flags to solver + solver.NumCPUs = flags.NumCPUs + solver.Split = flags.Split + solver.Part = flags.Part + solver.Row1 = flags.Row1 + solver.Row2 = flags.Row2 + solver.Row3 = flags.Row3 + solver.Row4 = flags.Row4 + solver.Row5 = flags.Row5 + solver.Row6 = flags.Row6 + solver.Row7 = flags.Row7 + solver.Row8 = flags.Row8 + solver.Row9 = flags.Row9 +} diff --git a/flags/types.go b/flags/types.go new file mode 100644 index 0000000..8d03d81 --- /dev/null +++ b/flags/types.go @@ -0,0 +1,16 @@ +package flags + +type Flags struct { + Row1 string + Row2 string + Row3 string + Row4 string + Row5 string + Row6 string + Row7 string + Row8 string + Row9 string + NumCPUs int + Split int + Part int +} diff --git a/main.go b/main.go index 21a09e0..311ecd4 100644 --- a/main.go +++ b/main.go @@ -1,10 +1,47 @@ package main import ( + "log" + "runtime" + "strconv" + + "gitea.ligthert.net/golang/sudoku-funpark/flags" "gitea.ligthert.net/golang/sudoku-funpark/solver" ) func main() { - // Run the meat of the program - solver.Run() + // Instantiate the interfaces + solver := solver.Solver{} + flags := flags.Flags{} + + // Parse and handle flags + flags.ParseFlags() + flags.TransferConfig(&solver) + + // Report number of CPUs being used, if set. + if runtime.NumCPU() != solver.NumCPUs { + log.Println("Using " + strconv.Itoa(solver.NumCPUs) + " CPUs, (was " + strconv.Itoa(runtime.NumCPU()) + ")") + } + + // Load blocks from CSV file + solver.LoadBlocks() + + // Find rows that fit with the entered rows + solver.PopulateBlocks() + + // If needed, split the workload + // May exit and throw an error if the work load isn't viable + if solver.Split != 1 { + solver.SelectWorkload() + } + + // Print the total number of solutions to validate + log.Println("Number of (potential) solutions:", solver.Iter) + + // Check the number of solutions + go solver.CheckCombinations() + solver.Tracker() + + // Print the valid solutions + solver.PrintSolutions() } diff --git a/solver/blocks.go b/solver/blocks.go index ff06afd..0ac1c83 100644 --- a/solver/blocks.go +++ b/solver/blocks.go @@ -13,7 +13,7 @@ import ( //go:embed blocks.csv var f embed.FS -func (solver *Solver) loadBlocks() { +func (solver *Solver) LoadBlocks() { defer solver.timeTrack(time.Now(), "Loaded blocks") log.Println("Loading blocks") diff --git a/solver/flags.go b/solver/flags.go deleted file mode 100644 index b929233..0000000 --- a/solver/flags.go +++ /dev/null @@ -1,163 +0,0 @@ -package solver - -import ( - "flag" - "fmt" - "log" - "os" - "runtime" -) - -func (solver *Solver) parseFlags() { - - // Define variables - var row1 string - var row2 string - var row3 string - var row4 string - var row5 string - var row6 string - var row7 string - var row8 string - var row9 string - var split int - var part int - - // Define parameters - flag.StringVar(&row1, "row1", "000000000", "1st row of the sudoku puzzle.") - flag.StringVar(&row2, "row2", "000000000", "2nd row of the sudoku puzzle.") - flag.StringVar(&row3, "row3", "000000000", "4rd row of the sudoku puzzle.") - flag.StringVar(&row4, "row4", "000000000", "4th row of the sudoku puzzle.") - flag.StringVar(&row5, "row5", "000000000", "5th row of the sudoku puzzle.") - flag.StringVar(&row6, "row6", "000000000", "6th row of the sudoku puzzle.") - flag.StringVar(&row7, "row7", "000000000", "7th row of the sudoku puzzle.") - flag.StringVar(&row8, "row8", "000000000", "8th row of the sudoku puzzle.") - flag.StringVar(&row9, "row9", "000000000", "9th row of the sudoku puzzle.") - flag.IntVar(&solver.numCPUs, "numcpu", runtime.NumCPU(), "Number of CPU cores to assign to this task.") - flag.IntVar(&split, "split", 1, "Split the tasks in n parts. This depends on the availability of the first row.") - flag.IntVar(&part, "part", 1, "Process part x in n parts. Cannot be lower than 1, or higher than specified in split.") - - // Parse the flags - flag.Parse() - - // Process any changes to the CPU usage. - if solver.numCPUs <= 0 { - log.Printf("ERROR: Number of CPU cores must be 1 or higher.\n\n") - solver.printUsage() - os.Exit(1) - } - - if solver.numCPUs != runtime.NumCPU() { - runtime.GOMAXPROCS(solver.numCPUs) - } - - // Process rows - if row1 == "000000000" || row2 == "000000000" || row3 == "000000000" || row4 == "000000000" || row5 == "000000000" || row6 == "000000000" || row7 == "000000000" || row8 == "000000000" || row9 == "000000000" { - log.Printf("ERROR: All parameters must be entered.\n\n") - solver.printUsage() - os.Exit(1) - } - - // Validate the row (never trust user input) - solver.validateRow("row1", row1) - solver.validateRow("row2", row2) - solver.validateRow("row3", row3) - solver.validateRow("row4", row4) - solver.validateRow("row5", row5) - solver.validateRow("row6", row6) - solver.validateRow("row7", row7) - solver.validateRow("row8", row8) - solver.validateRow("row9", row9) - - // Put entries in into the struct - solver.row1 = row1 - solver.row2 = row2 - solver.row3 = row3 - solver.row4 = row4 - solver.row5 = row5 - solver.row6 = row6 - solver.row7 = row7 - solver.row8 = row8 - solver.row9 = row9 - - // Process workload splitting - // Ensure split and part are 1 or higher - if split <= 0 || part <= 0 { - log.Printf("ERROR: '-split' and '-part' need to be 1 or higher.\n") - solver.printUsage() - os.Exit(1) - } - - // Ensure part is between 1 and split - if part > split { - log.Printf("ERROR: '-part' cannot be bigger than `-split`.\n") - solver.printUsage() - os.Exit(1) - } - - solver.split = split - solver.part = part - -} - -func (solver *Solver) validateRow(name string, row string) { - - var found bool - var double bool - count := make(map[rune]int) - - // 1. Make sure the row is 9 in length - if len(row) != 9 { - log.Printf("ERROR: Invalid length of %s (%s), must be 9 numbers\n\n", name, row) - solver.printUsage() - os.Exit(1) - } - - // 2. Ensure all digits are numbers - for _, value := range row { - found = solver.validChar(value) - } - - if !found { - log.Printf("ERROR: Invalid character of %s (%s), must be 9 numbers\n\n", name, row) - solver.printUsage() - os.Exit(1) - } - - // 3. Ensure all digits (except zero) are there only once - for _, digits := range row { - count[digits] = count[digits] + 1 - } - - for key, value := range count { - if value > 1 && key != 48 { - double = true - } - } - - if double { - log.Printf("ERROR: Double character of %s (%s), numbers between 1 and 9 may only be entered once\n\n", name, row) - solver.printUsage() - os.Exit(1) - } - -} - -func (solver *Solver) validChar(char rune) (valid bool) { - decvals := [10]int{48, 49, 50, 51, 52, 53, 54, 55, 56, 57} - - for _, value := range decvals { - if char == rune(value) { - valid = true - } - } - - return valid -} - -func (solver *Solver) printUsage() { - fmt.Fprintf(flag.CommandLine.Output(), "Usage of %s:\n", os.Args[0]) - fmt.Fprintf(flag.CommandLine.Output(), "\nPut every row of a Sudoku puzzle as paramters.\nUse '0' for what is currently blank in the puzzle you wish to solve.\n\n") - fmt.Fprintf(flag.CommandLine.Output(), "Example: %s -row1 ... -row2 ... -row3 ... (etc)\n\n", os.Args[0]) - flag.PrintDefaults() -} diff --git a/solver/printers.go b/solver/printers.go index 792d266..3764a11 100644 --- a/solver/printers.go +++ b/solver/printers.go @@ -5,7 +5,7 @@ import ( "log" ) -func (solver *Solver) printSolutions() { +func (solver *Solver) PrintSolutions() { for solutionIndex, solution := range solver.solutions { log.Printf("\nSolution #%d:", solutionIndex+1) //fmt.Println(solution) diff --git a/solver/processing.go b/solver/processing.go index c61a04d..8c4d162 100644 --- a/solver/processing.go +++ b/solver/processing.go @@ -6,23 +6,23 @@ import ( "time" ) -func (solver *Solver) populateBlocks() { +func (solver *Solver) PopulateBlocks() { defer solver.timeTrack(time.Now(), "Populated blocks") log.Println("Populating blocks") - solver.findBlocks(&solver.row1, &solver.row1s) - solver.findBlocks(&solver.row2, &solver.row2s) - solver.findBlocks(&solver.row3, &solver.row3s) - solver.findBlocks(&solver.row4, &solver.row4s) - solver.findBlocks(&solver.row5, &solver.row5s) - solver.findBlocks(&solver.row6, &solver.row6s) - solver.findBlocks(&solver.row7, &solver.row7s) - solver.findBlocks(&solver.row8, &solver.row8s) - solver.findBlocks(&solver.row9, &solver.row9s) + solver.findBlocks(&solver.Row1, &solver.row1s) + solver.findBlocks(&solver.Row2, &solver.row2s) + solver.findBlocks(&solver.Row3, &solver.row3s) + solver.findBlocks(&solver.Row4, &solver.row4s) + solver.findBlocks(&solver.Row5, &solver.row5s) + solver.findBlocks(&solver.Row6, &solver.row6s) + solver.findBlocks(&solver.Row7, &solver.row7s) + solver.findBlocks(&solver.Row8, &solver.row8s) + solver.findBlocks(&solver.Row9, &solver.row9s) // This calculates and stores the total number of solutions to validate. - solver.iter = int64(len(solver.row1s)) * int64(len(solver.row2s)) * int64(len(solver.row3s)) * int64(len(solver.row4s)) * int64(len(solver.row5s)) * int64(len(solver.row6s)) * int64(len(solver.row7s)) * int64(len(solver.row8s)) * int64(len(solver.row9s)) + solver.Iter = int64(len(solver.row1s)) * int64(len(solver.row2s)) * int64(len(solver.row3s)) * int64(len(solver.row4s)) * int64(len(solver.row5s)) * int64(len(solver.row6s)) * int64(len(solver.row7s)) * int64(len(solver.row8s)) * int64(len(solver.row9s)) } @@ -61,7 +61,7 @@ func (solver *Solver) findBlocks(row *string, rows *[]int) { *rows = selection } -func (solver *Solver) checkCombinations() { +func (solver *Solver) CheckCombinations() { for rows1Index := range solver.row1s { for rows2Index := range solver.row2s { for rows3Index := range solver.row3s { @@ -94,7 +94,7 @@ func (solver *Solver) routineValidator(rows1Index int, rows2Index int, rows3Inde } -func (solver *Solver) tracker() { +func (solver *Solver) Tracker() { defer solver.timeTrack(time.Now(), "Validated solutions") log.Println("Validating solutions") @@ -118,11 +118,14 @@ func (solver *Solver) tracker() { // Estimation how long it will take var est_fin string - // for solver.iter != solver.counter { // Start for-loop + // While not needed for rateDiff anymore, it makes estimation calculations more accurate. ☹️ + time.Sleep(time.Second) + + // for solver.Iter != solver.counter { // Start for-loop for !done { // Determine how far we are. - percentage = (float32(solver.counter.Load()) / (float32(solver.iter) / 100)) + percentage = (float32(solver.counter.Load()) / (float32(solver.Iter) / 100)) // Reset the loop rateDiff = solver.counter.Load() - rateStart @@ -130,9 +133,9 @@ func (solver *Solver) tracker() { if track <= int(percentage) || rateDiff == 0 { // Start if-statement // Make sure something happened, making rateStart the only reliable variable - if solver.iter == solver.counter.Load() { + if solver.Iter == solver.counter.Load() { percentage = 100 - solver.counter.Store(solver.iter) + solver.counter.Store(solver.Iter) done = true } @@ -144,7 +147,7 @@ func (solver *Solver) tracker() { if rateDiff == 0 { est_fin = "N/A" } else { - duration_int := (solver.iter - solver.counter.Load()) / rate_avg + duration_int := (solver.Iter - solver.counter.Load()) / rate_avg duration_string := strconv.Itoa(int(duration_int)) + "s" est, err := time.ParseDuration(duration_string) if err != nil { @@ -154,7 +157,7 @@ func (solver *Solver) tracker() { } // Printing the progress - log.Println("Processing: " + strconv.Itoa(int(percentage)) + "% (" + strconv.FormatInt(solver.counter.Load(), 10) + "/" + strconv.Itoa(int(solver.iter)) + "); Rate: " + strconv.FormatInt(rateDiff, 10) + "/sec for " + timer_elapsed.String() + "; Time left (est.): " + est_fin) + log.Println("Processing: " + strconv.Itoa(int(percentage)) + "% (" + strconv.FormatInt(solver.counter.Load(), 10) + "/" + strconv.Itoa(int(solver.Iter)) + "); Rate: " + strconv.FormatInt(rateDiff, 10) + "/sec for " + timer_elapsed.String() + "; Time left (est.): " + est_fin) // After we are done printing, exit this for-loop if percentage == 100 { @@ -176,7 +179,7 @@ func (solver *Solver) tracker() { rateStart = solver.counter.Load() // Sleep for a second - if solver.iter != solver.counter.Load() { + if solver.Iter != solver.counter.Load() { time.Sleep(1 * time.Second) } } // End for-loop diff --git a/solver/solver.go b/solver/solver.go deleted file mode 100644 index 0751ace..0000000 --- a/solver/solver.go +++ /dev/null @@ -1,44 +0,0 @@ -package solver - -import ( - "log" - "runtime" - "strconv" -) - -// The main loop that orchastrates all the logic. -func Run() { - // Instantiate the Solver interface - solver := Solver{} - - // Parse and handle flags - solver.parseFlags() - - // Report number of CPUs being used, if set. - if runtime.NumCPU() != solver.numCPUs { - log.Println("Using " + strconv.Itoa(solver.numCPUs) + " CPUs, (was " + strconv.Itoa(runtime.NumCPU()) + ")") - } - - // Load blocks from CSV file - solver.loadBlocks() - - // Find rows that fit with the entered rows - solver.populateBlocks() - - // If needed, split the workload - // May exit and throw an error if the work load isn't viable - if solver.split != 1 { - solver.selectWorkload() - } - - // Print the total number of solutions to validate - log.Println("Number of (potential) solutions:", solver.iter) - - // Check the number of solutions - go solver.checkCombinations() - solver.tracker() - - // Print the valid solutions - solver.printSolutions() - -} diff --git a/solver/split.go b/solver/split.go index ed64993..6189118 100644 --- a/solver/split.go +++ b/solver/split.go @@ -10,21 +10,21 @@ import ( // Perform some checks // and // Modify solver.row1s so it limits the workload to what is only desired. -func (solver *Solver) selectWorkload() { - if solver.split > len(solver.row1s) { - log.Println("ERROR: Unable to divide the workload in " + strconv.Itoa(solver.split) + " parts, when only " + strconv.Itoa(len(solver.row1s)) + " are available.\n\n") +func (solver *Solver) SelectWorkload() { + if solver.Split > len(solver.row1s) { + log.Println("ERROR: Unable to divide the workload in " + strconv.Itoa(solver.Split) + " parts, when only " + strconv.Itoa(len(solver.row1s)) + " are available.\n\n") os.Exit(1) } defer solver.timeTrack(time.Now(), "Workload set") log.Println("Setting workload") - log.Println("We are agent " + strconv.Itoa(solver.part) + " of " + strconv.Itoa(solver.split)) + log.Println("We are agent " + strconv.Itoa(solver.Part) + " of " + strconv.Itoa(solver.Split)) workloads := solver.splitWorkload() solver.setWorkload(workloads) } // Determine how workload should be split among the agents func (solver *Solver) splitWorkload() []int { - agents := make([]int, solver.split) + agents := make([]int, solver.Split) var tracker int var tasks int = len(solver.row1s) @@ -32,7 +32,7 @@ func (solver *Solver) splitWorkload() []int { agents[tracker] += 1 tasks -= 1 tracker += 1 - if tracker == solver.split { + if tracker == solver.Split { tracker = 0 } } @@ -45,7 +45,7 @@ func (solver *Solver) setWorkload(agents []int) { var start int = 0 var finish int = 0 for key, value := range agents { - if key == solver.part-1 { + if key == solver.Part-1 { finish = start + value break } else { @@ -57,5 +57,5 @@ func (solver *Solver) setWorkload(agents []int) { solver.row1s = solver.row1s[start:finish] // Recalculate how much we need to grind through - solver.iter = int64(len(solver.row1s)) * int64(len(solver.row2s)) * int64(len(solver.row3s)) * int64(len(solver.row4s)) * int64(len(solver.row5s)) * int64(len(solver.row6s)) * int64(len(solver.row7s)) * int64(len(solver.row8s)) * int64(len(solver.row9s)) + solver.Iter = int64(len(solver.row1s)) * int64(len(solver.row2s)) * int64(len(solver.row3s)) * int64(len(solver.row4s)) * int64(len(solver.row5s)) * int64(len(solver.row6s)) * int64(len(solver.row7s)) * int64(len(solver.row8s)) * int64(len(solver.row9s)) } diff --git a/solver/types.go b/solver/types.go index 3b94676..11af96b 100644 --- a/solver/types.go +++ b/solver/types.go @@ -7,15 +7,15 @@ import ( // Struct/Interface containing all the important variabes it functions need access to. type Solver struct { blocks []int - row1 string - row2 string - row3 string - row4 string - row5 string - row6 string - row7 string - row8 string - row9 string + Row1 string + Row2 string + Row3 string + Row4 string + Row5 string + Row6 string + Row7 string + Row8 string + Row9 string row1s []int row2s []int row3s []int @@ -25,11 +25,11 @@ type Solver struct { row7s []int row8s []int row9s []int - iter int64 + Iter int64 counter atomic.Int64 solutions []string rates []int64 - numCPUs int - split int - part int + NumCPUs int + Split int + Part int }