Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nguyennd97 committed May 16, 2022
1 parent 79f3f4b commit 63dcb5b
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
## Contents
- [Generator](#generator)
- [Solver](#solver)
- [Score](#score)
- [Puzzle Form](#puzzle-form)
* [Supported Form](#supported-form)
+ [4x4](#4x4)
Expand All @@ -12,7 +13,6 @@
+ [12x12](#12x12)
+ [16x16](#16x16)
+ [25x25](#25x25)
- [Score](#score)

## Generator

Expand Down Expand Up @@ -73,6 +73,20 @@ Puzzle solved = PuzzleSolver.solve(puzzle, 5 * 1000);
System.out.println(solved);
```


## Score

Score of sudoku puzzle is defined
+ `<` **100** : know the rule
+ `>` **100** and `<` **1000** : know some techniques
+ `>` **1000** : requires flat-out trial (_`score / 1000`_ is the number of tries)

The Puzzle with higher score is harder to solve.

To show the puzzle as string, use `puzzle.toString()`

To get score of a puzzle, use `puzzle.difficultyScore(answer)` where **_answer_** is the solved puzzle.

## Puzzle Form
Puzzle form is form of all boxes inside the puzzle. **The first box index is 0**.

Expand Down Expand Up @@ -319,20 +333,6 @@ Support Classic Form Only
#### 25x25
Support Classic Form Only

## Score

Score of sudoku puzzle is defined
+ `<` **100** : know the rule
+ `>` **100** and `<` **1000** : know some techniques
+ `>` **1000** : requires flat-out trial (_`score / 1000`_ is the number of tries)

The Puzzle with higher score is harder to solve.

To show the puzzle as string, use `puzzle.toString()`

To get score of a puzzle, use `puzzle.difficultyScore(answer)` where **_answer_** is the solved puzzle.


See Example: https://github.com/dangnguyendota/SudokuGeneratorAndSolver/blob/master/src/vn/com/dangnguyendota/Example.java

Supported:
Expand Down

0 comments on commit 63dcb5b

Please sign in to comment.