kyoyama-kazusa/Sudoku — Gitpedia

Introduction

A sudoku handling SDK using brute forces and logical techniques.

Preface

Repository Positioning

This repository is created for the following users:

who likes sudoku algorithms: If you like to study for sudoku techniques and its backing implementation and running mechanism, you can find answer in this repository.
who wants to learn about C#-related features: This repository uses some C# newer features, which can help you learn about it.
myself: The codes are very important for me to learn sudoku and related algorithm.

API Supports

Puzzle generation
- Standard generator
- Pattern-based generator
- Hard-pattern-based generator
- Technique-based generator
  - Generated puzzle filters
Puzzle solving
- Bitwise
- Dancing Links (DLX)
- Backtracking
  - Also provides BFS equivalent implementation
- LINQ-based
- Dictionary-based
- Boolean Satisfiability Reduction (SAT)
Puzzle analysis
- Difficulty rating
- Step-by-step analysis
- Bottleneck analysis
- Grid difference analysis & technique usage analysis
- Specialized supports on direct & Snyder's techniques
- Partial implementation on some extremely hard techniques
- Rank analysis (rank, eliminations, permutations, etc.)
Drawing
- GDI+ drawing functions
Text
- I/O handling on variant grid text types (Susser, HoDoKu library format, etc.)
- JSON serialization and deserialization on most of data structures
Compatibility with other programs
- Integrated information on all HoDoKu techniques, and analysis supports
- Integrated information on most of Sudoku Explainer techniques, and analysis supports

If you want to learn about architecture of this repository, please visit DeepWiki.

Technique Supports

This solution supports many kinds of human-friendly techniques. Here I will list them.

Direct Techniques
- Full House
- Last Digit
- Hidden Single (Crosshatching)
- Naked Single
Partial-Marking Techniques
- Direct Intersection
- Direct Subset
- Complex Singles
Full-Marking Techniques
- Intersections
  - Locked Candidates (LC)
  - Law of Leftover (LoL)
  - Almost Locked Candidates (ALC)
  - Firework Subsets
- Subsets
  - Naked Subsets
    - Locked Subsets
    - Semi-Locked Subsets
    - Normal Naked Subsets
  - Hidden Subsets
    - Locked Hidden Subsets
    - Normal Hidden Subsets
- Fishes
  - Normal Fishes
  - Complex Fishes
    - Franken Fishes
    - Mutant Fishes
- Single-Digit Patterns (SDP)
  - Two Strong Links
    - Skyscraper
    - Two-String Kite
    - Turbot Fish
  - Empty Rectangle
- Wings
  - Regular Wing (XY-Wing, XYZ-Wing, etc.)
  - Irregular Wing¹
    - Woods' Wing (W-Wing)
    - Medusa Wing (M-Wing)
    - Split/Hybrid/Local Wing (S/H/L-Wing)
  - XYZ-Loop
  - Fit Ring & Fat Ring
- Deadly Patterns
  - Unconditional Deadly Patterns
    - Unique Rectangle (UR)
    - Unique Loop (UL)
    - Extended Rectangle (XR)
    - Borescoper's Deadly Pattern
    - Qiu's Deadly Pattern
    - Unique Matrix (UM)
    - Uniqueness Clue Cover (UCC)
  - Conditional Deadly Patterns
    - Rotating Deadly Pattern
    - Anonymous Deadly Pattern (Size = 8)
  - Miscellaneous
    - Bi-value Universal Grave (BUG)
    - Reverse Bi-value Universal Grave (Reverse BUG)
- Coloring (Only in API)
  - Simple Coloring
    - Simple Coloring Wrap
    - Simple Coloring Trap
- Chains
  - Non-grouped Chains
    - Alternating Inference Chains (AIC)
    - Continuous Nice Loops (CNL)
  - Well-known Chains
    - Remote Pair
      - Standard Remote Pair
      - Complex Remote Pair
  - Grouped Chains
    - Grouped Alternating Inference Chains (GAIC)
    - Grouped Continuous Nice Loops (GCNL)
    - Node Collision
  - Blossom logic
    - Blossom Loop
  - Finned logic
    - Finned Chain
    - Grouped Finned Chain
- Forcing Chains
  - Region Forcing Chains
  - Cell Forcing Chains
  - Rectangle Forcing Chains
  - Bi-value Universal Grave + n Forcing Chains
- Dynamic Chains
  - Sequential Dynamic Chains
    - Whip
    - Grouped Whip
  - Dynamic Forcing Chains
    - Dynamic Cell Forcing Chains
    - Dynamic Region Forcing Chains
    - Dynamic Contradiction Forcing Chains
    - Dynamic Double Forcing Chains
- Almost Locked Sets (ALS)
  - Chaining ALSes
    - Almost Locked Sets XZ Rule (ALS-XZ)
    - Almost Locked Sets XY-Wing (ALS-XY-Wing)
    - Almost Locked Sets W-Wing (ALS-W-Wing)
  - Extended Subset Principle (ESP)
  - Empty Rectangle Intersection Pair (ERIP)
  - Death Blossom
- Rank Logic
  - 0 Ranks
    - Sue de Coq (SdC)
    - 3-Dimensional Sue de Coq (3D SdC)
    - Domino Loop
    - Multi-sector Locked Sets
    - Multi-fish
  - Negative Ranks
    - Guardian
    - Bi-value Oddagon (Type 2, 3, 4)
    - Tri-value Oddagon
    - Broken Loop
- Exocets
  - Junior Exocet (JE)
  - Senior Exocet (SE)
  - Double Junior Exocet (Double JE)
  - Weak Exocet (WE)
  - Complex Exocet
    - Complex Junior Exocet (Complex JE)
    - Complex Senior Exocet (Complex SE)
- Symmetrical Placements
  - Gurth's Symmetrical Placement (GSP)
    - Standard Type
    - Anti Type
- Permutations
  - Aligned Exclusion
  - Braid Analysis
- Last Resorts
  - Bowman's Bingo
  - Pattern Overlay
  - Brute Force

Forks & PRs (Pull Requests) for This Repo

Of course you can fork my repo and do whatever you want. You can do whatever you want to do under the MIT license. However, due to the copy of the GitHub repo, Gitee repo doesn't support any PRs. I'm sorry. But you can create the issue on both two platforms. Please visit the following part "Basic Information" for learning about more details.

Open source license

Special project: `Sudoku.Drawing`

Please visit the file LICENSE-OCR in project Sudoku.Drawing in source code if you want to utilize APIs in Ocr folder of that project.

Repository folder `docs`

This folder contains two projects:

Sudoku Tutorial (docs/tutorial)
SudokuStudio Manual (docs/manual)

Two projects uses markdown rendering engine instead of code. Therefore, those two projects will adopt different license - CC-BY-4.0 International.

The others

All the other projects use MIT license, which means you should mention the copyright of the author of the repository if you want to use code snippet in this repository.