# kaik0405/rubiklab architecture

> Architecture diagram of the GitHub repository kaik0405/rubiklab, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/kaik0405/rubiklab
- Repository: https://github.com/kaik0405/rubiklab

## Overview

RubikLab is a Prolog-based cube-solving laboratory with a browser UI. The user enters or scrambles a cube, requests validation, solving, comparison, or benchmarking, then views and animates results. The README documents the Prolog module dependencies and API capabilities; the sampled frontend excerpt confirms solve requests and solution animation. Backend source was not sampled, so backend relationships below follow the README’s explicit dependency map rather than inspected call sites.

Main entry points: [`prolog/server.pl`](https://github.com/kaik0405/rubiklab/blob/master/prolog/server.pl) (HTTP API), [`prolog/cube.pl`](https://github.com/kaik0405/rubiklab/blob/master/prolog/cube.pl) (Cube state), [`prolog/thistle.pl`](https://github.com/kaik0405/rubiklab/blob/master/prolog/thistle.pl) (Thistlethwaite solver), [`prolog/cfop.pl`](https://github.com/kaik0405/rubiklab/blob/master/prolog/cfop.pl) (CFOP solver)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_model["Cube model"]
  node_cube["Cube state<br/>[cube.pl]"]
  node_moves["Move utilities<br/>[moves.pl]"]
  node_validation["State validation<br/>[validation.pl]"]
  node_facelets["Facelet conversion<br/>[facelets.pl]"]
end

subgraph group_solvers["Solving and analysis"]
  node_tables[("Pruning tables<br/>[tables.pl]")]
  node_search["IDA* search<br/>[search.pl]"]
  node_thistle["Thistlethwaite solver<br/>[thistle.pl]"]
  node_cfop["CFOP solver<br/>[cfop.pl]"]
  node_ollpll[("OLL / PLL catalog<br/>[oll_pll.pl]")]
  node_explainer["Solution explainer<br/>[explainer.pl]"]
  node_benchmark["Solver benchmark<br/>[benchmark.pl]"]
end

subgraph group_service["HTTP service"]
  node_server["HTTP API<br/>[server.pl]"]
end

subgraph group_web["Browser interface"]
  node_app["Web client<br/>[app.js]"]
end

node_user(("Cube solver"))

node_user -->|"uses"| node_app
node_app -->|"requests API"| node_server
node_server -->|"uses"| node_cube
node_server -->|"uses"| node_moves
node_server -->|"uses"| node_validation
node_server -->|"uses"| node_facelets
node_server -->|"uses"| node_thistle
node_server -->|"uses"| node_cfop
node_server -->|"uses"| node_explainer
node_server -->|"uses"| node_benchmark
node_moves -->|"uses"| node_cube
node_validation -->|"uses"| node_cube
node_facelets -->|"uses"| node_cube
node_tables -->|"uses"| node_cube
node_tables -->|"uses"| node_moves
node_search -->|"uses"| node_cube
node_search -->|"uses"| node_moves
node_thistle -->|"uses"| node_search
node_thistle -->|"uses"| node_tables
node_thistle -->|"uses"| node_cube
node_thistle -->|"uses"| node_moves
node_cfop -->|"uses"| node_search
node_cfop -->|"uses"| node_cube
node_cfop -->|"uses"| node_moves
node_cfop -->|"uses"| node_ollpll
node_explainer -->|"explains"| node_thistle
node_explainer -->|"explains"| node_cfop
node_benchmark -->|"compares"| node_thistle
node_benchmark -->|"compares"| node_cfop
node_benchmark -->|"uses"| node_cube
node_benchmark -->|"uses"| node_moves

click node_app "https://github.com/kaik0405/rubiklab/blob/master/web/app.js"
click node_server "https://github.com/kaik0405/rubiklab/blob/master/prolog/server.pl"
click node_cube "https://github.com/kaik0405/rubiklab/blob/master/prolog/cube.pl"
click node_moves "https://github.com/kaik0405/rubiklab/blob/master/prolog/moves.pl"
click node_validation "https://github.com/kaik0405/rubiklab/blob/master/prolog/validation.pl"
click node_facelets "https://github.com/kaik0405/rubiklab/blob/master/prolog/facelets.pl"
click node_tables "https://github.com/kaik0405/rubiklab/blob/master/prolog/tables.pl"
click node_search "https://github.com/kaik0405/rubiklab/blob/master/prolog/search.pl"
click node_thistle "https://github.com/kaik0405/rubiklab/blob/master/prolog/thistle.pl"
click node_cfop "https://github.com/kaik0405/rubiklab/blob/master/prolog/cfop.pl"
click node_ollpll "https://github.com/kaik0405/rubiklab/blob/master/prolog/oll_pll.pl"
click node_explainer "https://github.com/kaik0405/rubiklab/blob/master/prolog/explainer.pl"
click node_benchmark "https://github.com/kaik0405/rubiklab/blob/master/prolog/benchmark.pl"

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_cube,node_moves,node_validation,node_facelets toneBlue
class node_tables,node_search,node_thistle,node_cfop,node_ollpll,node_explainer,node_benchmark toneAmber
class node_server toneMint
class node_app toneRose
class node_user toneIndigo
```

## Components

### Cube model

- [Cube state](https://github.com/kaik0405/rubiklab/blob/master/prolog/cube.pl): `prolog/cube.pl`
- [Move utilities](https://github.com/kaik0405/rubiklab/blob/master/prolog/moves.pl): `prolog/moves.pl`
- [State validation](https://github.com/kaik0405/rubiklab/blob/master/prolog/validation.pl): `prolog/validation.pl`
- [Facelet conversion](https://github.com/kaik0405/rubiklab/blob/master/prolog/facelets.pl): `prolog/facelets.pl`

### Solving and analysis

- [Pruning tables](https://github.com/kaik0405/rubiklab/blob/master/prolog/tables.pl): `prolog/tables.pl`
- [IDA* search](https://github.com/kaik0405/rubiklab/blob/master/prolog/search.pl): `prolog/search.pl`
- [Thistlethwaite solver](https://github.com/kaik0405/rubiklab/blob/master/prolog/thistle.pl): `prolog/thistle.pl`
- [CFOP solver](https://github.com/kaik0405/rubiklab/blob/master/prolog/cfop.pl): `prolog/cfop.pl`
- [OLL / PLL catalog](https://github.com/kaik0405/rubiklab/blob/master/prolog/oll_pll.pl): `prolog/oll_pll.pl`
- [Solution explainer](https://github.com/kaik0405/rubiklab/blob/master/prolog/explainer.pl): `prolog/explainer.pl`
- [Solver benchmark](https://github.com/kaik0405/rubiklab/blob/master/prolog/benchmark.pl): `prolog/benchmark.pl`

### HTTP service

- [HTTP API](https://github.com/kaik0405/rubiklab/blob/master/prolog/server.pl): `prolog/server.pl`

### Browser interface

- [Web client](https://github.com/kaik0405/rubiklab/blob/master/web/app.js): `web/app.js`

### Other components

- **Cube solver**

## Connections

- Cube solver → Web client: uses (evidence: `README.md`)
- Web client → HTTP API: requests API (evidence: `web/app.js`)
- HTTP API → Cube state: uses (evidence: `README.md`)
- HTTP API → Move utilities: uses (evidence: `README.md`)
- HTTP API → State validation: uses (evidence: `README.md`)
- HTTP API → Facelet conversion: uses (evidence: `README.md`)
- HTTP API → Thistlethwaite solver: uses (evidence: `README.md`)
- HTTP API → CFOP solver: uses (evidence: `README.md`)
- HTTP API → Solution explainer: uses (evidence: `README.md`)
- HTTP API → Solver benchmark: uses (evidence: `README.md`)
- Move utilities → Cube state: uses (evidence: `README.md`)
- State validation → Cube state: uses (evidence: `README.md`)
- Facelet conversion → Cube state: uses (evidence: `README.md`)
- Pruning tables → Cube state: uses (evidence: `README.md`)
- Pruning tables → Move utilities: uses (evidence: `README.md`)
- IDA* search → Cube state: uses (evidence: `README.md`)
- IDA* search → Move utilities: uses (evidence: `README.md`)
- Thistlethwaite solver → IDA* search: uses (evidence: `README.md`)
- Thistlethwaite solver → Pruning tables: uses (evidence: `README.md`)
- Thistlethwaite solver → Cube state: uses (evidence: `README.md`)
- Thistlethwaite solver → Move utilities: uses (evidence: `README.md`)
- CFOP solver → IDA* search: uses (evidence: `README.md`)
- CFOP solver → Cube state: uses (evidence: `README.md`)
- CFOP solver → Move utilities: uses (evidence: `README.md`)
- CFOP solver → OLL / PLL catalog: uses (evidence: `README.md`)
- Solution explainer → Thistlethwaite solver: explains (evidence: `README.md`)
- Solution explainer → CFOP solver: explains (evidence: `README.md`)
- Solver benchmark → Thistlethwaite solver: compares (evidence: `README.md`)
- Solver benchmark → CFOP solver: compares (evidence: `README.md`)
- Solver benchmark → Cube state: uses (evidence: `README.md`)
- Solver benchmark → Move utilities: uses (evidence: `README.md`)
