Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: dependency graph #12

Merged
merged 2 commits into from
Nov 20, 2023
Merged

doc: dependency graph #12

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ab4d38a
doc: dependency graph
c-dilks Nov 20, 2023
a25b0e6
fix: header
c-dilks Nov 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 43 additions & 22 deletions doc/design.md
View file
Open in desktop
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