1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
//! # Rust sudoku solver
//!
//! Simple cli program to solve sudoku puzzles.
//!
//! ## Usage
//!
//! The program reads a puzzle reads a puzzle from a file or stdin using the
//! following format:
//!
//! The puzzle is filled in left-right top-bottom where every number 1-9 is
//! put into the current place in the puzzle, 0 or any other letter is considered
//! a blank space, and any whitespace is ignored.

/// The configuration of the project gotten from CLI.
pub mod cli;

use crate::cli::{Config, OutputStyle};
use anyhow::{anyhow, Context};
use std::{
    fs::File,
    io::{self, BufRead, Write},
    path::PathBuf,
};

/// Sudoku solver. Takes in a config and will solve the puzzle.
#[derive(Debug, Clone)]
pub struct SudokuSolver {
    config: Config,
    root: Node,
    solution: Option<Box<Node>>,
}

impl SudokuSolver {
    /// Create solution from [`Config`].
    pub fn new(config: Config) -> anyhow::Result<Self> {
        let starting_point = parse(&config.input)?;
        Ok(Self {
            config,
            root: Node {
                candidate: starting_point,
                ..Default::default()
            },
            solution: None,
        })
    }

    /// Solves the puzzle and writes output to file specified in config.
    pub fn solve(&mut self) -> anyhow::Result<()> {
        self.solution = self.root.backtrack(&self.config);

        self.output()?;

        Ok(())
    }

    /// Get the solution the solver generates.
    pub fn solution(&self) -> Option<[u8; 81]> {
        let candidate = self.solution.as_ref()?.candidate;
        Some(candidate)
    }

    fn output(&mut self) -> anyhow::Result<()> {
        let solution = self
            .solution
            .as_ref()
            .ok_or_else(|| anyhow!("Couldn't solve puzzle."))?;

        solution.print_solution(&self.config)?;
        Ok(())
    }
}

#[derive(Debug, Clone)]
struct Node {
    /// This node's candidate puzzle.
    pub candidate: [u8; 81],
    /// Index of most recent child.
    pub most_recent: usize,
    /// Descendants of this node. The progression of the node.
    pub children: [Option<Box<Node>>; 9],
}

impl Default for Node {
    fn default() -> Self {
        Self {
            candidate: [0; 81],
            // children: [None, None, None, None, None, None, None, None, None],
            most_recent: 0,
            children: Default::default(),
        }
    }
}

impl Node {
    /// Recursively solve the puzzle.
    fn backtrack(&mut self, config: &Config) -> Option<Box<Node>> {
        // Print the partial solutions and add delay
        if let Some(del) = config.delay {
            std::thread::sleep(std::time::Duration::from_millis(del));
        }
        if config.print_partials {
            self.print_solution(config).unwrap();
        }

        // Base cases
        if self.reject() {
            return None;
        } else if self.accept() {
            return Some(Box::new(self.clone()));
        }

        // recursively solve the puzzle
        let to_change = self.first();
        let mut next = self.children[self.most_recent].as_mut();

        // create next 8 children
        while let Some(child) = next {
            if let Some(solution) = child.backtrack(config) {
                return Some(solution);
            }
            if self.next(to_change).is_some() {
                next = self.children[self.most_recent].as_mut();
            } else {
                break;
            }
        }

        None
    }

    /// Generate first child of parent.
    fn first(&mut self) -> usize {
        let mut child = Node {
            candidate: self.candidate,
            ..Default::default()
        };
        let to_change = child
            .candidate
            .iter()
            .position(|&x| x == 0)
            .expect("Already checked that puzzle isn't complete in `backtrack`");

        child.candidate[to_change] = 1;

        // self.most_recent += 1;
        self.children[self.most_recent] = Some(Box::new(child));

        to_change
    }

    /// Generate next child after prev.
    fn next(&mut self, to_change: usize) -> Option<()> {
        if self.most_recent >= 8 {
            return None;
        }
        let prev = &mut self.children[self.most_recent]
            .as_mut()
            .expect("Known to be valid since we're calling this next");

        let mut child = Node {
            candidate: prev.candidate,
            ..Default::default()
        };
        child.candidate[to_change] += 1;

        self.most_recent += 1;
        self.children[self.most_recent] = Some(Box::new(child));

        Some(())
    }

    /// Check if everysquare is full.
    fn accept(&self) -> bool {
        !self.candidate.contains(&0)
    }

    /// Check if candidate is still valid.
    fn reject(&self) -> bool {
        let mut counter = [0u8; 10]; // first element is for blanks
        let candidate = &self.candidate;

        // Check horizontal rows
        for i in 0..9 {
            for j in 0..9 {
                counter[candidate[(i * 9 + j) as usize] as usize] += 1;
            }

            for j in counter.iter_mut().skip(1) {
                if *j > 1 {
                    return true;
                }

                *j = 0;
            }
        }

        // check vertical rows
        for i in 0..9 {
            for j in 0..9 {
                counter[candidate[(j * 9 + i) as usize] as usize] += 1;
            }

            for j in counter.iter_mut().skip(1) {
                if *j > 1 {
                    return true;
                }

                *j = 0;
            }
        }

        // check squares
        // traverse rows
        for i in 0..3 {
            // traverse columns
            for j in 0..3 {
                let offset: usize = (i * 27) + (j * 3);
                // traverse row in square
                for k in 0..3 {
                    counter[candidate[offset + k * 9] as usize] += 1;
                    counter[candidate[offset + k * 9 + 1] as usize] += 1;
                    counter[candidate[offset + k * 9 + 2] as usize] += 1;
                }

                for k in counter.iter_mut().skip(1) {
                    if *k > 1 {
                        return true;
                    }

                    *k = 0;
                }
            }
        }

        false
    }

    /// Output puzzle.
    fn print_solution(&self, config: &Config) -> anyhow::Result<()> {
        let puzzle = &self.candidate;
        let mut output = match &config.output {
            Some(path) => Box::new(File::create(path).context("Could not open output file.")?)
                as Box<dyn Write>,
            None => Box::new(io::stdout()) as Box<dyn Write>,
        };
        match config.style {
            OutputStyle::Bordered => {
                for i in 0..3 {
                    let mut offset = i * 27;
                    output.write_all(b"+-------+-------+-------+\n")?;
                    for _ in 0..3 {
                        writeln!(
                            output,
                            "| {} {} {} | {} {} {} | {} {} {} |",
                            puzzle[offset],
                            puzzle[offset + 1],
                            puzzle[offset + 2],
                            puzzle[offset + 3],
                            puzzle[offset + 4],
                            puzzle[offset + 5],
                            puzzle[offset + 6],
                            puzzle[offset + 7],
                            puzzle[offset + 8]
                        )?;
                        offset += 9;
                    }
                }
                output.write_all(b"+-------+-------+-------+\n")?;
            }
            OutputStyle::MultiLine => {
                for i in 0..9 {
                    let offset = i * 9;
                    writeln!(
                        output,
                        "{} {} {} {} {} {} {} {} {}",
                        puzzle[offset],
                        puzzle[offset + 1],
                        puzzle[offset + 2],
                        puzzle[offset + 3],
                        puzzle[offset + 4],
                        puzzle[offset + 5],
                        puzzle[offset + 6],
                        puzzle[offset + 7],
                        puzzle[offset + 8]
                    )?;
                }
                output.write_all(b"\n")?;
            }
            OutputStyle::Simple => {
                for i in puzzle {
                    write!(output, "{}", i)?;
                }
                writeln!(output)?;
            }
        }
        Ok(())
    }
}

/// Read input from file.
fn parse(path: &Option<PathBuf>) -> anyhow::Result<[u8; 81]> {
    let contents = match path {
        Some(path) => std::fs::read_to_string(path).context("Could not read input file.")?,
        None => {
            let mut buf = String::new();
            for line in io::stdin().lock().lines() {
                buf.push_str(line?.as_str())
            }
            buf
        }
    };

    let mut i = 0;
    let mut puzzle = [0; 81];
    for c in contents.chars() {
        if c.is_whitespace() {
            continue;
        }
        let this_square = c.to_digit(10).unwrap_or(0);
        puzzle[i] = this_square as u8;
        i += 1;
        if i == 81 {
            break;
        }
    }

    if i < 81 {
        Err(anyhow!(
            "Not enough input. The file was not long enough to construct a complete puzzle."
        ))
    } else {
        Ok(puzzle)
    }
}

#[cfg(test)]
mod tests {
    use crate::cli::OutputStyle;

    use super::*;

    #[test]
    fn sudoku1() {
        let config = Config {
            input: Some(PathBuf::from("puzzle/sudoku1.txt")),
            output: None,
            style: OutputStyle::Bordered,
            print_partials: false,
            delay: None,
        };
        let mut solution = SudokuSolver::new(config).unwrap();
        solution.solve().unwrap();

        let confirmed_solution: [u8; 81] = [
            1, 2, 3, 4, 5, 6, 7, 8, 9, 4, 5, 6, 7, 8, 9, 1, 2, 3, 7, 8, 9, 1, 2, 3, 4, 5, 6, 2, 1,
            4, 3, 6, 5, 8, 9, 7, 3, 6, 5, 8, 9, 7, 2, 1, 4, 8, 9, 7, 2, 1, 4, 3, 6, 5, 5, 3, 1, 6,
            4, 2, 9, 7, 8, 6, 4, 2, 9, 7, 8, 5, 3, 1, 9, 7, 8, 5, 3, 1, 6, 4, 2,
        ];
        assert_eq!(solution.solution().unwrap(), confirmed_solution);
    }

    #[test]
    #[should_panic]
    fn not_enough_input() {
        let config = Config {
            input: Some(PathBuf::from("puzzle/sudoku8.txt")),
            output: None,
            print_partials: false,
            style: OutputStyle::Bordered,
            delay: None,
        };
        let mut solution = SudokuSolver::new(config).unwrap();
        solution.solve().unwrap();
    }
}