Skip to content

Commit

Permalink
doc: dependency graph (#12)
Browse files Browse the repository at this point in the history
  • Loading branch information
c-dilks committed Nov 20, 2023
1 parent ab0d11b commit 74d085c
Showing 1 changed file with 43 additions and 22 deletions.
65 changes: 43 additions & 22 deletions doc/design.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 74d085c

Please sign in to comment.