diff --git a/doc/design.md b/doc/design.md index 1f8861b1..75143cb2 100644 --- a/doc/design.md +++ b/doc/design.md @@ -1,33 +1,14 @@ # Design -## Class Diagram +## Graphs -### Legend - -```mermaid -flowchart TB - classDef cls fill:#88ff88,color:black - - subgraph Inheritance - b[Base Class]:::cls - d[Derived Class]:::cls - end - d -.-> b - - subgraph Ownership - c[Class]:::cls - o[Object owned by Class]:::cls - end - c ---> o -``` - -### Iguana Design +### Class Diagram ```mermaid flowchart LR classDef cls fill:#88ff88,color:black classDef algo fill:#ff8888,color:black - classDef other fill:#88ffff,color:black + classDef other fill:#ff88ff,color:black subgraph iguana Iguana:::cls @@ -64,6 +45,46 @@ flowchart LR MomentumCorrectionConfig -.-> AlgorithmConfig ``` +#### Legend + +```mermaid +flowchart TB + classDef cls fill:#88ff88,color:black + + subgraph Inheritance + b[Base Class]:::cls + d[Derived Class]:::cls + end + d -.-> b + + subgraph Ownership + c[Class]:::cls + o[Object owned by Class]:::cls + end + c ---> o +``` + +### Dependency Graph + +```mermaid +flowchart TB + classDef lib fill:#ffff88,color:black + classDef ext fill:#88ffff,color:black + + iguana{{libIguana}}:::lib + algorithms{{libIguanaAlgorithms}}:::lib + services{{libIguanaServices}}:::lib + + hipo{{libhipo4}}:::ext + fmt{{libfmt}}:::ext + + hipo ---> services + fmt ---> services + services ---> algorithms + algorithms ---> iguana + services ---> iguana +``` + ## Algorithm Design ### Common Methods