Skip to content

Commit c43ca9b

Browse files
committed
Update README
1 parent 9d5e1cd commit c43ca9b

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,11 @@ There are **three functions** that Sudoku-Suite provides the developer, along wi
2727

2828
* `Grid`
2929
* An object that represents a 9x9 Sudoku grid. The `Grid` object does not validate the grid in any way, i.e, it only holds the grid and values inside it.
30+
* While initialising, if the given values are invalid, an `std::invalid_argument` exception is thrown.
3031
* *Check out the examples below to see how we can initialise and use this object!*
3132
* `void solve(Grid *grid)`
3233
* A function that takes in a pointer to a `Grid` object and solves the Sudoku puzzle present in it. Returns nothing.
34+
* If the puzzle cannot be solved, a `std::logic_error` exception is thrown.
3335
* `bool is_valid_solution(Grid &grid)`
3436
* A function that takes in a `Grid` object and returns a `bool` with a value of `true` if the `Grid` object contains a finished and valid Sudoku solution.
3537
* `Grid generate_puzzle()`

0 commit comments

Comments
 (0)