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

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

//! A Takuzu (a.k.a. Binairo) solving library.
//!
//! If you are looking for a binary, see [takuzu-solver](../takuzu_solver)
//! for an example of implementation.
//!
//! # About
//!
//! Takuzu is a number puzzle, sometimes called binary sudoku.
//! The objective is to fill a grid with `0`s and `1`s while
//! observing the following rules:
//!
//! * no more than two of either number adjacent to each other in one direction.
//! * each row and each column must contain an equal number of `0`s and `1`s.
//! * no two rows and no two columns are the same.
//!
//! The grids are squares of even size.
//! A valid grid must have one and only one solution.
//! The solver will find and return all the valid solutions though.
//!
//! # Format
//!
//! The grid must be represented with the following characters:
//! `0`, `1`, `.` for a missing number, and one `\n` at the end of each row.
//! (The final `\n` may be omitted though.)
//!
//! [Example grids](https://github.com/letheed/takuzu/tree/master/grids)
//!
//! # Sources
//!
//! Check out the [repository](https://github.com/letheed/takuzu).


#![warn(missing_docs)]

pub use grid::cell::Cell;
pub use grid::Grid;
pub use source::Source;

mod grid;
mod source;

pub mod error;