# gaurav-125/cube-solver-using-korf-s-algo architecture

> Architecture diagram of the GitHub repository gaurav-125/cube-solver-using-korf-s-algo, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-19). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/gaurav-125/cube-solver-using-korf-s-algo
- Repository: https://github.com/gaurav-125/cube-solver-using-korf-s-algo

## Overview

This is a C++ Rubik’s Cube solver with several interchangeable cube representations and search strategies. Its principal workflow reads cube colors in main, constructs a cube state, searches for a solution, and reports moves; the active path shown uses the bitboard representation and IDA* with a corner-pattern heuristic. The repository also includes breadth/depth search alternatives and code to build and persist the corner database. Relationships are limited to calls and references visible in the excerpts or SOURCE INDEX; some database-building and persistence details are not sampled.

Main entry points: [`main.cpp`](https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/main.cpp) (Solver runner), [`PatternDatabases/CornerPatternDatabase.h`](https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/PatternDatabases/CornerPatternDatabase.h) (Corner database), [`PatternDatabases/PatternDatabase.h`](https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/PatternDatabases/PatternDatabase.h) (Pattern storage), [`GenericsRubiksCube.h`](https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/GenericsRubiksCube.h) (Cube interface)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Input and orchestration"]
  node_input["Input loader<br/>[main.cpp]"]
  node_runner["Solver runner<br/>[main.cpp]"]
end

subgraph group_cube["Cube model"]
  node_cube_api["Cube interface"]
  node_cube_bitboard["Bitboard cube"]
  node_cube_array3["3D array cube"]
  node_cube_array1["1D array cube"]
end

subgraph group_search["Search algorithms"]
  node_dfs["Depth-first search<br/>[DFSsolver.h]"]
  node_iddfs["Iterative deepening<br/>[IDDFSsolver.h]"]
  node_bfs["Breadth-first search<br/>[BFSsolver.h]"]
  node_ida["IDA* basic<br/>[IDAstarSolver.h]"]
  node_ida_pdb["IDA* heuristic<br/>[IDAstarSolver2.h]"]
end

subgraph group_heuristic["Corner pattern database"]
  node_db_maker["Database builder<br/>[CornerDBMaker.cpp]"]
  node_corner_db["Corner database"]
  node_pattern_db["Pattern storage<br/>[PatternDatabase.h]"]
  node_nibble["Packed values<br/>[NibbleArray.h]"]
  node_permutation["Permutation index"]
  node_math["Combinatorics math<br/>[math.h]"]
end

node_operator(("Cube input"))
node_db_file["Corner database file"]

node_operator -->|"provides colors"| node_input
node_input -->|"loads state"| node_runner
node_runner -->|"constructs cube"| node_cube_bitboard
node_runner -->|"runs solver"| node_ida_pdb
node_runner -->|"references solver"| node_dfs
node_runner -->|"references solver"| node_iddfs
node_runner -->|"references solver"| node_bfs
node_runner -->|"references solver"| node_ida
node_cube_bitboard -->|"implements"| node_cube_api
node_cube_array1 -->|"implements"| node_cube_api
node_cube_array3 -->|"implements"| node_cube_api
node_iddfs -->|"invokes"| node_dfs
node_ida_pdb -->|"queries heuristic"| node_corner_db
node_db_maker -.->|"builds database"| node_corner_db
node_corner_db -->|"extends storage"| node_pattern_db
node_pattern_db -->|"stores values"| node_nibble
node_corner_db -->|"indexes corners"| node_permutation
node_permutation -->|"uses math"| node_math
node_pattern_db -.->|"loads or saves"| node_db_file

click node_input "https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/main.cpp"
click node_runner "https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/main.cpp"
click node_cube_api "https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/GenericsRubiksCube.h"
click node_cube_bitboard "https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/RubiksCubeBitboard.cpp"
click node_cube_array3 "https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/RubiksCube3dArray.cpp"
click node_cube_array1 "https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/RubiksCube1dArray.cpp"
click node_dfs "https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/solver/DFSsolver.h"
click node_iddfs "https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/solver/IDDFSsolver.h"
click node_bfs "https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/solver/BFSsolver.h"
click node_ida "https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/solver/IDAstarSolver.h"
click node_ida_pdb "https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/solver/IDAstarSolver2.h"
click node_db_maker "https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/PatternDatabases/CornerDBMaker.cpp"
click node_corner_db "https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/PatternDatabases/CornerPatternDatabase.h"
click node_pattern_db "https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/PatternDatabases/PatternDatabase.h"
click node_nibble "https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/PatternDatabases/NibbleArray.h"
click node_permutation "https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/PatternDatabases/PermutationIndexer.h"
click node_math "https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/PatternDatabases/math.h"
click node_db_file "https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/Database/CornerDatabase1.txt"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_input,node_runner toneBlue
class node_cube_api,node_cube_bitboard,node_cube_array3,node_cube_array1,node_db_file toneAmber
class node_dfs,node_iddfs,node_bfs,node_ida,node_ida_pdb toneMint
class node_db_maker,node_corner_db,node_pattern_db,node_nibble,node_permutation,node_math toneRose
class node_operator toneIndigo
```

## Components

### Input and orchestration

- [Input loader](https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/main.cpp): `main.cpp`
- [Solver runner](https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/main.cpp): `main.cpp`

### Cube model

- [Cube interface](https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/GenericsRubiksCube.h): `GenericsRubiksCube.h`
- [Bitboard cube](https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/RubiksCubeBitboard.cpp): `RubiksCubeBitboard.cpp`
- [3D array cube](https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/RubiksCube3dArray.cpp): `RubiksCube3dArray.cpp`
- [1D array cube](https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/RubiksCube1dArray.cpp): `RubiksCube1dArray.cpp`

### Search algorithms

- [Depth-first search](https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/solver/DFSsolver.h): `solver/DFSsolver.h`
- [Iterative deepening](https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/solver/IDDFSsolver.h): `solver/IDDFSsolver.h`
- [Breadth-first search](https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/solver/BFSsolver.h): `solver/BFSsolver.h`
- [IDA* basic](https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/solver/IDAstarSolver.h): `solver/IDAstarSolver.h`
- [IDA* heuristic](https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/solver/IDAstarSolver2.h): `solver/IDAstarSolver2.h`

### Corner pattern database

- [Database builder](https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/PatternDatabases/CornerDBMaker.cpp): `PatternDatabases/CornerDBMaker.cpp`
- [Corner database](https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/PatternDatabases/CornerPatternDatabase.h): `PatternDatabases/CornerPatternDatabase.h`
- [Pattern storage](https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/PatternDatabases/PatternDatabase.h): `PatternDatabases/PatternDatabase.h`
- [Packed values](https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/PatternDatabases/NibbleArray.h): `PatternDatabases/NibbleArray.h`
- [Permutation index](https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/PatternDatabases/PermutationIndexer.h): `PatternDatabases/PermutationIndexer.h`
- [Combinatorics math](https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/PatternDatabases/math.h): `PatternDatabases/math.h`

### Other components

- **Cube input**
- [Corner database file](https://github.com/gaurav-125/cube-solver-using-korf-s-algo/blob/main/Database/CornerDatabase1.txt): `Database/CornerDatabase1.txt`

## Connections

- Cube input → Input loader: provides colors (evidence: `main.cpp`)
- Input loader → Solver runner: loads state (evidence: `main.cpp`)
- Solver runner → Bitboard cube: constructs cube (evidence: `main.cpp`)
- Solver runner → IDA* heuristic: runs solver (evidence: `main.cpp`)
- Solver runner → Depth-first search: references solver (evidence: `main.cpp`)
- Solver runner → Iterative deepening: references solver (evidence: `main.cpp`)
- Solver runner → Breadth-first search: references solver (evidence: `main.cpp`)
- Solver runner → IDA* basic: references solver (evidence: `main.cpp`)
- Bitboard cube → Cube interface: implements (evidence: `RubiksCubeBitboard.cpp`)
- 1D array cube → Cube interface: implements (evidence: `RubiksCube1dArray.cpp`)
- 3D array cube → Cube interface: implements (evidence: `RubiksCube3dArray.cpp`)
- Iterative deepening → Depth-first search: invokes (evidence: `solver/IDDFSsolver.h`)
- IDA* heuristic → Corner database: queries heuristic (evidence: `solver/IDAstarSolver2.h`)
- Database builder → Corner database: builds database
- Corner database → Pattern storage: extends storage (evidence: `PatternDatabases/CornerPatternDatabase.h`)
- Pattern storage → Packed values: stores values (evidence: `PatternDatabases/PatternDatabase.h`)
- Corner database → Permutation index: indexes corners (evidence: `PatternDatabases/CornerPatternDatabase.h`)
- Permutation index → Combinatorics math: uses math (evidence: `PatternDatabases/PermutationIndexer.h`)
- Pattern storage → Corner database file: loads or saves
